Section 3: library functions
pskc_set_key_policy_pinminlength – API function Synopsis #include <pskc.h> void pskc_set_key_policy_pinminlength(pskc_key_t *key, uint32_t minlength); Arguments pskc_key_t * key a pskc_key_t handle, from pskc_get_keypackage(). uint32_t minlength the length to set. Description Set the PSKC KeyPackage Key Policy PINPolicy MinLength value. This attribute indicates the minimum length of a PIN that can be set to protect the associated key….
pskc_set_key_policy_pinmaxlength – API function Synopsis #include <pskc.h> void pskc_set_key_policy_pinmaxlength(pskc_key_t *key, uint32_t maxlength); Arguments pskc_key_t * key a pskc_key_t handle, from pskc_get_keypackage(). uint32_t maxlength the length to set. Description Set the PSKC KeyPackage Key Policy PINPolicy MaxLength value. This attribute indicates the maximum length of a PIN that can be set to protect this key. It…
pskc_set_key_policy_pinmaxfailedattempts – API function Synopsis #include <pskc.h> void pskc_set_key_policy_pinmaxfailedattempts(pskc_key_t *key, uint32_t attempts); Arguments pskc_key_t * key a pskc_key_t handle, from pskc_get_keypackage(). uint32_t attempts number of attempts to set. Description Set the PSKC KeyPackage Key Policy PINPolicy MaxFailedAttempts value. This attribute indicates the maximum number of times the PIN may be entered wrongly before it MUST…
pskc_set_key_policy_pinkeyid – API function Synopsis #include <pskc.h> void pskc_set_key_policy_pinkeyid(pskc_key_t *key, const char *pinkeyid); Arguments pskc_key_t * key a pskc_key_t handle, from pskc_get_keypackage(). const char * pinkeyid pin key id value to set. Description Set the PSKC KeyPackage Key Policy PINPolicy PINKeyId value. This attribute carries the unique ‘Id’ attribute vale of the "Key" element held…
pskc_set_key_policy_pinencoding – API function Synopsis #include <pskc.h> void pskc_set_key_policy_pinencoding(pskc_key_t *key, pskc_valueformat pinencoding); Arguments pskc_key_t * key a pskc_key_t handle, from pskc_get_keypackage(). pskc_valueformat pinencoding the pskc_valueformat encoding to set. Description Set the PSKC KeyPackage Key Policy PINPolicy PINEncoding value. This attribute indicates the encoding of the PIN and MUST be one of the pskc_valueformat values. Since…
pskc_set_key_policy_numberoftransactions – API function Synopsis #include <pskc.h> void pskc_set_key_policy_numberoftransactions(pskc_key_t *key, uint64_t uses); Arguments pskc_key_t * key a pskc_key_t handle, from pskc_get_keypackage(). uint64_t uses the number of transactions to set. Description Set the PSKC KeyPackage Key Policy NumberOfTransactions value. The value in this element indicates the maximum number of times a key carried within the PSKC…
pskc_set_key_policy_keyusages – API function Synopsis #include <pskc.h> void pskc_set_key_policy_keyusages(pskc_key_t *key, int keyusages); Arguments pskc_key_t * key a pskc_key_t handle, from pskc_get_keypackage(). int keyusages integer with pskc_keyusage values ORed together. Description Set the PSKC KeyPackage Key Policy KeyUsage values. The element puts constraints on the intended usage of the key. The recipient of the PSKC document…
pskc_set_key_policy_expirydate – API function Synopsis #include <pskc.h> void pskc_set_key_policy_expirydate(pskc_key_t *key, const struct tm *expirydate); Arguments pskc_key_t * key a pskc_key_t handle, from pskc_get_keypackage(). const struct tm * expirydate pointer to a tm struct with key policy expiry date to set. Description Set the PSKC KeyPackage Key Policy ExpiryDate. This element denote the expiry of the…
pskc_set_key_issuer – API function Synopsis #include <pskc.h> void pskc_set_key_issuer(pskc_key_t *key, const char *keyissuer); Arguments pskc_key_t * key a pskc_key_t handle, from pskc_get_keypackage(). const char * keyissuer a key issuer string to set. Description Set the PSKC KeyPackage Key Issuer value. The pointer is stored in container, not a copy of the data, so you must…
pskc_set_key_id – API function Synopsis #include <pskc.h> void pskc_set_key_id(pskc_key_t *key, const char *keyid); Arguments pskc_key_t * key a pskc_key_t handle, from pskc_get_keypackage(). const char * keyid the key identity string to set. Description Set the PSKC KeyPackage Key Id attribute value. It is a syntax error for this attribute to not be available. The pointer…
pskc_set_key_friendlyname – API function Synopsis #include <pskc.h> void pskc_set_key_friendlyname(pskc_key_t *key, const char *fname); Arguments pskc_key_t * key a pskc_key_t handle, from pskc_get_keypackage(). const char * fname pointer to friendly name string to set. Description Set the PSKC KeyPackage Key Friendlyname value. The pointer is stored in container, not a copy of the data, so you…
pskc_set_key_data_timeinterval – API function Synopsis #include <pskc.h> void pskc_set_key_data_timeinterval(pskc_key_t *key, uint32_t timeinterval); Arguments pskc_key_t * key a pskc_key_t handle, from pskc_get_keypackage(). uint32_t timeinterval time interval value to set. Description Set the PSKC KeyPackage Key Data TimeInterval value. This element carries the time interval value for time-based OTP algorithms in seconds (a typical value for this…
pskc_set_key_data_timedrift – API function Synopsis #include <pskc.h> void pskc_set_key_data_timedrift(pskc_key_t *key, uint32_t timedrift); Arguments pskc_key_t * key a pskc_key_t handle, from pskc_get_keypackage(). uint32_t timedrift the time drift value to set. Description Set the PSKC KeyPackage Key Data TimeDrift value. This element contains the device clock drift value for time-based OTP algorithms. The integer value (positive or…
pskc_set_key_data_time – API function Synopsis #include <pskc.h> void pskc_set_key_data_time(pskc_key_t *key, uint32_t datatime); Arguments pskc_key_t * key a pskc_key_t handle, from pskc_get_keypackage(). uint32_t datatime the data time value to set. Description Set the PSKC KeyPackage Key Data Time value. This element contains the time for time-based OTP algorithms. (If time intervals are used, this element carries…
pskc_set_key_data_secret – API function Synopsis #include <pskc.h> int pskc_set_key_data_secret(pskc_key_t *key, const char *data, size_t len); Arguments pskc_key_t * key a pskc_key_t handle, from pskc_get_keypackage(). const char * data the byte array with the key to set, of len length. size_t len length of data byte array. Description Set the PSKC KeyPackage Key Data Secret value….
pskc_set_key_data_counter – API function Synopsis #include <pskc.h> void pskc_set_key_data_counter(pskc_key_t *key, uint64_t counter); Arguments pskc_key_t * key a pskc_key_t handle, from pskc_get_keypackage(). uint64_t counter counter value to set. Description Set the PSKC KeyPackage Key Data Counter value. This element contains the event counter for event-based OTP algorithms. Since 2.2.0 Reporting Bugs Report bugs to <oath-toolkit-help [at]…
pskc_set_key_data_b64secret – API function Synopsis #include <pskc.h> int pskc_set_key_data_b64secret(pskc_key_t *key, const char *b64secret); Arguments pskc_key_t * key a pskc_key_t handle, from pskc_get_keypackage(). const char * b64secret the base64 encoded secret to set. Description Set the PSKC KeyPackage Key Data Secret value in base64 as a zero-terminated string. The b64secret data is copied into the key…
pskc_set_key_algparm_suite – API function Synopsis #include <pskc.h> void pskc_set_key_algparm_suite(pskc_key_t *key, const char *keyalgparmsuite); Arguments pskc_key_t * key a pskc_key_t handle, from pskc_get_keypackage(). const char * keyalgparmsuite the key algorithm parameter suite string to set. Description Set the PSKC KeyPackage Key AlgorithmParameters Suite value. The pointer is stored in container, not a copy of the data,…
pskc_set_key_algparm_resp_length – API function Synopsis #include <pskc.h> void pskc_set_key_algparm_resp_length(pskc_key_t *key, uint32_t length); Arguments pskc_key_t * key a pskc_key_t handle, from pskc_get_keypackage(). uint32_t length length of response to set. Description Set the PSKC KeyPackage Key AlgorithmParameters ResponseFormat Length value. This attribute defines the length of the response generated by the device and MUST be included. If…
pskc_set_key_algparm_resp_encoding – API function Synopsis #include <pskc.h> void pskc_set_key_algparm_resp_encoding(pskc_key_t *key, pskc_valueformat vf); Arguments pskc_key_t * key a pskc_key_t handle, from pskc_get_keypackage(). pskc_valueformat vf the pskc_valueformat encoding type to set. Description Set the PSKC KeyPackage Key AlgorithmParameters ResponseFormat Encoding value. This attribute defines the encoding of the response generated by the device, it MUST be included….