1gnutls_pkcs11_obj_list_import_url3(3)gnutlsgnutls_pkcs11_obj_list_import_url3(3)
2
3
4

NAME

6       gnutls_pkcs11_obj_list_import_url3 - API function
7

SYNOPSIS

9       #include <gnutls/pkcs11.h>
10
11       int  gnutls_pkcs11_obj_list_import_url3(gnutls_pkcs11_obj_t  *  p_list,
12       unsigned int * n_list, const char * url, unsigned int flags);
13

ARGUMENTS

15       gnutls_pkcs11_obj_t * p_list
16                   An uninitialized object list (may be NULL)
17
18       unsigned int * n_list
19                   Initially should hold the maximum size of  the  list.  Will
20                   contain the actual size.
21
22       const char * url
23                   A PKCS 11 url identifying a set of objects
24
25       unsigned int flags
26                   Or sequence of GNUTLS_PKCS11_OBJ_* flags
27

DESCRIPTION

29       This function will initialize and set values to an object list by using
30       all objects identified by a PKCS 11 URL.
31
32       This function will enumerate all the objects specified  by  the  PKCS11
33       URL  provided.  It  expects  an  already  allocated  p_list which has *
34       n_list elements, and that value will be updated to the actual number of
35       present objects. The
36        p_list  objects  will be initialized and set by this function.  To ob‐
37       tain a list of all available objects use a  url of 'pkcs11:'.
38
39       All    returned     objects     must     be     deinitialized     using
40       gnutls_pkcs11_obj_deinit().
41
42       The supported in this function  flags are GNUTLS_PKCS11_OBJ_FLAG_LOGIN,
43       GNUTLS_PKCS11_OBJ_FLAG_LOGIN_SO,
44       GNUTLS_PKCS11_OBJ_FLAG_PRESENT_IN_TRUSTED_MODULE,
45       GNUTLS_PKCS11_OBJ_FLAG_CRT,              GNUTLS_PKCS11_OBJ_FLAG_PUBKEY,
46       GNUTLS_PKCS11_OBJ_FLAG_PRIVKEY,    GNUTLS_PKCS11_OBJ_FLAG_WITH_PRIVKEY,
47       GNUTLS_PKCS11_OBJ_FLAG_MARK_CA,    GNUTLS_PKCS11_OBJ_FLAG_MARK_TRUSTED,
48       and since 3.5.1 the GNUTLS_PKCS11_OBJ_FLAG_OVERWRITE_TRUSTMOD_EXT.
49
50       On  versions  of  GnuTLS  prior  to  3.4.0  the equivalent function was
51       gnutls_pkcs11_obj_list_import_url(). That is  also  available  on  this
52       version as a macro which maps to this function.
53

RETURNS

55       On  success, GNUTLS_E_SUCCESS (0) is returned, otherwise a negative er‐
56       ror value.
57

SINCE

59       3.4.0
60

REPORTING BUGS

62       Report bugs to <bugs@gnutls.org>.
63       Home page: https://www.gnutls.org
64
65

67       Copyright © 2001-2023 Free Software Foundation, Inc., and others.
68       Copying and distribution of this file, with  or  without  modification,
69       are  permitted in any medium without royalty provided the copyright no‐
70       tice and this notice are preserved.
71

SEE ALSO

73       The full documentation for gnutls is maintained as  a  Texinfo  manual.
74       If  the /usr/share/doc/gnutls/ directory does not contain the HTML form
75       visit
76
77       https://www.gnutls.org/manual/
78
79gnutls                               3.8.2gnutls_pkcs11_obj_list_import_url3(3)
Impressum