AdditionalData Property

Additional data to send when performing symmetric encryption or decryption.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
int GetAdditionalData(char* &lpAdditionalData, int &lenAdditionalData);
int SetAdditionalData(const char* lpAdditionalData, int lenAdditionalData);

Unicode (Windows)
INT GetAdditionalData(LPSTR &lpAdditionalData, INT &lenAdditionalData);
INT SetAdditionalData(LPCSTR lpAdditionalData, INT lenAdditionalData);

@property (nonatomic,readwrite,assign,getter=additionalData,setter=setAdditionalData:) NSString* additionalData;
- (NSString*)additionalData;
- (void)setAdditionalData:(NSString*)newAdditionalData;

@property (nonatomic,readwrite,assign,getter=additionalDataB,setter=setAdditionalDataB:) NSData* additionalDataB;
- (NSData*)additionalDataB;
- (void)setAdditionalDataB:(NSData*)newAdditionalData;

#define PID_GOOGLEKMS_ADDITIONALDATA 1

CLOUDKEYS_EXTERNAL void* CLOUDKEYS_CALL CloudKeys_GoogleKMS_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);
CLOUDKEYS_EXTERNAL int CLOUDKEYS_CALL CloudKeys_GoogleKMS_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);

Default Value

""

Remarks

This property can be set before calling Encrypt or Decrypt with a symmetric key to have the server include the specified data, known as additional authenticated data, when performing the cryptographic operation. If such data is provided during encryption, it must also be provided in order to successfully decrypt the data. Refer to the Google Cloud KMS documentation for more information.

Up to 65536 bytes of data may be provided. Note that this property is ignored when asymmetric encryption or decryption is performed.

This property is not available at design time.

Data Type

Binary String