This class maintains signature setting information.
More...
|
| SignatureSetting (Mode mode, const void *cpKeyData, size_t keySize) |
| Instantiates an object. Initializes the object instance using the signature algorithm and key data specified. More...
|
|
| SignatureSetting (const void *cpKeyData, size_t keySize) |
| Instantiates an object. Initializes the object using the predefined algorithm (HMAC-MD5) and the specified key data. More...
|
|
| SignatureSetting () |
| Instantiates an object. Initializes the instance without a signature.
|
|
const void * | GetKeyData () const |
| Gets the address of the key data that is currently specified. More...
|
|
size_t | GetKeySize () const |
| Gets the size of the key data that is currently specified. More...
|
|
Mode | GetMode () const |
| Gets the signature algorithm that is currently specified. More...
|
|
nn::Result | Set (Mode mode, const void *cpKeyData, size_t keySize) |
| Sets signature settings. More...
|
|
This class maintains signature setting information.
- Revision History:
- 2012-11-30 Initial version.
Indicates the type of signature algorithm.
Enumerator |
---|
MODE_NOTHING |
No signature.
|
MODE_HMAC_MD5 |
HMAC-MD5 signature.
|
nn::pia::common::SignatureSetting::SignatureSetting |
( |
Mode |
mode, |
|
|
const void * |
cpKeyData, |
|
|
size_t |
keySize |
|
) |
| |
Instantiates an object. Initializes the object instance using the signature algorithm and key data specified.
- Parameters
-
[in] | mode | Specifies the type of signature algorithm. |
[in] | cpKeyData | Specifies the address of the signature data. Data being referenced must be maintained until this instance is destroyed or reinitialized. |
[in] | keySize | Specifies the size of the key data, in bytes. |
nn::pia::common::SignatureSetting::SignatureSetting |
( |
const void * |
cpKeyData, |
|
|
size_t |
keySize |
|
) |
| |
Instantiates an object. Initializes the object using the predefined algorithm (HMAC-MD5) and the specified key data.
- Parameters
-
[in] | cpKeyData | Specifies the address of the signature data. Data being referenced must be maintained until this instance is destroyed or reinitialized. |
[in] | keySize | Specifies the size of the key data, in bytes. |
const void* nn::pia::common::SignatureSetting::GetKeyData |
( |
| ) |
const |
|
inline |
Gets the address of the key data that is currently specified.
- Returns
- Returns the address of the key data that is currently specified.
size_t nn::pia::common::SignatureSetting::GetKeySize |
( |
| ) |
const |
|
inline |
Gets the size of the key data that is currently specified.
- Returns
- Returns the address of the key data that is currently specified.
Mode nn::pia::common::SignatureSetting::GetMode |
( |
| ) |
const |
|
inline |
Gets the signature algorithm that is currently specified.
- Returns
- Returns the signature algorithm that is currently specified.
nn::Result nn::pia::common::SignatureSetting::Set |
( |
Mode |
mode, |
|
|
const void * |
cpKeyData, |
|
|
size_t |
keySize |
|
) |
| |
Sets signature settings.
- Parameters
-
[in] | mode | Specifies the type of signature algorithm. |
[in] | cpKeyData | Specifies the address of the signature data. Data being referenced must be maintained until this instance is destroyed or reinitialized. |
[in] | keySize | Specifies the size of the key data, in bytes. |
- Returns
- Returns a
Result
that indicates success if configured correctly.
- Error Return Values:
ResultInvalidArgument
Indicates an invalid argument. Programming error. Fix your program so that this error is not returned.