source-git / p11-kit

Clone
Source Code
GIT

Blame doc/manual/html/p11-kit-URIs.html

c8 c8s master
  1.   3749ba2733d07fc588d392a87a0d080ee1894801
  2.   doc
  3.   manual
  4.   html
  5.   p11-kit-URIs.html
Blob History Raw
Packit Service 3749ba
Packit Service 3749ba 
<html>
Packit Service 3749ba 
<head>
Packit Service 3749ba 
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
Packit Service 3749ba 
<title>URIs: p11-kit</title>
Packit Service 3749ba 
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
Packit Service 3749ba 
<link rel="home" href="index.html" title="p11-kit">
Packit Service 3749ba 
<link rel="up" href="reference.html" title="API Reference">
Packit Service 3749ba 
<link rel="prev" href="p11-kit-Modules.html" title="Modules">
Packit Service 3749ba 
<link rel="next" href="p11-kit-PIN-Callbacks.html" title="PIN Callbacks">
Packit Service 3749ba 
<meta name="generator" content="GTK-Doc V1.32 (XML mode)">
Packit Service 3749ba 
<link rel="stylesheet" href="style.css" type="text/css">
Packit Service 3749ba 
</head>
Packit Service 3749ba 
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
Top  | 
Packit Service 3749ba 
                  Description
Packit Service 3749ba
Packit Service 3749ba 
Home
Packit Service 3749ba 
Up
Packit Service 3749ba 
Prev
Packit Service 3749ba 
Next
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
URIs
Packit Service 3749ba 
URIs — Parsing and formatting PKCS#11 URIs
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
Functions
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
P11KitUri *
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_new ()
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
CK_INFO_PTR
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_get_module_info ()
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
int
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_match_module_info ()
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
CK_SLOT_INFO_PTR
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_get_slot_info ()
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
int
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_match_slot_info ()
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
CK_SLOT_ID
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_get_slot_id ()
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
void
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_set_slot_id ()
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
CK_TOKEN_INFO_PTR
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_get_token_info ()
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
int
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_match_token_info ()
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
CK_ATTRIBUTE_PTR
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_get_attributes ()
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
int
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_set_attributes ()
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
void
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_clear_attributes ()
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
int
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_match_attributes ()
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
CK_ATTRIBUTE_PTR
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_get_attribute ()
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
int
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_set_attribute ()
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
int
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_clear_attribute ()
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
void
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_set_unrecognized ()
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
int
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_any_unrecognized ()
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
const char *
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_get_pin_value ()
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
void
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_set_pin_value ()
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
const char *
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_get_pin_source ()
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
void
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_set_pin_source ()
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
const char *
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_get_pinfile ()
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
void
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_set_pinfile ()
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
const char *
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_get_module_name ()
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
void
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_set_module_name ()
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
const char *
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_get_module_path ()
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
void
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_set_module_path ()
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
const char *
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_get_vendor_query ()
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
int
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_set_vendor_query ()
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
int
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_format ()
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
int
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_parse ()
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
void
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_free ()
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
const char *
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_message ()
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
Types and Values
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
#define
Packit Service 3749ba 
P11_KIT_URI_SCHEME
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
#define
Packit Service 3749ba 
P11_KIT_URI_SCHEME_LEN
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
enum
Packit Service 3749ba 
P11KitUriType
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
enum
Packit Service 3749ba 
P11KitUriResult
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
typedef
Packit Service 3749ba 
P11KitUri
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
typedef
Packit Service 3749ba 
p11_kit_uri
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
#define
Packit Service 3749ba 
P11_KIT_URI_NO_MEMORY
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
Description
Packit Service 3749ba 
PKCS#11 URIs can be used in configuration files or applications to represent
Packit Service 3749ba 
PKCS#11 modules, tokens or objects. An example of a URI might be:
Packit Service 3749ba

Packit Service 3749ba 
     pkcs11:token=The\%20Software\%20PKCS#11\%20softtoken;
Packit Service 3749ba 
         manufacturer=Snake\%20Oil,\%20Inc.;serial=;object=my-certificate;
Packit Service 3749ba 
         model=1.0;type=cert;id=\%69\%95\%3e\%5c\%f4\%bd\%ec\%91
Packit Service 3749ba 
You can use p11_kit_uri_parse() to parse such a URI, and p11_kit_uri_format()
Packit Service 3749ba 
to build one. URIs are represented by the P11KitUri structure. You can match
Packit Service 3749ba 
a parsed URI against PKCS#11 tokens with p11_kit_uri_match_token_info()
Packit Service 3749ba 
or attributes with p11_kit_uri_match_attributes().
Packit Service 3749ba 
Since URIs can represent different sorts of things, when parsing or formatting
Packit Service 3749ba 
a URI a 'context' can be used to indicate which sort of URI is expected.
Packit Service 3749ba 
URIs have an unrecognized flag. This flag is set during parsing
Packit Service 3749ba 
if any parts of the URI are not recognized. This may be because the part is
Packit Service 3749ba 
from a newer version of the PKCS#11 spec or because that part was not valid
Packit Service 3749ba 
inside of the desired context used when parsing.
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
Functions
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_new ()
Packit Service 3749ba 
P11KitUri *
Packit Service 3749ba 
p11_kit_uri_new (void);
Packit Service 3749ba 
Create a new blank PKCS#11 URI.
Packit Service 3749ba 
The new URI is in the right state to parse a string into. All relevant fields
Packit Service 3749ba 
are zeroed out. Formatting this URI will produce a valid but empty URI.
Packit Service 3749ba
Packit Service 3749ba 
Returns
Packit Service 3749ba 
 A newly allocated URI. This should be freed with p11_kit_uri_free().
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_get_module_info ()
Packit Service 3749ba 
CK_INFO_PTR
Packit Service 3749ba 
p11_kit_uri_get_module_info (P11KitUri *uri);
Packit Service 3749ba 
Get the CK_INFO structure associated with this URI.
Packit Service 3749ba 
If this is a parsed URI, then the fields corresponding to library parts of
Packit Service 3749ba 
the URI will be filled in. Any library URI parts that were missing will have
Packit Service 3749ba 
their fields filled with zeros.
Packit Service 3749ba 
If the caller wishes to setup information for building a URI, then relevant
Packit Service 3749ba 
fields should be filled in. Fields that should not appear as parts in the
Packit Service 3749ba 
resulting URI should be filled with zeros.
Packit Service 3749ba
Packit Service 3749ba 
Parameters
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
uri
Packit Service 3749ba 
the URI
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
Returns
Packit Service 3749ba 
 A pointer to the CK_INFO structure.
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_match_module_info ()
Packit Service 3749ba 
int
Packit Service 3749ba 
p11_kit_uri_match_module_info (const P11KitUri *uri,
Packit Service 3749ba 
                               const CK_INFO *info);
Packit Service 3749ba 
Match a CK_INFO structure against the library parts of this URI.
Packit Service 3749ba 
Only the fields of the CK_INFO structure that are valid for use
Packit Service 3749ba 
in a URI will be matched. A URI part that was not specified in the URI will
Packit Service 3749ba 
match any value in the structure. If during the URI parsing any unrecognized
Packit Service 3749ba 
parts were encountered then this match will fail.
Packit Service 3749ba
Packit Service 3749ba 
Parameters
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
uri
Packit Service 3749ba 
the URI
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
info
Packit Service 3749ba 
the structure to match against the URI
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
Returns
Packit Service 3749ba 
 1 if the URI matches, 0 if not.
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_get_slot_info ()
Packit Service 3749ba 
CK_SLOT_INFO_PTR
Packit Service 3749ba 
p11_kit_uri_get_slot_info (P11KitUri *uri);
Packit Service 3749ba 
Get the CK_SLOT_INFO structure associated with this URI.
Packit Service 3749ba 
If this is a parsed URI, then the fields corresponding to slot parts of
Packit Service 3749ba 
the URI will be filled in. Any slot URI parts that were missing will have
Packit Service 3749ba 
their fields filled with zeros.
Packit Service 3749ba 
If the caller wishes to setup information for building a URI, then relevant
Packit Service 3749ba 
fields should be filled in. Fields that should not appear as parts in the
Packit Service 3749ba 
resulting URI should be filled with zeros.
Packit Service 3749ba
Packit Service 3749ba 
Parameters
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
uri
Packit Service 3749ba 
the URI
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
Returns
Packit Service 3749ba 
 A pointer to the CK_INFO structure.
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_match_slot_info ()
Packit Service 3749ba 
int
Packit Service 3749ba 
p11_kit_uri_match_slot_info (const P11KitUri *uri,
Packit Service 3749ba 
                             const CK_SLOT_INFO *slot_info);
Packit Service 3749ba 
Match a CK_SLOT_INFO structure against the slot parts of this
Packit Service 3749ba 
URI.
Packit Service 3749ba 
Only the fields of the CK_SLOT_INFO structure that are valid
Packit Service 3749ba 
for use in a URI will be matched. A URI part that was not specified in the
Packit Service 3749ba 
URI will match any value in the structure. If during the URI parsing any
Packit Service 3749ba 
unrecognized parts were encountered then this match will fail.
Packit Service 3749ba
Packit Service 3749ba 
Parameters
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
uri
Packit Service 3749ba 
the URI
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
slot_info
Packit Service 3749ba 
the structure to match against the URI
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
Returns
Packit Service 3749ba 
 1 if the URI matches, 0 if not.
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_get_slot_id ()
Packit Service 3749ba 
CK_SLOT_ID
Packit Service 3749ba 
p11_kit_uri_get_slot_id (P11KitUri *uri);
Packit Service 3749ba 
Get the 'slot-id' part of the URI.
Packit Service 3749ba
Packit Service 3749ba 
Parameters
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
uri
Packit Service 3749ba 
The URI
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
Returns
Packit Service 3749ba 
 The slot-id or (CK_SLOT_ID)-1 if not set.
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_set_slot_id ()
Packit Service 3749ba 
void
Packit Service 3749ba 
p11_kit_uri_set_slot_id (P11KitUri *uri,
Packit Service 3749ba 
                         CK_SLOT_ID slot_id);
Packit Service 3749ba 
Set the 'slot-id' part of the URI.
Packit Service 3749ba
Packit Service 3749ba 
Parameters
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
uri
Packit Service 3749ba 
The URI
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
slot_id
Packit Service 3749ba 
The new slot-id
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_get_token_info ()
Packit Service 3749ba 
CK_TOKEN_INFO_PTR
Packit Service 3749ba 
p11_kit_uri_get_token_info (P11KitUri *uri);
Packit Service 3749ba 
Get the CK_TOKEN_INFO structure associated with this URI.
Packit Service 3749ba 
If this is a parsed URI, then the fields corresponding to token parts of
Packit Service 3749ba 
the URI will be filled in. Any token URI parts that were missing will have
Packit Service 3749ba 
their fields filled with zeros.
Packit Service 3749ba 
If the caller wishes to setup information for building a URI, then relevant
Packit Service 3749ba 
fields should be filled in. Fields that should not appear as parts in the
Packit Service 3749ba 
resulting URI should be filled with zeros.
Packit Service 3749ba
Packit Service 3749ba 
Parameters
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
uri
Packit Service 3749ba 
the URI
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
Returns
Packit Service 3749ba 
 A pointer to the CK_INFO structure.
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_match_token_info ()
Packit Service 3749ba 
int
Packit Service 3749ba 
p11_kit_uri_match_token_info (const P11KitUri *uri,
Packit Service 3749ba 
                              const CK_TOKEN_INFO *token_info);
Packit Service 3749ba 
Match a CK_TOKEN_INFO structure against the token parts of this
Packit Service 3749ba 
URI.
Packit Service 3749ba 
Only the fields of the CK_TOKEN_INFO structure that are valid
Packit Service 3749ba 
for use in a URI will be matched. A URI part that was not specified in the
Packit Service 3749ba 
URI will match any value in the structure. If during the URI parsing any
Packit Service 3749ba 
unrecognized parts were encountered then this match will fail.
Packit Service 3749ba
Packit Service 3749ba 
Parameters
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
uri
Packit Service 3749ba 
the URI
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
token_info
Packit Service 3749ba 
the structure to match against the URI
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
Returns
Packit Service 3749ba 
 1 if the URI matches, 0 if not.
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_get_attributes ()
Packit Service 3749ba 
CK_ATTRIBUTE_PTR
Packit Service 3749ba 
p11_kit_uri_get_attributes (P11KitUri *uri,
Packit Service 3749ba 
                            CK_ULONG *n_attrs);
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_set_attributes ()
Packit Service 3749ba 
int
Packit Service 3749ba 
p11_kit_uri_set_attributes (P11KitUri *uri,
Packit Service 3749ba 
                            CK_ATTRIBUTE_PTR attrs,
Packit Service 3749ba 
                            CK_ULONG n_attrs);
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_clear_attributes ()
Packit Service 3749ba 
void
Packit Service 3749ba 
p11_kit_uri_clear_attributes (P11KitUri *uri);
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_match_attributes ()
Packit Service 3749ba 
int
Packit Service 3749ba 
p11_kit_uri_match_attributes (const P11KitUri *uri,
Packit Service 3749ba 
                              const CK_ATTRIBUTE *attrs,
Packit Service 3749ba 
                              CK_ULONG n_attrs);
Packit Service 3749ba 
Match a attributes against the object parts of this URI.
Packit Service 3749ba 
Only the attributes that are valid for use in a URI will be matched. A URI
Packit Service 3749ba 
part that was not specified in the URI will match any attribute value. If
Packit Service 3749ba 
during the URI parsing any unrecognized parts were encountered then this
Packit Service 3749ba 
match will fail.
Packit Service 3749ba
Packit Service 3749ba 
Parameters
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
uri
Packit Service 3749ba 
The URI
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
attrs
Packit Service 3749ba 
The attributes to match
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
n_attrs
Packit Service 3749ba 
The number of attributes
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
Returns
Packit Service 3749ba 
 1 if the URI matches, 0 if not.
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_get_attribute ()
Packit Service 3749ba 
CK_ATTRIBUTE_PTR
Packit Service 3749ba 
p11_kit_uri_get_attribute (P11KitUri *uri,
Packit Service 3749ba 
                           CK_ATTRIBUTE_TYPE attr_type);
Packit Service 3749ba 
Get a pointer to an attribute present in this URI.
Packit Service 3749ba
Packit Service 3749ba 
Parameters
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
uri
Packit Service 3749ba 
The URI
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
attr_type
Packit Service 3749ba 
The attribute type
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
Returns
Packit Service 3749ba 
 A pointer to the attribute, or NULL if not present.
Packit Service 3749ba 
The attribute is owned by the URI and should not be freed.
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_set_attribute ()
Packit Service 3749ba 
int
Packit Service 3749ba 
p11_kit_uri_set_attribute (P11KitUri *uri,
Packit Service 3749ba 
                           CK_ATTRIBUTE_PTR attr);
Packit Service 3749ba 
Set an attribute on the URI.
Packit Service 3749ba 
Only attributes that map to parts in a PKCS#11 URI will be accepted.
Packit Service 3749ba
Packit Service 3749ba 
Parameters
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
uri
Packit Service 3749ba 
The URI
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
attr
Packit Service 3749ba 
The attribute to set
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
Returns
Packit Service 3749ba 
 P11_KIT_URI_OK if the attribute was successfully set.
Packit Service 3749ba 
P11_KIT_URI_NOT_FOUND if the attribute was not valid for a URI.
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_clear_attribute ()
Packit Service 3749ba 
int
Packit Service 3749ba 
p11_kit_uri_clear_attribute (P11KitUri *uri,
Packit Service 3749ba 
                             CK_ATTRIBUTE_TYPE attr_type);
Packit Service 3749ba 
Clear an attribute on the URI.
Packit Service 3749ba 
Only attributes that map to parts in a PKCS#11 URI will be accepted.
Packit Service 3749ba
Packit Service 3749ba 
Parameters
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
uri
Packit Service 3749ba 
The URI
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
attr_type
Packit Service 3749ba 
The type of the attribute to clear
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
Returns
Packit Service 3749ba 
 P11_KIT_URI_OK if the attribute was successfully cleared.
Packit Service 3749ba 
P11_KIT_URI_NOT_FOUND if the attribute was not valid for a URI.
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_set_unrecognized ()
Packit Service 3749ba 
void
Packit Service 3749ba 
p11_kit_uri_set_unrecognized (P11KitUri *uri,
Packit Service 3749ba 
                              int unrecognized);
Packit Service 3749ba 
Set the unrecognized flag on this URI.
Packit Service 3749ba 
The unrecognized flag is automatically set to 1 when during parsing any part
Packit Service 3749ba 
of the URI is unrecognized. If the unrecognized flag is set to 1, then
Packit Service 3749ba 
matching against this URI will always fail.
Packit Service 3749ba
Packit Service 3749ba 
Parameters
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
uri
Packit Service 3749ba 
The URI
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
unrecognized
Packit Service 3749ba 
The new unregognized flag value
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_any_unrecognized ()
Packit Service 3749ba 
int
Packit Service 3749ba 
p11_kit_uri_any_unrecognized (P11KitUri *uri);
Packit Service 3749ba 
Get the unrecognized flag for this URI.
Packit Service 3749ba 
The unrecognized flag is automatically set to 1 when during parsing any part
Packit Service 3749ba 
of the URI is unrecognized. If the unrecognized flag is set to 1, then
Packit Service 3749ba 
matching against this URI will always fail.
Packit Service 3749ba
Packit Service 3749ba 
Parameters
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
uri
Packit Service 3749ba 
The URI
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
Returns
Packit Service 3749ba 
 1 if unrecognized flag is set, 0 otherwise.
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_get_pin_value ()
Packit Service 3749ba 
const char *
Packit Service 3749ba 
p11_kit_uri_get_pin_value (const P11KitUri *uri);
Packit Service 3749ba 
Get the 'pin-value' part of the URI. This is used by some applications to
Packit Service 3749ba 
read the PIN for logging into a PKCS#11 token.
Packit Service 3749ba
Packit Service 3749ba 
Parameters
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
uri
Packit Service 3749ba 
The URI
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
Returns
Packit Service 3749ba 
 The pin-value or NULL if not present.
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_set_pin_value ()
Packit Service 3749ba 
void
Packit Service 3749ba 
p11_kit_uri_set_pin_value (P11KitUri *uri,
Packit Service 3749ba 
                           const char *pin);
Packit Service 3749ba 
Set the 'pin-value' part of the URI. This is used by some applications to
Packit Service 3749ba 
specify the PIN for logging into a PKCS#11 token.
Packit Service 3749ba
Packit Service 3749ba 
Parameters
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
uri
Packit Service 3749ba 
The URI
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
pin
Packit Service 3749ba 
The new pin-value
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_get_pin_source ()
Packit Service 3749ba 
const char *
Packit Service 3749ba 
p11_kit_uri_get_pin_source (const P11KitUri *uri);
Packit Service 3749ba 
Get the 'pin-source' part of the URI. This is used by some applications to
Packit Service 3749ba 
lookup a PIN for logging into a PKCS#11 token.
Packit Service 3749ba
Packit Service 3749ba 
Parameters
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
uri
Packit Service 3749ba 
The URI
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
Returns
Packit Service 3749ba 
 The pin-source or NULL if not present.
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_set_pin_source ()
Packit Service 3749ba 
void
Packit Service 3749ba 
p11_kit_uri_set_pin_source (P11KitUri *uri,
Packit Service 3749ba 
                            const char *pin_source);
Packit Service 3749ba 
Set the 'pin-source' part of the URI. This is used by some applications to
Packit Service 3749ba 
lookup a PIN for logging into a PKCS#11 token.
Packit Service 3749ba
Packit Service 3749ba 
Parameters
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
uri
Packit Service 3749ba 
The URI
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
pin_source
Packit Service 3749ba 
The new pin-source
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_get_pinfile ()
Packit Service 3749ba 
const char *
Packit Service 3749ba 
p11_kit_uri_get_pinfile (const P11KitUri *uri);
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_get_pinfile is deprecated and should not be used in newly-written code.
Packit Service 3749ba 
use p11_kit_uri_get_pin_source().
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
Parameters
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
uri
Packit Service 3749ba 
The URI
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_set_pinfile ()
Packit Service 3749ba 
void
Packit Service 3749ba 
p11_kit_uri_set_pinfile (P11KitUri *uri,
Packit Service 3749ba 
                         const char *pinfile);
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_set_pinfile is deprecated and should not be used in newly-written code.
Packit Service 3749ba 
use p11_kit_uri_set_pin_source().
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
Parameters
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
uri
Packit Service 3749ba 
The URI
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
pinfile
Packit Service 3749ba 
The pinfile
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_get_module_name ()
Packit Service 3749ba 
const char *
Packit Service 3749ba 
p11_kit_uri_get_module_name (const P11KitUri *uri);
Packit Service 3749ba 
Get the 'module-name' part of the URI. This is used by some
Packit Service 3749ba 
applications to explicitly specify the name of a PKCS#11 module.
Packit Service 3749ba
Packit Service 3749ba 
Parameters
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
uri
Packit Service 3749ba 
The URI
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
Returns
Packit Service 3749ba 
 The module-name or NULL if not present.
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_set_module_name ()
Packit Service 3749ba 
void
Packit Service 3749ba 
p11_kit_uri_set_module_name (P11KitUri *uri,
Packit Service 3749ba 
                             const char *name);
Packit Service 3749ba 
Set the 'module-name' part of the URI. This is used by some
Packit Service 3749ba 
applications to explicitly specify the name of a PKCS#11 module.
Packit Service 3749ba
Packit Service 3749ba 
Parameters
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
uri
Packit Service 3749ba 
The URI
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
name
Packit Service 3749ba 
The new module-name
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_get_module_path ()
Packit Service 3749ba 
const char *
Packit Service 3749ba 
p11_kit_uri_get_module_path (const P11KitUri *uri);
Packit Service 3749ba 
Get the 'module-path' part of the URI. This is used by some
Packit Service 3749ba 
applications to explicitly specify the path of a PKCS#11 module.
Packit Service 3749ba
Packit Service 3749ba 
Parameters
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
uri
Packit Service 3749ba 
The URI
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
Returns
Packit Service 3749ba 
 The module-path or NULL if not present.
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_set_module_path ()
Packit Service 3749ba 
void
Packit Service 3749ba 
p11_kit_uri_set_module_path (P11KitUri *uri,
Packit Service 3749ba 
                             const char *path);
Packit Service 3749ba 
Set the 'module-path' part of the URI. This is used by some
Packit Service 3749ba 
applications to explicitly specify the path of a PKCS#11 module.
Packit Service 3749ba
Packit Service 3749ba 
Parameters
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
uri
Packit Service 3749ba 
The URI
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
path
Packit Service 3749ba 
The new module-path
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_get_vendor_query ()
Packit Service 3749ba 
const char *
Packit Service 3749ba 
p11_kit_uri_get_vendor_query (const P11KitUri *uri,
Packit Service 3749ba 
                              const char *name);
Packit Service 3749ba 
Get the vendor query part of the URI, identified by name
Packit Service 3749ba 
. This is
Packit Service 3749ba 
used by some applications to explicitly specify the path of a
Packit Service 3749ba 
PKCS#11 module.
Packit Service 3749ba
Packit Service 3749ba 
Parameters
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
uri
Packit Service 3749ba 
The URI
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
name
Packit Service 3749ba 
The name of vendor query
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
Returns
Packit Service 3749ba 
 The value of vendor query or NULL if not present.
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_set_vendor_query ()
Packit Service 3749ba 
int
Packit Service 3749ba 
p11_kit_uri_set_vendor_query (P11KitUri *uri,
Packit Service 3749ba 
                              const char *name,
Packit Service 3749ba 
                              const char *value);
Packit Service 3749ba 
Set the vendor query part of the URI, identified by name
Packit Service 3749ba 
. This is
Packit Service 3749ba 
used by some applications to explicitly specify the path of a
Packit Service 3749ba 
PKCS#11 module.
Packit Service 3749ba
Packit Service 3749ba 
Parameters
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
uri
Packit Service 3749ba 
The URI
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
name
Packit Service 3749ba 
The name of vendor query
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
value
Packit Service 3749ba 
The value of vendor query.
Packit Service 3749ba 
[allow-none]
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
Returns
Packit Service 3749ba 
 1 if the vendor query is set or removed, 0 if not.
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_format ()
Packit Service 3749ba 
int
Packit Service 3749ba 
p11_kit_uri_format (P11KitUri *uri,
Packit Service 3749ba 
                    P11KitUriType uri_type,
Packit Service 3749ba 
                    char **string);
Packit Service 3749ba 
Format a PKCS#11 URI into a string.
Packit Service 3749ba 
Fields which are zeroed out will not be included in the resulting string.
Packit Service 3749ba 
Attributes which are not present will also not be included.
Packit Service 3749ba 
The uri_type of URI specified limits the different parts of the resulting
Packit Service 3749ba 
URI. To format a URI containing all possible information use
Packit Service 3749ba 
P11_KIT_URI_FOR_ANY
Packit Service 3749ba 
It's up to the caller to guarantee that the attributes set in uri
Packit Service 3749ba 
 are
Packit Service 3749ba 
those appropriate for inclusion in a URI, specifically:
Packit Service 3749ba 
CKA_ID, CKA_LABEL
Packit Service 3749ba 
and CKA_CLASS. The class must be one of
Packit Service 3749ba 
CKO_DATA, CKO_SECRET_KEY,
Packit Service 3749ba 
CKO_CERTIFICATE, CKO_PUBLIC_KEY,
Packit Service 3749ba 
CKO_PRIVATE_KEY.
Packit Service 3749ba 
The resulting string should be freed with free().
Packit Service 3749ba
Packit Service 3749ba 
Parameters
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
uri
Packit Service 3749ba 
The URI.
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
uri_type
Packit Service 3749ba 
The type of URI that should be produced.
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
string
Packit Service 3749ba 
Location to store a newly allocated string.
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
Returns
Packit Service 3749ba 
 P11_KIT_URI_OK if the URI was formatted successfully,
Packit Service 3749ba 
P11_KIT_URI_UNEXPECTED if the data in uri
Packit Service 3749ba 
is invalid for a URI.
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_parse ()
Packit Service 3749ba 
int
Packit Service 3749ba 
p11_kit_uri_parse (const char *string,
Packit Service 3749ba 
                   P11KitUriType uri_type,
Packit Service 3749ba 
                   P11KitUri *uri);
Packit Service 3749ba 
Parse a PKCS#11 URI string.
Packit Service 3749ba 
PKCS#11 URIs can represent tokens, objects or modules. The uri_type argument
Packit Service 3749ba 
allows the caller to specify what type of URI is expected and the sorts of
Packit Service 3749ba 
things the URI should match. P11_KIT_URI_FOR_ANY can be used to parse a URI
Packit Service 3749ba 
for any context. It's then up to the caller to make sense of the way that
Packit Service 3749ba 
it is used.
Packit Service 3749ba 
If the PKCS#11 URI contains unrecognized URI parts or parts not applicable
Packit Service 3749ba 
to the specified context, then the unrecognized flag will be set. This will
Packit Service 3749ba 
prevent the URI from matching using the various match functions.
Packit Service 3749ba
Packit Service 3749ba 
Parameters
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
string
Packit Service 3749ba 
The string to parse
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
uri_type
Packit Service 3749ba 
The type of URI that is expected
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
uri
Packit Service 3749ba 
The blank URI to parse the values into
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
Returns
Packit Service 3749ba 
 P11_KIT_URI_OK if the URI was parsed successfully.
Packit Service 3749ba 
P11_KIT_URI_BAD_SCHEME if this was not a PKCS#11 URI.
Packit Service 3749ba 
P11_KIT_URI_BAD_SYNTAX if the URI syntax was bad.
Packit Service 3749ba 
P11_KIT_URI_BAD_VERSION if a version number was bad.
Packit Service 3749ba 
P11_KIT_URI_BAD_ENCODING if the URI encoding was invalid.
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_free ()
Packit Service 3749ba 
void
Packit Service 3749ba 
p11_kit_uri_free (P11KitUri *uri);
Packit Service 3749ba 
Free a PKCS#11 URI.
Packit Service 3749ba
Packit Service 3749ba 
Parameters
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
uri
Packit Service 3749ba 
The URI
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri_message ()
Packit Service 3749ba 
const char *
Packit Service 3749ba 
p11_kit_uri_message (int code);
Packit Service 3749ba 
Lookup a message for the uri error code. These codes are the P11_KIT_URI_XXX
Packit Service 3749ba 
error codes that can be returned from p11_kit_uri_parse() or
Packit Service 3749ba 
p11_kit_uri_format(). As a special case NULL, will be returned for
Packit Service 3749ba 
P11_KIT_URI_OK.
Packit Service 3749ba
Packit Service 3749ba 
Parameters
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
code
Packit Service 3749ba 
The error code
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
Returns
Packit Service 3749ba 
 The message for the error code. This string is owned by the p11-kit
Packit Service 3749ba 
library.
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
Types and Values
Packit Service 3749ba
Packit Service 3749ba 
P11_KIT_URI_SCHEME
Packit Service 3749ba 
#define P11_KIT_URI_SCHEME "pkcs11"
Packit Service 3749ba
Packit Service 3749ba 
String of URI scheme for PKCS#11 URIs.
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
P11_KIT_URI_SCHEME_LEN
Packit Service 3749ba 
#define P11_KIT_URI_SCHEME_LEN 6
Packit Service 3749ba
Packit Service 3749ba 
Length of P11_KIT_URI_SCHEME.
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
enum P11KitUriType
Packit Service 3749ba 
A PKCS#11 URI can represent different kinds of things. This flag is used by
Packit Service 3749ba 
p11_kit_uri_parse() to denote in what context the URI will be used.
Packit Service 3749ba 
The various types can be combined.
Packit Service 3749ba
Packit Service 3749ba 
Members
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
P11_KIT_URI_FOR_OBJECT
Packit Service 3749ba
Packit Service 3749ba 
The URI represents one or more objects
Packit Service 3749ba
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
P11_KIT_URI_FOR_TOKEN
Packit Service 3749ba
Packit Service 3749ba 
The URI represents one or more tokens
Packit Service 3749ba
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
P11_KIT_URI_FOR_SLOT
Packit Service 3749ba
Packit Service 3749ba 
The URI represents one or more slots
Packit Service 3749ba
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
P11_KIT_URI_FOR_MODULE
Packit Service 3749ba
Packit Service 3749ba 
The URI represents one or more modules
Packit Service 3749ba
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
P11_KIT_URI_FOR_MODULE_WITH_VERSION
Packit Service 3749ba
Packit Service 3749ba 
The URI represents a module with
Packit Service 3749ba 
a specific version.
Packit Service 3749ba
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
P11_KIT_URI_FOR_OBJECT_ON_TOKEN
Packit Service 3749ba
Packit Service 3749ba 
The URI represents one or more objects
Packit Service 3749ba 
that are present on a specific token.
Packit Service 3749ba
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
P11_KIT_URI_FOR_OBJECT_ON_TOKEN_AND_MODULE
Packit Service 3749ba
Packit Service 3749ba 
The URI represents one or more
Packit Service 3749ba 
objects that are present on a specific token, being used with a certain
Packit Service 3749ba 
module.
Packit Service 3749ba
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
P11_KIT_URI_FOR_ANY
Packit Service 3749ba
Packit Service 3749ba 
The URI can represent anything
Packit Service 3749ba
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
enum P11KitUriResult
Packit Service 3749ba 
Error codes returned by various functions. The functions each clearly state
Packit Service 3749ba 
which error codes they are capable of returning.
Packit Service 3749ba
Packit Service 3749ba 
Members
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
P11_KIT_URI_OK
Packit Service 3749ba
Packit Service 3749ba 
Success
Packit Service 3749ba
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
P11_KIT_URI_UNEXPECTED
Packit Service 3749ba
Packit Service 3749ba 
Unexpected or internal system error
Packit Service 3749ba
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
P11_KIT_URI_BAD_SCHEME
Packit Service 3749ba
Packit Service 3749ba 
The URI had a bad scheme
Packit Service 3749ba
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
P11_KIT_URI_BAD_ENCODING
Packit Service 3749ba
Packit Service 3749ba 
The URI had a bad encoding
Packit Service 3749ba
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
P11_KIT_URI_BAD_SYNTAX
Packit Service 3749ba
Packit Service 3749ba 
The URI had a bad syntax
Packit Service 3749ba
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
P11_KIT_URI_BAD_VERSION
Packit Service 3749ba
Packit Service 3749ba 
The URI contained a bad version number
Packit Service 3749ba
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
P11_KIT_URI_NOT_FOUND
Packit Service 3749ba
Packit Service 3749ba 
A requested part of the URI was not found
Packit Service 3749ba
Packit Service 3749ba 
 
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
P11KitUri
Packit Service 3749ba 
typedef struct p11_kit_uri P11KitUri;
Packit Service 3749ba
Packit Service 3749ba 
A structure representing a PKCS#11 URI. There are no public fields
Packit Service 3749ba 
visible in this structure. Use the various accessor functions.
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
p11_kit_uri
Packit Service 3749ba 
typedef struct p11_kit_uri p11_kit_uri;
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
P11_KIT_URI_NO_MEMORY
Packit Service 3749ba 
#define P11_KIT_URI_NO_MEMORY P11_KIT_URI_UNEXPECTED
Packit Service 3749ba
Packit Service 3749ba 
Unexpected memory allocation failure result. Same as P11_KIT_URI_UNEXPECTED.
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba 
Generated by GTK-Doc V1.32
Packit Service 3749ba 
</body>
Packit Service 3749ba 
</html>

Powered by Pagure 5.14.1

SSH Hostkey/Fingerprint | Documentation