Section 3: library functions
pskc_init – API function Synopsis #include <pskc.h> int pskc_init(pskc_t **container); Arguments pskc_t ** container pointer to a pskc_t handle to initialize. Description This function initializes the PSKC container handle. The memory allocate can be released by calling pskc_done(). Returns On success, PSKC_OK (zero) is returned, on memory allocation errors PSKC_MALLOC_ERROR is returned. Reporting Bugs Report…
pskc_global_log – API function Synopsis #include <pskc.h> void pskc_global_log(pskc_log_func log_func); Arguments pskc_log_func log_func new global pskc_log_func log function to use. Description Enable global debug logging function. The function will be invoked to print various debugging information. pskc_log_func is of the form, void (*pskc_log_func) (const char *msg); The container and keypackage variables may be NULL if…
pskc_global_init – API function Synopsis #include <pskc.h> int pskc_global_init(void); Arguments void Description This function initializes the PSKC library. Every user of this library needs to call this function before using other functions. You should call pskc_global_done() when use of the PSKC library is no longer needed. Returns On success, PSKC_OK (zero) is returned, otherwise an…
pskc_global_done – API function Synopsis #include <pskc.h> void pskc_global_done(void); Arguments void Description This function deinitializes the PSKC library, which were initialized using pskc_global_init(). After calling this function, no other PSKC library function may be called except for to re-initialize the library using pskc_global_init(). Reporting Bugs Report bugs to <oath-toolkit-help [at] nongnu.org>. libpskc home page: http://www.gnu.org/software/libpskc/…
pskc_get_version – API function Synopsis #include <pskc.h> const char *pskc_get_version(pskc_t *container); Arguments pskc_t * container a pskc_t handle, from pskc_init(). Description Get the PSKC KeyContainer Version attribute. Normally this string is always "1.0" and a missing field is a syntax error according to the PSKC schema. Returns a constant string (must not be deallocated) holding…
pskc_get_signed_p – API function Synopsis #include <pskc.h> int pskc_get_signed_p(pskc_t *container); Arguments pskc_t * container a pskc_t handle, from pskc_init(). Description Check whether the container is signed or not (note that it does not validate the signature, merely checks whether there is one). Returns a non-0 value if the container contains a Signature element, 0 if…
pskc_get_keypackage – API function Synopsis #include <pskc.h> pskc_key_t * pskc_get_keypackage(pskc_t * container, size_t i); Arguments pskc_t * container a pskc_t handle, from pskc_init(). size_t i number of keypackage to get. Description Get a PSKC keypackage pskc_key_t handle for the i‘th key package in container. i is zero-based, i.e., 0 refer to the first key package,…
pskc_get_key_userid – API function Synopsis #include <pskc.h> const char *pskc_get_key_userid(pskc_key_t *key); Arguments pskc_key_t * key a pskc_key_t handle, from pskc_get_keypackage(). Description Get the PSKC KeyPackage Key Userid value. Returns a constant string (must not be deallocated) holding the content, or NULL if not set. Reporting Bugs Report bugs to <oath-toolkit-help [at] nongnu.org>. libpskc home page:…
pskc_get_key_reference – API function Synopsis #include <pskc.h> const char *pskc_get_key_reference(pskc_key_t *key); Arguments pskc_key_t * key a pskc_key_t handle, from pskc_get_keypackage(). Description Get the PSKC KeyPackage Key KeyReference value. Returns a constant string (must not be deallocated) holding the content, or NULL if not set. Reporting Bugs Report bugs to <oath-toolkit-help [at] nongnu.org>. libpskc home page:…
pskc_get_key_profileid – API function Synopsis #include <pskc.h> const char *pskc_get_key_profileid(pskc_key_t *key); Arguments pskc_key_t * key a pskc_key_t handle, from pskc_get_keypackage(). Description Get the PSKC KeyPackage Key KeyProfileId value. Returns a constant string (must not be deallocated) holding the content, or NULL if not set. Reporting Bugs Report bugs to <oath-toolkit-help [at] nongnu.org>. libpskc home page:…
pskc_get_key_policy_startdate – API function Synopsis #include <pskc.h> const struct tm *pskc_get_key_policy_startdate(pskc_key_t *key); Arguments pskc_key_t * key a pskc_key_t handle, from pskc_get_keypackage(). Description Get the PSKC KeyPackage Key Policy StartDate. This element denote the start of the validity period of a key. Returns a constant struct (must not be deallocated) holding the content, or NULL if…
pskc_get_key_policy_pinusagemode – API function Synopsis #include <pskc.h> pskc_pinusagemode pskc_get_key_policy_pinusagemode(pskc_key_t * key, int * present); Arguments pskc_key_t * key a pskc_key_t handle, from pskc_get_keypackage(). int * present output variable indicating whether data was provided or not. Description Get the PSKC KeyPackage Key Policy PINPolicy PINUsageMode value. This mandatory attribute indicates the way the PIN is used…
pskc_get_key_policy_pinminlength – API function Synopsis #include <pskc.h> uint32_t pskc_get_key_policy_pinminlength(pskc_key_t * key, int * present); Arguments pskc_key_t * key a pskc_key_t handle, from pskc_get_keypackage(). int * present output variable indicating whether data was provided or not. Description Get the PSKC KeyPackage Key Policy PINPolicy MinLength value. This attribute indicates the minimum length of a PIN that…
pskc_get_key_policy_pinmaxlength – API function Synopsis #include <pskc.h> uint32_t pskc_get_key_policy_pinmaxlength(pskc_key_t * key, int * present); Arguments pskc_key_t * key a pskc_key_t handle, from pskc_get_keypackage(). int * present output variable indicating whether data was provided or not. Description Get the PSKC KeyPackage Key Policy PINPolicy MaxLength value. This attribute indicates the maximum length of a PIN that…
pskc_get_key_policy_pinmaxfailedattempts – API function Synopsis #include <pskc.h> uint32_t pskc_get_key_policy_pinmaxfailedattempts(pskc_key_t * key, int * present); Arguments pskc_key_t * key a pskc_key_t handle, from pskc_get_keypackage(). int * present output variable indicating whether data was provided or not. Description Get the PSKC KeyPackage Key Policy PINPolicy MaxFailedAttempts value. This attribute indicates the maximum number of times the PIN…
pskc_get_key_policy_pinkeyid – API function Synopsis #include <pskc.h> const char *pskc_get_key_policy_pinkeyid(pskc_key_t *key); Arguments pskc_key_t * key a pskc_key_t handle, from pskc_get_keypackage(). Description Get the PSKC KeyPackage Key Policy PINPolicy PINKeyId value. This attribute carries the unique ‘Id’ attribute vale of the "Key" element held within this "KeyContainer" that contains the value of the PIN that protects…
pskc_get_key_policy_pinencoding – API function Synopsis #include <pskc.h> pskc_valueformat pskc_get_key_policy_pinencoding(pskc_key_t * key, int * present); Arguments pskc_key_t * key a pskc_key_t handle, from pskc_get_keypackage(). int * present output variable indicating whether data was provided or not. Description Get the PSKC KeyPackage Key Policy PINPolicy PINEncoding value. This attribute indicates the encoding of the PIN and MUST…
pskc_get_key_policy_numberoftransactions – API function Synopsis #include <pskc.h> uint64_t pskc_get_key_policy_numberoftransactions(pskc_key_t * key, int * present); Arguments pskc_key_t * key a pskc_key_t handle, from pskc_get_keypackage(). int * present output variable indicating whether data was provided or not. Description Get the PSKC KeyPackage Key Policy NumberOfTransactions value. The value in this element indicates the maximum number of times…
pskc_get_key_policy_keyusages – API function Synopsis #include <pskc.h> int pskc_get_key_policy_keyusages(pskc_key_t *key, int *present); Arguments pskc_key_t * key a pskc_key_t handle, from pskc_get_keypackage(). int * present output variable indicating whether data was provided or not. Description Get the PSKC KeyPackage Key Policy KeyUsage values. The element puts constraints on the intended usage of the key. The recipient…
pskc_get_key_policy_expirydate – API function Synopsis #include <pskc.h> const struct tm *pskc_get_key_policy_expirydate(pskc_key_t *key); Arguments pskc_key_t * key a pskc_key_t handle, from pskc_get_keypackage(). Description Get the PSKC KeyPackage Key Policy ExpiryDate. This element denote the expiry of the validity period of a key. Returns a constant struct (must not be deallocated) holding the content, or NULL if…