Symbols

loading (4/5)...

Files

loading (4/5)...

Summary Syntax Methods References Class Tree Instances

SourceVuESP-IDF Framework and ExamplesESP-IDFot::Crypto::Ecdsa::P256::KeyPair

ot::Crypto::Ecdsa::P256::KeyPair class

Represents a key pair (public and private keys). The key pair is stored using Distinguished Encoding Rules (DER) format (per RFC 5915).

Syntax

Show:

Summary

Declaration

Definition

from ecdsa.hpp:77

class KeyPair; #if OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE class KeyPairAsRef; #endif OT_TOOL_PACKED_BEGIN class Signature : public otPlatCryptoEcdsaSignature { friend class KeyPair; friend class PublicKey; #if OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE friend class KeyPairAsRef; #endif public: static constexpr uint8_t kSize = OT_CRYPTO_ECDSA_SIGNATURE_SIZE; const uint8_t *GetBytes(void) const { return m8; } } OT_TOOL_PACKED_END; class KeyPair : public otPlatCryptoEcdsaKeyPair;

Implemented in ecdsa.hpp:113

Fields

Field

Description

ot::Crypto::Ecdsa::P256::KeyPair::kMaxDerSize

Max buffer size (in bytes) for representing the key-pair in DER format.

Methods

Generate()

Generates and populates the `KeyPair` with a new public/private keys.

GetPublicKey() const

Gets the associated public key from the `KeyPair`.

GetDerBytes() const

Gets the pointer to start of the buffer containing the key-pair info in DER format. The length (number of bytes) of DER format is given by `GetDerLength()`.

GetDerLength() const

Gets the length of the byte sequence representation of the key-pair in DER format.

GetDerBytes()

Gets the pointer to start of the key-pair buffer in DER format. Gives non-const pointer to the buffer and is intended for populating the buffer and setting the key-pair (e.g., reading the key-pair from non-volatile settings). The buffer contains `kMaxDerSize` bytes. After populating the buffer, `SetDerLength()` can be used to set the the number of bytes written.

SetDerLength()

Sets the length of the byte sequence representation of the key-pair in DER format.

Sign() const

Calculates the ECDSA signature for a hashed message using the private key from `KeyPair`. Uses the deterministic digital signature generation procedure from RFC 6979.

References

Code

Location

Scope

Referrer

class KeyPair : public otPlatCryptoEcdsaKeyPair

typedef Crypto::Ecdsa::P256::KeyPair ValueType; ///< The associated value type.

settings.hpp:604

typedef Crypto::Ecdsa::P256::KeyPair KeyInfo;

srp_client.hpp:913

DefineCoreType(otCacheEntryIterator, AddressResolver::Iterator);

address_resolver.hpp:400

DefineCoreType(otCacheEntryInfo, AddressResolver::EntryInfo);

address_resolver.hpp:401

DefineCoreType(otChildInfo, Child::Info);

DefineCoreType(otCoapTxParameters, Coap::TxParameters);

DefineCoreType(otCoapResource, Coap::Resource);

DefineCoreType(otCoapOption, Coap::Option);

coap_message.hpp:1175

DefineCoreType(otCoapOptionIterator, Coap::Option::Iterator);

coap_message.hpp:1176

DefineCoreType(otOperationalDatasetComponents, MeshCoP::Dataset::Components);

dataset.hpp:783

DefineCoreType(otOperationalDataset, MeshCoP::Dataset::Info);

dataset.hpp:784

DefineCoreType(otDnsQueryConfig, Dns::Client::QueryConfig);

dns_client.hpp:892

DefineCoreType(otDnsAddressResponse, Dns::Client::AddressResponse);

dns_client.hpp:893

DefineCoreType(otDnsBrowseResponse, Dns::Client::BrowseResponse);

dns_client.hpp:895

DefineCoreType(otDnsServiceResponse, Dns::Client::ServiceResponse);

dns_client.hpp:896

DefineCoreType(otDnsServiceInfo, Dns::Client::ServiceInfo);

dns_client.hpp:897

DefineCoreType(otDnsTxtEntry, Dns::TxtEntry);

dns_types.hpp:2734

DefineCoreType(otDnsTxtEntryIterator, Dns::TxtEntry::Iterator);

dns_types.hpp:2735

class KeyPair;

DefineCoreType(otPlatCryptoEcdsaSignature, Crypto::Ecdsa::P256::Signature);

DefineCoreType(otPlatCryptoEcdsaKeyPair, Crypto::Ecdsa::P256::KeyPair);

DefineCoreType(otPlatCryptoEcdsaPublicKey, Crypto::Ecdsa::P256::PublicKey);

DefineCoreType(otExtendedPanId, MeshCoP::ExtendedPanId);

extended_panid.hpp:106

DefineCoreType(otIcmp6Header, Ip6::Icmp::Header);

DefineCoreType(otIcmp6Handler, Ip6::Icmp::Handler);

DefineCoreType(otInstance, Instance);

instance.hpp:741

DefineCoreType(otBufferInfo, Instance::BufferInfo);

instance.hpp:742

DefineCoreType(otIp4Address, Ip4::Address);

ip4_types.hpp:661

DefineCoreType(otIp4Cidr, Ip4::Cidr);

ip4_types.hpp:662

DefineCoreType(otIp6NetworkPrefix, Ip6::NetworkPrefix);

ip6_address.hpp:986

DefineCoreType(otIp6Prefix, Ip6::Prefix);

ip6_address.hpp:987

DefineCoreType(otIp6InterfaceIdentifier, Ip6::InterfaceIdentifier);

ip6_address.hpp:988

DefineCoreType(otIp6Address, Ip6::Address);

ip6_address.hpp:989

DefineCoreType(otSecurityPolicy, SecurityPolicy);

key_manager.hpp:646

DefineCoreType(otNetworkKey, NetworkKey);

key_manager.hpp:647

DefineCoreType(otPskc, Pskc);

key_manager.hpp:648

DefineCoreType(otExtAddress, Mac::ExtAddress);

mac_types.hpp:923

DefineCoreType(otMacKey, Mac::Key);

mac_types.hpp:924

DefineCoreType(otThreadLinkInfo, ThreadLinkInfo);

mesh_forwarder.hpp:662

DefineCoreType(otJoinerPskd, MeshCoP::JoinerPskd);

meshcop.hpp:515

DefineCoreType(otJoinerDiscerner, MeshCoP::JoinerDiscerner);

meshcop.hpp:516

DefineCoreType(otSteeringData, MeshCoP::SteeringData);

meshcop.hpp:517

DefineCoreType(otCommissioningDataset, MeshCoP::CommissioningDataset);

meshcop.hpp:518

DefineCoreType(otMessageBuffer, Buffer);

message.hpp:1901

DefineCoreType(otMessageSettings, Message::Settings);

message.hpp:1902

DefineCoreType(otMessage, Message);

message.hpp:1903

DefineCoreType(otMessageQueue, MessageQueue);

message.hpp:1904

DefineCoreType(otLeaderData, Mle::LeaderData);

mle_types.hpp:699

DefineCoreType(otDeviceProperties, Mle::DeviceProperties);

mle_types.hpp:702

DefineCoreType(otNeighborInfo, Neighbor::Info);

neighbor.hpp:773

DefineCoreType(otNetifAddress, Ip6::Netif::UnicastAddress);

DefineCoreType(otNetifMulticastAddress, Ip6::Netif::MulticastAddress);

DefineCoreType(otBorderRouterConfig, NetworkData::OnMeshPrefixConfig);

network_data_types.hpp:400

DefineCoreType(otExternalRouteConfig, NetworkData::ExternalRouteConfig);

network_data_types.hpp:401

DefineCoreType(otLowpanContextInfo, NetworkData::LowpanContextInfo);

network_data_types.hpp:402

DefineCoreType(otServiceConfig, NetworkData::ServiceConfig);

network_data_types.hpp:403

DefineCoreType(otServerConfig, NetworkData::ServiceConfig::ServerConfig);

network_data_types.hpp:404

DefineCoreType(otNetworkName, MeshCoP::NetworkName);

network_name.hpp:262

DefineCoreType(otPingSenderReply, Utils::PingSender::Reply);

ping_sender.hpp:179

DefineCoreType(otPingSenderConfig, Utils::PingSender::Config);

ping_sender.hpp:180

DefineCoreType(otPingSenderStatistics, Utils::PingSender::Statistics);

ping_sender.hpp:181

DefineCoreType(otRouterInfo, Router::Info);

DefineCoreType(otCryptoSha256Hash, Crypto::Sha256::Hash);

DefineCoreType(otMessageInfo, Ip6::MessageInfo);

DefineCoreType(otSockAddr, Ip6::SockAddr);

DefineCoreType(otSrpClientHostInfo, Srp::Client::HostInfo);

srp_client.hpp:1116

DefineCoreType(otSrpClientService, Srp::Client::Service);

srp_client.hpp:1117

DefineCoreType(otSrpClientBuffersServiceEntry, Utils::SrpClientBuffers::ServiceEntry);

srp_client_buffers.hpp:248

DefineCoreType(otCryptoKey, Crypto::Key);

storage.hpp:323

DefineCoreType(otTcpEndpoint, Ip6::Tcp::Endpoint);

DefineCoreType(otTcpListener, Ip6::Tcp::Listener);

DefineCoreType(otTcpCircularSendBuffer, Ip6::TcpCircularSendBuffer);

tcp6_ext.hpp:129

DefineCoreType(otUdpSocket, Ip6::Udp::SocketHandle);

DefineCoreType(otUdpReceiver, Ip6::Udp::Receiver);

friend class KeyPair;

friend class KeyPair;

DefineCoreType(otPlatCryptoEcdsaKeyPair, Crypto::Ecdsa::P256::KeyPair);

ot::CoreType::Type

typedef Crypto::Ecdsa::P256::KeyPair ValueType; ///< The associated value type.

settings.hpp:604

ot::SettingsBase::SrpEcdsaKey

ot::SettingsBase::SrpEcdsaKey::ValueType

Error Client::ReadOrGenerateKey(KeyInfo &aKeyInfo)

srp_client.cpp:1184

ot::Srp::Client::ReadOrGenerateKey()

ot::Srp::Client::ReadOrGenerateKey()::aKeyInfo

typedef Crypto::Ecdsa::P256::KeyPair KeyInfo;

srp_client.hpp:913

ot::Srp::Client

ot::Srp::Client::KeyInfo

KeyInfo mKeyInfo;

srp_client.hpp:1002

ot::Srp::Client::MsgInfo

ot::Srp::Client::MsgInfo::mKeyInfo

Error ReadOrGenerateKey(KeyInfo &aKeyInfo);

srp_client.hpp:1024

ot::Srp::Client::ReadOrGenerateKey()

ot::Srp::Client::ReadOrGenerateKey()::aKeyInfo

Call Tree

All items filtered out

All items filtered out

Data Use

All items filtered out

All items filtered out

Class Tree

ot::Crypto::Ecdsa::P256::KeyPair is inherited by 1 classes:

ot::Crypto::Ecdsa::P256::KeyPair

otPlatCryptoEcdsaKeyPair

Override Tree

All items filtered out

All items filtered out

Implementations

All items filtered out

All items filtered out

Instances

Instance

Scope

Location

Project

ot::CoreType::Type

ot::Srp::Client::MsgInfo::mKeyInfo

ot::Srp::Client::MsgInfo

srp_client.hpp:1002

ot::Srp::Client::ReadOrGenerateKey()::aKeyInfo

ot::Srp::Client::ReadOrGenerateKey()

srp_client.hpp:1024

ot::Srp::Client::ReadOrGenerateKey()::aKeyInfo

ot::Srp::Client::ReadOrGenerateKey()

srp_client.cpp:1184

Lifecycle

All items filtered out

All items filtered out