Blame doc/functions/gnutls_pkcs11_obj_list_import_url3

Packit Service 4684c1
Packit Service 4684c1
Packit Service 4684c1
Packit Service 4684c1
Packit Service 4684c1
@deftypefun {int} {gnutls_pkcs11_obj_list_import_url3} (gnutls_pkcs11_obj_t * @var{p_list}, unsigned int * @var{n_list}, const char * @var{url}, unsigned int @var{flags})
Packit Service 4684c1
@var{p_list}: An uninitialized object list (may be @code{NULL} )
Packit Service 4684c1
Packit Service 4684c1
@var{n_list}: Initially should hold the maximum size of the list. Will contain the actual size.
Packit Service 4684c1
Packit Service 4684c1
@var{url}: A PKCS 11 url identifying a set of objects
Packit Service 4684c1
Packit Service 4684c1
@var{flags}: Or sequence of GNUTLS_PKCS11_OBJ_* flags
Packit Service 4684c1
Packit Service 4684c1
This function will initialize and set values to an object list
Packit Service 4684c1
by using all objects identified by a PKCS 11 URL.
Packit Service 4684c1
Packit Service 4684c1
This function will enumerate all the objects specified by the PKCS@code{11}  URL
Packit Service 4684c1
provided. It expects an already allocated  @code{p_list} which has * @code{n_list} elements,
Packit Service 4684c1
and that value will be updated to the actual number of present objects. The
Packit Service 4684c1
 @code{p_list} objects will be initialized and set by this function.
Packit Service 4684c1
To obtain a list of all available objects use a  @code{url} of 'pkcs11:'.
Packit Service 4684c1
Packit Service 4684c1
All returned objects must be deinitialized using @code{gnutls_pkcs11_obj_deinit()} .
Packit Service 4684c1
Packit Service 4684c1
The supported in this function  @code{flags} are @code{GNUTLS_PKCS11_OBJ_FLAG_LOGIN} ,
Packit Service 4684c1
@code{GNUTLS_PKCS11_OBJ_FLAG_LOGIN_SO} , @code{GNUTLS_PKCS11_OBJ_FLAG_PRESENT_IN_TRUSTED_MODULE} ,
Packit Service 4684c1
@code{GNUTLS_PKCS11_OBJ_FLAG_CRT} , @code{GNUTLS_PKCS11_OBJ_FLAG_PUBKEY} , @code{GNUTLS_PKCS11_OBJ_FLAG_PRIVKEY} ,
Packit Service 4684c1
@code{GNUTLS_PKCS11_OBJ_FLAG_WITH_PRIVKEY} , @code{GNUTLS_PKCS11_OBJ_FLAG_MARK_CA} ,
Packit Service 4684c1
@code{GNUTLS_PKCS11_OBJ_FLAG_MARK_TRUSTED} , and since 3.5.1 the @code{GNUTLS_PKCS11_OBJ_FLAG_OVERWRITE_TRUSTMOD_EXT} .
Packit Service 4684c1
Packit Service 4684c1
On versions of GnuTLS prior to 3.4.0 the equivalent function was
Packit Service 4684c1
@code{gnutls_pkcs11_obj_list_import_url()} . That is also available on this version
Packit Service 4684c1
as a macro which maps to this function.
Packit Service 4684c1
Packit Service 4684c1
@strong{Returns:} On success, @code{GNUTLS_E_SUCCESS}  (0) is returned, otherwise a
Packit Service 4684c1
negative error value.
Packit Service 4684c1
Packit Service 4684c1
@strong{Since:} 3.4.0
Packit Service 4684c1
@end deftypefun