Key Property

The secret key for the AES algorithm.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
int GetKey(char* &lpKey, int &lenKey);
int SetKey(const char* lpKey, int lenKey);

Unicode (Windows)
INT GetKey(LPSTR &lpKey, INT &lenKey);
INT SetKey(LPCSTR lpKey, INT lenKey);

@property (nonatomic,readwrite,assign,getter=key,setter=setKey:) NSString* key;
- (NSString*)key;
- (void)setKey:(NSString*)newKey;

@property (nonatomic,readwrite,assign,getter=keyB,setter=setKeyB:) NSData* keyB;
- (NSData*)keyB;
- (void)setKeyB:(NSData*)newKey;

#define PID_JWE_KEY 14

IPWORKSENCRYPT_EXTERNAL void* IPWORKSENCRYPT_CALL IPWorksEncrypt_JWE_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);
IPWORKSENCRYPT_EXTERNAL int IPWORKSENCRYPT_CALL IPWorksEncrypt_JWE_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);

Default Value

""

Remarks

This property specifies the key used for AES encryption and decryption.

When EncryptionAlgorithm is set to an AES algorithm this property must hold the symmetric key used for encryption and decryption. The size of the key must match the size of the algorithm. For instance when selecting the algorithm A256GCMKW (AES 256) the size of the key must also be 256 bits (32 bytes).

In the case where EncryptionAlgorithm is set to Direct this key is used directly with the algorithm specified by ContentEncryptionAlgorithm and must be an appropriate size for the selected ContentEncryptionAlgorithm.

Data Type

Binary String