KeyList Event

Fires once for each key when listing keys.

Syntax

ANSI (Cross Platform)
virtual int FireKeyList(GoogleKMSKeyListEventParams *e);
typedef struct {
const char *Name;
int Purpose;
const char *CreationDate;
const char *PrimaryVersion; int reserved; } GoogleKMSKeyListEventParams; Unicode (Windows) virtual INT FireKeyList(GoogleKMSKeyListEventParams *e);
typedef struct {
LPCWSTR Name;
INT Purpose;
LPCWSTR CreationDate;
LPCWSTR PrimaryVersion; INT reserved; } GoogleKMSKeyListEventParams;
- (void)onKeyList:(NSString*)name :(int)purpose :(NSString*)creationDate :(NSString*)primaryVersion;
#define EID_GOOGLEKMS_KEYLIST 4

virtual INT CLOUDKEYS_CALL FireKeyList(LPSTR &lpszName, INT &iPurpose, LPSTR &lpszCreationDate, LPSTR &lpszPrimaryVersion);

Remarks

This event fires once for each key returned when ListKeys or GetKeyInfo is called.

Name reflects the name of the key.

Purpose reflects the key's purpose. Possible values are:

  • 0: Unspecified.
  • 1: A symmetric key used for encryption and decryption.
  • 2: An asymmetric key used for signing and verification.
  • 3: An asymmetric key used for encryption and decryption.

CreationDate reflects the key's creation date, formatted as an RFC 3339 UTC timestamp.

PrimaryVersion reflects the Id of the key's primary version if it is symmetric. For asymmetric keys, it is always empty, since asymmetric keys cannot have a primary version.

Copyright (c) 2022 /n software inc. - All rights reserved.
Cloud Keys 2020 C++ Edition - Version 20.0 [Build 8157]