Blame docs/reference/gcr/html/gcr-Library-PKCS#11.html

Packit b00eeb
Packit b00eeb
<html>
Packit b00eeb
<head>
Packit b00eeb
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
Packit b00eeb
<title>Library PKCS#11: Gcr Library Reference Manual</title>
Packit b00eeb
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
Packit b00eeb
<link rel="home" href="index.html" title="Gcr Library Reference Manual">
Packit b00eeb
<link rel="up" href="misc.html" title="Part VI. Miscellaneous">
Packit b00eeb
<link rel="prev" href="gcr-Library-Utilities.html" title="Library Utilities">
Packit b00eeb
<link rel="next" href="gcr-Key-Fingerprints.html" title="Key Fingerprints">
Packit b00eeb
<meta name="generator" content="GTK-Doc V1.27.1 (XML mode)">
Packit b00eeb
<link rel="stylesheet" href="style.css" type="text/css">
Packit b00eeb
</head>
Packit b00eeb
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
Packit b00eeb
Packit b00eeb
Packit b00eeb
Top  | 
Packit b00eeb
                  Description
Packit b00eeb
Packit b00eeb
Home
Packit b00eeb
Up
Packit b00eeb
Prev
Packit b00eeb
Next
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb

Library PKCS#11

Packit b00eeb

Library PKCS#11 — functions for manipulating GCR library global settings.

Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb

Functions

Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
gboolean
Packit b00eeb
Packit b00eeb
Packit b00eeb
gcr_pkcs11_initialize ()
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
void
Packit b00eeb
Packit b00eeb
Packit b00eeb
gcr_pkcs11_initialize_async ()
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
gboolean
Packit b00eeb
Packit b00eeb
Packit b00eeb
gcr_pkcs11_initialize_finish ()
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
GList *
Packit b00eeb
Packit b00eeb
Packit b00eeb
gcr_pkcs11_get_modules ()
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
void
Packit b00eeb
Packit b00eeb
Packit b00eeb
gcr_pkcs11_set_modules ()
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
void
Packit b00eeb
Packit b00eeb
Packit b00eeb
gcr_pkcs11_add_module ()
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
gboolean
Packit b00eeb
Packit b00eeb
Packit b00eeb
gcr_pkcs11_add_module_from_file ()
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
GList *
Packit b00eeb
Packit b00eeb
Packit b00eeb
gcr_pkcs11_get_trust_lookup_slots ()
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
GckSlot *
Packit b00eeb
Packit b00eeb
Packit b00eeb
gcr_pkcs11_get_trust_store_slot ()
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
const gchar **
Packit b00eeb
Packit b00eeb
Packit b00eeb
gcr_pkcs11_get_trust_lookup_uris ()
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
void
Packit b00eeb
Packit b00eeb
Packit b00eeb
gcr_pkcs11_set_trust_lookup_uris ()
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
const gchar *
Packit b00eeb
Packit b00eeb
Packit b00eeb
gcr_pkcs11_get_trust_store_uri ()
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
void
Packit b00eeb
Packit b00eeb
Packit b00eeb
gcr_pkcs11_set_trust_store_uri ()
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb

Description

Packit b00eeb

Manage or lookup various global aspesct and settings of the library.

Packit b00eeb

The GCR library maintains a global list of PKCS#11 modules to use for

Packit b00eeb
its various lookups and storage operations. Each module is represented by
Packit b00eeb
a GckModule object. You can examine this list by using
Packit b00eeb
gcr_pkcs11_get_modules().

Packit b00eeb

The list is configured automatically by looking for system installed

Packit b00eeb
PKCS#11 modules. It's not not normally necessary to modify this list. But
Packit b00eeb
if you have special needs, you can use the gcr_pkcs11_set_modules() and
Packit b00eeb
gcr_pkcs11_add_module() to do so.

Packit b00eeb

Trust assertions are stored and looked up in specific PKCS#11 slots.

Packit b00eeb
You can examine this list with gcr_pkcs11_get_trust_lookup_slots()

Packit b00eeb
Packit b00eeb
Packit b00eeb

Functions

Packit b00eeb
Packit b00eeb

gcr_pkcs11_initialize ()

Packit b00eeb
gboolean
Packit b00eeb
gcr_pkcs11_initialize (GCancellable *cancellable,
Packit b00eeb
                       GError **error);
Packit b00eeb

Asynchronously initialize the registered PKCS#11 modules.

Packit b00eeb
Packit b00eeb

Parameters

Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb

cancellable

Packit b00eeb

optional cancellable used to cancel the operation

Packit b00eeb
 
Packit b00eeb
Packit b00eeb
Packit b00eeb

error

Packit b00eeb

location to place an error on failure

Packit b00eeb
 
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb

Returns

Packit b00eeb

whether the operation was successful or not.

Packit b00eeb
Packit b00eeb
Packit b00eeb

Packit b00eeb
Packit b00eeb

gcr_pkcs11_initialize_async ()

Packit b00eeb
void
Packit b00eeb
gcr_pkcs11_initialize_async (GCancellable *cancellable,
Packit b00eeb
                             GAsyncReadyCallback callback,
Packit b00eeb
                             gpointer user_data);
Packit b00eeb

Asynchronously initialize the registered PKCS#11 modules.

Packit b00eeb
Packit b00eeb

Parameters

Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb

cancellable

Packit b00eeb

optional cancellable used to cancel the operation

Packit b00eeb
 
Packit b00eeb
Packit b00eeb
Packit b00eeb

callback

Packit b00eeb

callback which will be called when the operation completes

Packit b00eeb
 
Packit b00eeb
Packit b00eeb
Packit b00eeb

user_data

Packit b00eeb

data passed to the callback

Packit b00eeb
 
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb

Packit b00eeb
Packit b00eeb

gcr_pkcs11_initialize_finish ()

Packit b00eeb
gboolean
Packit b00eeb
gcr_pkcs11_initialize_finish (GAsyncResult *result,
Packit b00eeb
                              GError **error);
Packit b00eeb

Complete the asynchronous operation to initialize the registered PKCS#11

Packit b00eeb
modules.

Packit b00eeb
Packit b00eeb

Parameters

Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb

result

Packit b00eeb

the asynchronous result

Packit b00eeb
 
Packit b00eeb
Packit b00eeb
Packit b00eeb

error

Packit b00eeb

location to place an error on failure

Packit b00eeb
 
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb

Returns

Packit b00eeb

whether the operation was successful or not.

Packit b00eeb
Packit b00eeb
Packit b00eeb

Packit b00eeb
Packit b00eeb

gcr_pkcs11_get_modules ()

Packit b00eeb
GList *
Packit b00eeb
gcr_pkcs11_get_modules (void);
Packit b00eeb

List all the PKCS#11 modules that are used by the GCR library.

Packit b00eeb
Each module is a GckModule object.

Packit b00eeb

An empty list of modules will be returned if gcr_pkcs11_set_modules(),

Packit b00eeb
or gcr_pkcs11_initialize() has not yet run.

Packit b00eeb

When done with the list, free it with gck_list_unref_free().

Packit b00eeb
Packit b00eeb

Returns

Packit b00eeb

a newly allocated list

Packit b00eeb
of GckModule objects. 

Packit b00eeb

[transfer full][element-type Gck.Module]

Packit b00eeb
Packit b00eeb
Packit b00eeb

Packit b00eeb
Packit b00eeb

gcr_pkcs11_set_modules ()

Packit b00eeb
void
Packit b00eeb
gcr_pkcs11_set_modules (GList *modules);
Packit b00eeb

Set the list of PKCS#11 modules that are used by the GCR library.

Packit b00eeb
Each module in the list is a GckModule object.

Packit b00eeb

It is not normally necessary to call this function. The available

Packit b00eeb
PKCS#11 modules installed on the system are automatically loaded
Packit b00eeb
by the GCR library.

Packit b00eeb
Packit b00eeb

Parameters

Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb

modules

Packit b00eeb

a list of GckModule.

Packit b00eeb
[element-type Gck.Module]
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb

Packit b00eeb
Packit b00eeb

gcr_pkcs11_add_module ()

Packit b00eeb
void
Packit b00eeb
gcr_pkcs11_add_module (GckModule *module);
Packit b00eeb

Add a GckModule to the list of PKCS#11 modules that are used by the

Packit b00eeb
GCR library.

Packit b00eeb

It is not normally necessary to call this function. The available

Packit b00eeb
PKCS#11 modules installed on the system are automatically loaded
Packit b00eeb
by the GCR library.

Packit b00eeb
Packit b00eeb

Parameters

Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb

module

Packit b00eeb

a GckModule

Packit b00eeb
 
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb

Packit b00eeb
Packit b00eeb

gcr_pkcs11_add_module_from_file ()

Packit b00eeb
gboolean
Packit b00eeb
gcr_pkcs11_add_module_from_file (const gchar *module_path,
Packit b00eeb
                                 gpointer unused,
Packit b00eeb
                                 GError **error);
Packit b00eeb

Initialize a PKCS#11 module and add it to the modules that are

Packit b00eeb
used by the GCR library. Note that is an error to initialize the same
Packit b00eeb
PKCS#11 module twice.

Packit b00eeb

It is not normally necessary to call this function. The available

Packit b00eeb
PKCS#11 modules installed on the system are automatically loaded
Packit b00eeb
by the GCR library.

Packit b00eeb
Packit b00eeb

Parameters

Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb

module_path

Packit b00eeb

the full file path of the PKCS#11 module

Packit b00eeb
 
Packit b00eeb
Packit b00eeb
Packit b00eeb

unused

Packit b00eeb

unused

Packit b00eeb
 
Packit b00eeb
Packit b00eeb
Packit b00eeb

error

Packit b00eeb

a GError or NULL

Packit b00eeb
 
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb

Returns

Packit b00eeb

whether the module was sucessfully added.

Packit b00eeb
Packit b00eeb
Packit b00eeb

Packit b00eeb
Packit b00eeb

gcr_pkcs11_get_trust_lookup_slots ()

Packit b00eeb
GList *
Packit b00eeb
gcr_pkcs11_get_trust_lookup_slots (void);
Packit b00eeb

List all the PKCS#11 slots that are used by the GCR library for lookup

Packit b00eeb
of trust assertions. Each slot is a GckSlot object.

Packit b00eeb

This will return an empty list if the gcr_pkcs11_initialize() function has

Packit b00eeb
not yet been called.

Packit b00eeb

When done with the list, free it with gck_list_unref_free().

Packit b00eeb
Packit b00eeb

Returns

Packit b00eeb

a list of GckSlot objects

Packit b00eeb
to use for lookup of trust. 

Packit b00eeb

[transfer full][element-type Gck.Slot]

Packit b00eeb
Packit b00eeb
Packit b00eeb

Packit b00eeb
Packit b00eeb

gcr_pkcs11_get_trust_store_slot ()

Packit b00eeb
GckSlot *
Packit b00eeb
gcr_pkcs11_get_trust_store_slot (void);
Packit b00eeb

Selects an appropriate PKCS#11 slot to store trust assertions. The slot

Packit b00eeb
to use is normally configured automatically by the system.

Packit b00eeb

This will only return a valid result after the gcr_pkcs11_initialize()

Packit b00eeb
method has been called.

Packit b00eeb

When done with the GckSlot, use g_object_unref() to release it.

Packit b00eeb
Packit b00eeb

Returns

Packit b00eeb

the GckSlot to use for trust assertions.

Packit b00eeb

[transfer full]

Packit b00eeb
Packit b00eeb
Packit b00eeb

Packit b00eeb
Packit b00eeb

gcr_pkcs11_get_trust_lookup_uris ()

Packit b00eeb
const gchar **
Packit b00eeb
gcr_pkcs11_get_trust_lookup_uris (void);
Packit b00eeb

Get the PKCS#11 URIs that are used to identify which slots to use for

Packit b00eeb
lookup trust assertions.

Packit b00eeb
Packit b00eeb

Returns

Packit b00eeb

the uri which identifies trust storage slot.

Packit b00eeb

[allow-none][transfer none]

Packit b00eeb
Packit b00eeb
Packit b00eeb

Packit b00eeb
Packit b00eeb

gcr_pkcs11_set_trust_lookup_uris ()

Packit b00eeb
void
Packit b00eeb
gcr_pkcs11_set_trust_lookup_uris (const gchar **pkcs11_uris);
Packit b00eeb

Set the PKCS#11 URIs that are used to identify which slots to use for

Packit b00eeb
lookup of trust assertions.

Packit b00eeb

It is not normally necessary to call this function. The relevant

Packit b00eeb
PKCS#11 slots are automatically configured by the GCR library.

Packit b00eeb
Packit b00eeb

Parameters

Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb

pkcs11_uris

Packit b00eeb

the uris which identifies trust lookup slots.

Packit b00eeb
[allow-none]
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb

Packit b00eeb
Packit b00eeb

gcr_pkcs11_get_trust_store_uri ()

Packit b00eeb
const gchar *
Packit b00eeb
gcr_pkcs11_get_trust_store_uri (void);
Packit b00eeb

Get the PKCS#11 URI that is used to identify which slot to use for

Packit b00eeb
storing trust storage.

Packit b00eeb
Packit b00eeb

Returns

Packit b00eeb

the uri which identifies trust storage slot.

Packit b00eeb

[allow-none]

Packit b00eeb
Packit b00eeb
Packit b00eeb

Packit b00eeb
Packit b00eeb

gcr_pkcs11_set_trust_store_uri ()

Packit b00eeb
void
Packit b00eeb
gcr_pkcs11_set_trust_store_uri (const gchar *pkcs11_uri);
Packit b00eeb

Set the PKCS#11 URI that is used to identify which slot to use for

Packit b00eeb
storing trust assertions.

Packit b00eeb

It is not normally necessary to call this function. The relevant

Packit b00eeb
PKCS#11 slot is automatically configured by the GCR library.

Packit b00eeb
Packit b00eeb

Parameters

Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb

pkcs11_uri

Packit b00eeb

the uri which identifies trust storage slot.

Packit b00eeb
[allow-none]
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb

Types and Values

Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb

Generated by GTK-Doc V1.27.1
Packit b00eeb
</body>
Packit b00eeb
</html>