GetPublicKey Method

Retrieves the public key of an asymmetric CMK.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
int GetPublicKey(const char* lpszKeyId);

Unicode (Windows)
INT GetPublicKey(LPCWSTR lpszKeyId);

- (void)getPublicKey:(NSString*)keyId;

#define MID_AMAZONKMS_GETPUBLICKEY 18

CLOUDKEYS_EXTERNAL int CLOUDKEYS_CALL CloudKeys_AmazonKMS_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);

Remarks

This method retrieves the public key of the asymmetric CMK specified by KeyId. The public key and its related information will be downloaded to the following KeyData* properties, refer to their documentation for more information:

• KeyDataAlgorithms
• KeyDataARN
• KeyDataForSigning
• KeyDataKeySpec
• KeyDataPublicKey

This method will fail if any of the following are true regarding the specified CMK:

• Its KeyState is anything other than aksEnabled (0).
• It is symmetric (see KeyKeySpec).
• It is an AWS-managed CMK (see KeyAWSManaged).

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)