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.

Examples

References

from examples

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

Syntax

Fields

Methods

Generate()

GetPublicKey() const

GetDerBytes() const

GetDerLength() const

GetDerBytes()

SetDerLength()

Sign() const

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle