diff options
| author | Stefan Walter <stefw@src.gnome.org> | 2009-03-17 02:53:59 +0000 |
|---|---|---|
| committer | Stefan Walter <stefw@src.gnome.org> | 2009-03-17 02:53:59 +0000 |
| commit | 0875bda4ca9af952c9ff0e2163d726eac7ebcb98 (patch) | |
| tree | 67ecee337db062ea90dc54ecb68099a5e6f2df2e | |
| parent | 5a4f096c1e6d470a991dbf33c6e609ddd94c6efa (diff) | |
Merge branch 'docs-reorganize'
svn path=/trunk/; revision=1690
62 files changed, 1690 insertions, 9885 deletions
@@ -1,5 +1,5 @@ -/*~ -/*.bak +*~ +*.bak /compile /*.tmp /*.prj @@ -1,3 +1,7 @@ +2009-03-16 Stef Walter <stef@memberwebs.com> + + * Merge docs-organize branch. + === gnome-keyring 2.26.0 === 2009-03-14 Stef Walter <stef@memberwebs.com> diff --git a/Makefile.am b/Makefile.am index 2de8f7de..c63574a2 100644 --- a/Makefile.am +++ b/Makefile.am @@ -20,9 +20,10 @@ SUBDIRS = \ pkcs11 \ daemon \ tool \ - po \ $(TESTS_DIR) \ - $(PAM_DIR) + $(PAM_DIR) \ + po \ + docs EXTRA_DIST = \ intltool-extract.in \ diff --git a/configure.in b/configure.in index 0942e56a..0f9cdb0b 100644 --- a/configure.in +++ b/configure.in @@ -41,7 +41,7 @@ AC_TYPE_SIGNAL AC_TYPE_SIZE_T AC_TYPE_UID_T -GTK_DOC_CHECK +GTK_DOC_CHECK(1.9) DISTCHECK_CONFIGURE_FLAGS="--enable-gtk-doc" AC_SUBST(DISTCHECK_CONFIGURE_FLAGS) @@ -551,6 +551,11 @@ daemon/keyrings/Makefile daemon/keyrings/tests/Makefile daemon/pkcs11/Makefile daemon/ui/Makefile +docs/Makefile +docs/reference/Makefile +docs/reference/gcr/Makefile +docs/reference/gnome-keyring/Makefile +docs/reference/gp11/Makefile egg/Makefile egg/tests/Makefile gcr/gcr.pc @@ -558,10 +563,8 @@ gcr/Makefile gcr/tests/Makefile gp11/gp11.pc gp11/Makefile -gp11/reference/Makefile gp11/tests/Makefile library/Makefile -library/reference/Makefile library/tests/Makefile pam/Makefile pam/tests/Makefile diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 00000000..22a4e729 --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1,3 @@ +Makefile +Makefile.in + diff --git a/docs/Makefile.am b/docs/Makefile.am new file mode 100644 index 00000000..cac25f2d --- /dev/null +++ b/docs/Makefile.am @@ -0,0 +1,2 @@ + +SUBDIRS = reference diff --git a/docs/reference/.gitignore b/docs/reference/.gitignore new file mode 100644 index 00000000..22a4e729 --- /dev/null +++ b/docs/reference/.gitignore @@ -0,0 +1,3 @@ +Makefile +Makefile.in + diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am new file mode 100644 index 00000000..bcf78307 --- /dev/null +++ b/docs/reference/Makefile.am @@ -0,0 +1,2 @@ + +SUBDIRS = gcr gnome-keyring gp11 diff --git a/docs/reference/gcr/.gitignore b/docs/reference/gcr/.gitignore new file mode 100644 index 00000000..a769990c --- /dev/null +++ b/docs/reference/gcr/.gitignore @@ -0,0 +1,27 @@ +Makefile +Makefile.in +.libs + +# Directories created by gtk-doc +tmpl +html +xml + +# Files generated by gtk-doc +*.stamp + +# Reports generated by gtk-doc +*-undeclared.txt +*-undocumented.txt +*-unused.txt + +# Commit these files if you edit them +*-decl-list.txt +*-decl.txt +*-overrides.txt +*.args +*.hierarchy +*.interfaces +*.prerequisites +*.signals + diff --git a/docs/reference/gcr/Makefile.am b/docs/reference/gcr/Makefile.am new file mode 100644 index 00000000..d2e82e3a --- /dev/null +++ b/docs/reference/gcr/Makefile.am @@ -0,0 +1,99 @@ +## Process this file with automake to produce Makefile.in + +# We require automake 1.6 at least. +AUTOMAKE_OPTIONS = 1.6 + +# This is a blank Makefile.am for using gtk-doc. +# Copy this to your project's API docs directory and modify the variables to +# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples +# of using the various options. + +# The name of the module, e.g. 'glib'. +DOC_MODULE=gcr + +# Uncomment for versioned docs and specify the version of the module, e.g. '2'. +#DOC_MODULE_VERSION=2 + + +# The top-level SGML file. You can change this if you want to. +DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml + +# The directory containing the source code. Relative to $(srcdir). +# gtk-doc will search all .c & .h files beneath here for inline comments +# documenting the functions and macros. +# e.g. DOC_SOURCE_DIR=../../../gtk +DOC_SOURCE_DIR=../../../$(DOC_MODULE) + +# Extra options to pass to gtkdoc-scangobj. Not normally needed. +SCANGOBJ_OPTIONS= + +# Extra options to supply to gtkdoc-scan. +# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED" +SCAN_OPTIONS= + +# Extra options to supply to gtkdoc-mkdb. +# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml +MKDB_OPTIONS=--sgml-mode --output-format=xml + +# Extra options to supply to gtkdoc-mktmpl +# e.g. MKTMPL_OPTIONS=--only-section-tmpl +MKTMPL_OPTIONS= + +# Extra options to supply to gtkdoc-mkhtml +MKHTML_OPTIONS= + +# Extra options to supply to gtkdoc-fixref. Not normally needed. +# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html +FIXXREF_OPTIONS= + +# Used for dependencies. The docs will be rebuilt if any of these change. +# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h +# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c +HFILE_GLOB=$(top_srcdir)/$(DOC_MODULE)/*.h +CFILE_GLOB=$(top_srcdir)/$(DOC_MODULE)/*.c + +# Extra header to include when scanning, which are not under DOC_SOURCE_DIR +# e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h +EXTRA_HFILES= + +# Header files to ignore when scanning. Use base file name, no paths +# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h +IGNORE_HFILES= gcr-xxx.h + +# Images to copy into HTML directory. +# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png +HTML_IMAGES= + +# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE). +# e.g. content_files=running.sgml building.sgml changes-2.0.sgml +content_files= + +# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded +# These files must be listed here *and* in content_files +# e.g. expand_content_files=running.sgml +expand_content_files= + +# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library. +# Only needed if you are using gtkdoc-scangobj to dynamically query widget +# signals and properties. +# e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS) +# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib) +GTKDOC_CFLAGS= -I$(top_srcdir) -I$(top_builddir) $(GOBJECT_CFLAGS) -Wno-error +GTKDOC_LIBS= $(GOBJECT_LIBS) $(top_srcdir)/$(DOC_MODULE)/lib$(DOC_MODULE).la + +# This includes the standard gtk-doc make rules, copied by gtkdocize. +include $(top_srcdir)/gtk-doc.make + +# Other files to distribute +# e.g. EXTRA_DIST += version.xml.in +EXTRA_DIST += + +# Files not to distribute +# for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types +# for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt +#DISTCLEANFILES += + +# Comment this out if you want your docs-status tested during 'make check' +#TESTS_ENVIRONMENT = cd $(srcsrc) +#TESTS = $(GTKDOC_CHECK) + diff --git a/docs/reference/gcr/gcr-docs.sgml b/docs/reference/gcr/gcr-docs.sgml new file mode 100644 index 00000000..f4ef9c74 --- /dev/null +++ b/docs/reference/gcr/gcr-docs.sgml @@ -0,0 +1,27 @@ +<?xml version="1.0"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" + "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"> +<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude"> + <bookinfo> + <title>gcr Reference Manual</title> + <releaseinfo> + for gcr [VERSION] + The latest version of this documentation can be found on-line at + <ulink role="online-location" url="http://[SERVER]/gcr/index.html">http://[SERVER]/gcr/</ulink>. + </releaseinfo> + </bookinfo> + + <chapter> + <title>[Insert title here]</title> + <xi:include href="xml/gcr-import-dialog.xml"/> + <xi:include href="xml/gcr-certificate-details-widget.xml"/> + <xi:include href="xml/gcr-certificate-basics-widget.xml"/> + <xi:include href="xml/gcr-parser.xml"/> + <xi:include href="xml/gcr-certificate.xml"/> + <xi:include href="xml/gcr-initializer.xml"/> + <xi:include href="xml/gcr-importer.xml"/> + <xi:include href="xml/gcr-simple-certificate.xml"/> + <xi:include href="xml/gcr-xxx.xml"/> + <xi:include href="xml/gcr-types.xml"/> + </chapter> +</book> diff --git a/docs/reference/gcr/gcr-sections.txt b/docs/reference/gcr/gcr-sections.txt new file mode 100644 index 00000000..6dd180c0 --- /dev/null +++ b/docs/reference/gcr/gcr-sections.txt @@ -0,0 +1,204 @@ +<SECTION> +<FILE>gcr-import-dialog</FILE> +GcrImportDialogPrivate +<TITLE>GcrImportDialog</TITLE> +GcrImportDialog +<SUBSECTION Standard> +GCR_IMPORT_DIALOG +GCR_IS_IMPORT_DIALOG +GCR_TYPE_IMPORT_DIALOG +GCR_IMPORT_DIALOG_CLASS +GCR_IS_IMPORT_DIALOG_CLASS +GCR_IMPORT_DIALOG_GET_CLASS +</SECTION> + +<SECTION> +<FILE>gcr-certificate-details-widget</FILE> +GcrCertificateDetailsWidgetPrivate +<TITLE>GcrCertificateDetailsWidget</TITLE> +GcrCertificateDetailsWidget +gcr_certificate_details_widget_new +gcr_certificate_details_widget_get_certificate +gcr_certificate_details_widget_set_certificate +<SUBSECTION Standard> +GCR_CERTIFICATE_DETAILS_WIDGET +GCR_IS_CERTIFICATE_DETAILS_WIDGET +GCR_TYPE_CERTIFICATE_DETAILS_WIDGET +gcr_certificate_details_widget_get_type +GCR_CERTIFICATE_DETAILS_WIDGET_CLASS +GCR_IS_CERTIFICATE_DETAILS_WIDGET_CLASS +GCR_CERTIFICATE_DETAILS_WIDGET_GET_CLASS +</SECTION> + +<SECTION> +<FILE>gcr-certificate-basics-widget</FILE> +GcrCertificateBasicsWidgetPrivate +<TITLE>GcrCertificateBasicsWidget</TITLE> +GcrCertificateBasicsWidget +gcr_certificate_basics_widget_new +gcr_certificate_basics_widget_get_certificate +gcr_certificate_basics_widget_set_certificate +<SUBSECTION Standard> +GCR_CERTIFICATE_BASICS_WIDGET +GCR_IS_CERTIFICATE_BASICS_WIDGET +GCR_TYPE_CERTIFICATE_BASICS_WIDGET +gcr_certificate_basics_widget_get_type +GCR_CERTIFICATE_BASICS_WIDGET_CLASS +GCR_IS_CERTIFICATE_BASICS_WIDGET_CLASS +GCR_CERTIFICATE_BASICS_WIDGET_GET_CLASS +</SECTION> + +<SECTION> +<FILE>gcr-parser</FILE> +GcrParsedItem +GcrParserPrivate +<TITLE>GcrParser</TITLE> +GcrParser +gcr_parser_new +gcr_parser_format_enable +gcr_parser_format_disable +gcr_parser_format_supported +gcr_parser_parse_data +gcr_parser_add_password +gcr_parser_get_parsed_label +gcr_parser_get_parsed_description +gcr_parser_get_parsed_attributes +<SUBSECTION Standard> +GCR_PARSER +GCR_IS_PARSER +GCR_TYPE_PARSER +gcr_parser_get_type +GCR_PARSER_CLASS +GCR_IS_PARSER_CLASS +GCR_PARSER_GET_CLASS +</SECTION> + +<SECTION> +<FILE>gcr-certificate</FILE> +GCR_CERTIFICATE_GET_INTERFACE +GcrCertificate +GcrCertificateIface +gcr_certificate_get_der_data +gcr_certificate_get_issuer_cn +gcr_certificate_get_issuer_dn +gcr_certificate_get_issuer_part +gcr_certificate_get_subject_cn +gcr_certificate_get_subject_dn +gcr_certificate_get_subject_part +gcr_certificate_get_issued_date +gcr_certificate_get_expiry_date +gcr_certificate_get_serial_number +gcr_certificate_get_serial_number_hex +gcr_certificate_get_key_size +gcr_certificate_get_fingerprint +gcr_certificate_get_fingerprint_hex +<SUBSECTION Standard> +GCR_CERTIFICATE +GCR_IS_CERTIFICATE +GCR_TYPE_CERTIFICATE +gcr_certificate_get_type +</SECTION> + +<SECTION> +<FILE>gcr-initializer</FILE> +GcrTokenManagerPrivate +<TITLE>GcrTokenManager</TITLE> +GcrTokenManager +gcr_token_manager_new +gcr_token_manager_get_slot +gcr_token_manager_initialize +gcr_token_manager_initialize_async +gcr_token_manager_initialize_finish +gcr_token_manager_change_pin +gcr_token_manager_change_pin_async +gcr_token_manager_change_pin_finish +<SUBSECTION Standard> +GCR_TOKEN_MANAGER +GCR_IS_TOKEN_MANAGER +GCR_TYPE_TOKEN_MANAGER +gcr_token_manager_get_type +GCR_TOKEN_MANAGER_CLASS +GCR_IS_TOKEN_MANAGER_CLASS +GCR_TOKEN_MANAGER_GET_CLASS +</SECTION> + +<SECTION> +<FILE>gcr-importer</FILE> +GcrImporterPromptBehavior +GcrImporterPrivate +<TITLE>GcrImporter</TITLE> +GcrImporter +gcr_importer_new +gcr_importer_get_parser +gcr_importer_set_parser +gcr_importer_get_slot +gcr_importer_set_slot +gcr_importer_get_prompt_behavior +gcr_importer_set_prompt_behavior +gcr_importer_import +gcr_importer_import_async +gcr_importer_import_finish +<SUBSECTION Standard> +GCR_IMPORTER +GCR_IS_IMPORTER +GCR_TYPE_IMPORTER +gcr_importer_get_type +GCR_IMPORTER_CLASS +GCR_IS_IMPORTER_CLASS +GCR_IMPORTER_GET_CLASS +</SECTION> + +<SECTION> +<FILE>gcr-simple-certificate</FILE> +GcrSimpleCertificatePrivate +<TITLE>GcrSimpleCertificate</TITLE> +GcrSimpleCertificate +gcr_simple_certificate_new +<SUBSECTION Standard> +GCR_SIMPLE_CERTIFICATE +GCR_IS_SIMPLE_CERTIFICATE +GCR_TYPE_SIMPLE_CERTIFICATE +gcr_simple_certificate_get_type +GCR_SIMPLE_CERTIFICATE_CLASS +GCR_IS_SIMPLE_CERTIFICATE_CLASS +GCR_SIMPLE_CERTIFICATE_GET_CLASS +</SECTION> + +<SECTION> +<FILE>gcr-xxx</FILE> +GcrXxxPrivate +<TITLE>GcrXxx</TITLE> +GcrXxx +gcr_xxx_new +<SUBSECTION Standard> +GCR_XXX +GCR_IS_XXX +GCR_TYPE_XXX +gcr_xxx_get_type +GCR_XXX_CLASS +GCR_IS_XXX_CLASS +GCR_XXX_GET_CLASS +</SECTION> + +<SECTION> +<FILE>gcr-marshal</FILE> +</SECTION> + +<SECTION> +<FILE>gcr-internal</FILE> +</SECTION> + +<SECTION> +<FILE>gcr</FILE> +</SECTION> + +<SECTION> +<FILE>gcr-types</FILE> +GCR_DATA_ERROR +gcr_data_error_get_domain +</SECTION> + +<SECTION> +<FILE>run-auto-test</FILE> +</SECTION> + diff --git a/docs/reference/gcr/gcr.types b/docs/reference/gcr/gcr.types new file mode 100644 index 00000000..e11bc1bd --- /dev/null +++ b/docs/reference/gcr/gcr.types @@ -0,0 +1,6 @@ +gcr_certificate_details_widget_get_type +gcr_certificate_basics_widget_get_type +gcr_parser_get_type +gcr_certificate_get_type +gcr_importer_get_type +gcr_simple_certificate_get_type diff --git a/docs/reference/gnome-keyring/.gitignore b/docs/reference/gnome-keyring/.gitignore new file mode 100644 index 00000000..a769990c --- /dev/null +++ b/docs/reference/gnome-keyring/.gitignore @@ -0,0 +1,27 @@ +Makefile +Makefile.in +.libs + +# Directories created by gtk-doc +tmpl +html +xml + +# Files generated by gtk-doc +*.stamp + +# Reports generated by gtk-doc +*-undeclared.txt +*-undocumented.txt +*-unused.txt + +# Commit these files if you edit them +*-decl-list.txt +*-decl.txt +*-overrides.txt +*.args +*.hierarchy +*.interfaces +*.prerequisites +*.signals + diff --git a/library/reference/Makefile.am b/docs/reference/gnome-keyring/Makefile.am index 04de1c08..0c4890f6 100644 --- a/library/reference/Makefile.am +++ b/docs/reference/gnome-keyring/Makefile.am @@ -1,9 +1,7 @@ ## Process this file with automake to produce Makefile.in -NULL= -all-recursive: all - -# all: tmpl.stamp +# We require automake 1.6 at least. +AUTOMAKE_OPTIONS = 1.6 # This is a blank Makefile.am for using gtk-doc. # Copy this to your project's API docs directory and modify the variables to @@ -13,6 +11,10 @@ all-recursive: all # The name of the module, e.g. 'glib'. DOC_MODULE=gnome-keyring +# Uncomment for versioned docs and specify the version of the module, e.g. '2'. +#DOC_MODULE_VERSION=2 + + # The top-level SGML file. You can change this if you want to. DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml @@ -20,13 +22,13 @@ DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml # gtk-doc will search all .c & .h files beneath here for inline comments # documenting the functions and macros. # e.g. DOC_SOURCE_DIR=../../../gtk -DOC_SOURCE_DIR=../ +DOC_SOURCE_DIR=../../../library # Extra options to pass to gtkdoc-scangobj. Not normally needed. -SCANGOBJ_OPTIONS=--type-init-func="g_type_init()" +SCANGOBJ_OPTIONS= # Extra options to supply to gtkdoc-scan. -# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED" +# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED" SCAN_OPTIONS= # Extra options to supply to gtkdoc-mkdb. @@ -37,6 +39,9 @@ MKDB_OPTIONS=--sgml-mode --output-format=xml # e.g. MKTMPL_OPTIONS=--only-section-tmpl MKTMPL_OPTIONS= +# Extra options to supply to gtkdoc-mkhtml +MKHTML_OPTIONS= + # Extra options to supply to gtkdoc-fixref. Not normally needed. # e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html FIXXREF_OPTIONS= @@ -47,22 +52,21 @@ FIXXREF_OPTIONS= HFILE_GLOB=$(top_srcdir)/library/*.h CFILE_GLOB=$(top_srcdir)/library/*.c -# Header files to ignore when scanning. +# Extra header to include when scanning, which are not under DOC_SOURCE_DIR +# e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h +EXTRA_HFILES= + +# Header files to ignore when scanning. Use base file name, no paths # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h -IGNORE_HFILES=\ - gnome-keyring-private.h \ - gnome-keyring-proto.h \ - $(NULL) +IGNORE_HFILES= # Images to copy into HTML directory. # e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png -HTML_IMAGES=\ - $(NULL) +HTML_IMAGES= # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE). # e.g. content_files=running.sgml building.sgml changes-2.0.sgml -content_files=\ - $(NULL) +content_files= # SGML files where gtk-doc abbrevations (#GtkWidget) are expanded # These files must be listed here *and* in content_files @@ -72,21 +76,24 @@ expand_content_files= # CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library. # Only needed if you are using gtkdoc-scangobj to dynamically query widget # signals and properties. -# e.g. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS) +# e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS) # e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib) -INCLUDES=\ - -I$(top_srcdir) \ - -I$(top_builddir) \ - $(GOBJECT_CFLAGS) \ - $(NULL) -GTKDOC_LIBS=\ - $(top_builddir)/libgnome-keyring.la \ - $(GOBJECT_LIBS) \ - $(NULL) +GTKDOC_CFLAGS= -I$(top_srcdir) -I$(top_builddir) $(GOBJECT_CFLAGS) -Wno-error +GTKDOC_LIBS= $(GOBJECT_LIBS) $(top_srcdir)/library/libgnome-keyring.la # This includes the standard gtk-doc make rules, copied by gtkdocize. include $(top_srcdir)/gtk-doc.make # Other files to distribute # e.g. EXTRA_DIST += version.xml.in -EXTRA_DIST += +EXTRA_DIST += + +# Files not to distribute +# for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types +# for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt +#DISTCLEANFILES += + +# Comment this out if you want your docs-status tested during 'make check' +#TESTS_ENVIRONMENT = cd $(srcsrc) +#TESTS = $(GTKDOC_CHECK) + diff --git a/library/reference/gnome-keyring-docs.sgml b/docs/reference/gnome-keyring/gnome-keyring-docs.sgml index 309308a7..309308a7 100644 --- a/library/reference/gnome-keyring-docs.sgml +++ b/docs/reference/gnome-keyring/gnome-keyring-docs.sgml diff --git a/library/reference/gnome-keyring-sections.txt b/docs/reference/gnome-keyring/gnome-keyring-sections.txt index 0b904ecb..e8e4977e 100644 --- a/library/reference/gnome-keyring-sections.txt +++ b/docs/reference/gnome-keyring/gnome-keyring-sections.txt @@ -180,4 +180,4 @@ GnomeKeyringOperationDoneCallback GnomeKeyringOperationGetIntCallback GnomeKeyringOperationGetListCallback GnomeKeyringOperationGetStringCallback -</SECTION>
\ No newline at end of file +</SECTION> diff --git a/library/reference/gnome-keyring-undeclared.txt b/docs/reference/gnome-keyring/gnome-keyring.types index e69de29b..e69de29b 100644 --- a/library/reference/gnome-keyring-undeclared.txt +++ b/docs/reference/gnome-keyring/gnome-keyring.types diff --git a/docs/reference/gp11/.gitignore b/docs/reference/gp11/.gitignore new file mode 100644 index 00000000..a769990c --- /dev/null +++ b/docs/reference/gp11/.gitignore @@ -0,0 +1,27 @@ +Makefile +Makefile.in +.libs + +# Directories created by gtk-doc +tmpl +html +xml + +# Files generated by gtk-doc +*.stamp + +# Reports generated by gtk-doc +*-undeclared.txt +*-undocumented.txt +*-unused.txt + +# Commit these files if you edit them +*-decl-list.txt +*-decl.txt +*-overrides.txt +*.args +*.hierarchy +*.interfaces +*.prerequisites +*.signals + diff --git a/gp11/reference/Makefile.am b/docs/reference/gp11/Makefile.am index 9372fce2..849adc0e 100644 --- a/gp11/reference/Makefile.am +++ b/docs/reference/gp11/Makefile.am @@ -1,9 +1,7 @@ ## Process this file with automake to produce Makefile.in -NULL= -all-recursive: all - -# all: tmpl.stamp +# We require automake 1.6 at least. +AUTOMAKE_OPTIONS = 1.6 # This is a blank Makefile.am for using gtk-doc. # Copy this to your project's API docs directory and modify the variables to @@ -13,6 +11,10 @@ all-recursive: all # The name of the module, e.g. 'glib'. DOC_MODULE=gp11 +# Uncomment for versioned docs and specify the version of the module, e.g. '2'. +#DOC_MODULE_VERSION=2 + + # The top-level SGML file. You can change this if you want to. DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml @@ -20,13 +22,13 @@ DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml # gtk-doc will search all .c & .h files beneath here for inline comments # documenting the functions and macros. # e.g. DOC_SOURCE_DIR=../../../gtk -DOC_SOURCE_DIR=../ +DOC_SOURCE_DIR=../../../gp11 # Extra options to pass to gtkdoc-scangobj. Not normally needed. -SCANGOBJ_OPTIONS=--type-init-func="g_type_init()" +SCANGOBJ_OPTIONS= # Extra options to supply to gtkdoc-scan. -# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED" +# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED" SCAN_OPTIONS= # Extra options to supply to gtkdoc-mkdb. @@ -37,6 +39,9 @@ MKDB_OPTIONS=--sgml-mode --output-format=xml # e.g. MKTMPL_OPTIONS=--only-section-tmpl MKTMPL_OPTIONS= +# Extra options to supply to gtkdoc-mkhtml +MKHTML_OPTIONS= + # Extra options to supply to gtkdoc-fixref. Not normally needed. # e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html FIXXREF_OPTIONS= @@ -44,26 +49,24 @@ FIXXREF_OPTIONS= # Used for dependencies. The docs will be rebuilt if any of these change. # e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h # e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c -HFILE_GLOB=$(top_srcdir)/gp11/*.h -CFILE_GLOB=$(top_srcdir)/gp11/*.c +HFILE_GLOB=$(top_srcdir)/$(DOC_MODULE)/*.h +CFILE_GLOB=$(top_srcdir)/$(DOC_MODULE)/*.c -# Header files to ignore when scanning. +# Extra header to include when scanning, which are not under DOC_SOURCE_DIR +# e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h +EXTRA_HFILES= + +# Header files to ignore when scanning. Use base file name, no paths # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h -IGNORE_HFILES=\ - gp11-private.h \ - gp11-marshal.h \ - pkcs11.h \ - $(NULL) +IGNORE_HFILES= # Images to copy into HTML directory. # e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png -HTML_IMAGES=\ - $(NULL) +HTML_IMAGES= # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE). # e.g. content_files=running.sgml building.sgml changes-2.0.sgml -content_files=\ - $(NULL) +content_files= # SGML files where gtk-doc abbrevations (#GtkWidget) are expanded # These files must be listed here *and* in content_files @@ -73,24 +76,24 @@ expand_content_files= # CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library. # Only needed if you are using gtkdoc-scangobj to dynamically query widget # signals and properties. -# e.g. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS) +# e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS) # e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib) -INCLUDES=\ - -I$(top_srcdir) \ - -I$(top_builddir) \ - $(GOBJECT_CFLAGS) \ - $(NULL) -GTKDOC_LIBS=\ - $(top_builddir)/gp11/libgp11.la \ - $(GOBJECT_LIBS) \ - $(NULL) - -# gtk-doc has warnings -CFLAGS += "-Wno-error" +GTKDOC_CFLAGS= -I$(top_srcdir) -I$(top_builddir) $(GOBJECT_CFLAGS) -Wno-error +GTKDOC_LIBS= $(GOBJECT_LIBS) $(top_srcdir)/$(DOC_MODULE)/lib$(DOC_MODULE).la # This includes the standard gtk-doc make rules, copied by gtkdocize. include $(top_srcdir)/gtk-doc.make # Other files to distribute # e.g. EXTRA_DIST += version.xml.in -EXTRA_DIST += +EXTRA_DIST += + +# Files not to distribute +# for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types +# for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt +#DISTCLEANFILES += + +# Comment this out if you want your docs-status tested during 'make check' +#TESTS_ENVIRONMENT = cd $(srcsrc) +#TESTS = $(GTKDOC_CHECK) + diff --git a/docs/reference/gp11/gp11-docs.sgml b/docs/reference/gp11/gp11-docs.sgml new file mode 100644 index 00000000..b7ba56b2 --- /dev/null +++ b/docs/reference/gp11/gp11-docs.sgml @@ -0,0 +1,25 @@ +<?xml version="1.0"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" + "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"> +<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude"> + <bookinfo> + <title>GP11 Reference Manual</title> + <releaseinfo> + For GP11 + The latest version of this documentation can be found on-line at + <ulink role="online-location" url="http://library.gnome.org/devel/gp11/unstable/">http://library.gnome.org/devel/gp11/unstable/</ulink>. + </releaseinfo> + </bookinfo> + + <chapter> + <title>PKCS#11 GObject Bindings</title> + <xi:include href="xml/gp11-module.xml"/> + <xi:include href="xml/gp11-slot.xml"/> + <xi:include href="xml/gp11-session.xml"/> + <xi:include href="xml/gp11-object.xml"/> + <xi:include href="xml/gp11-attribute.xml"/> + <xi:include href="xml/gp11-attributes.xml"/> + <xi:include href="xml/gp11-error.xml"/> + <xi:include href="xml/gp11-misc.xml"/> + </chapter> +</book> diff --git a/docs/reference/gp11/gp11-sections.txt b/docs/reference/gp11/gp11-sections.txt new file mode 100644 index 00000000..bdb5fe6e --- /dev/null +++ b/docs/reference/gp11/gp11-sections.txt @@ -0,0 +1,195 @@ +<SECTION> +<FILE>gp11-attribute</FILE> +GP11Attribute +gp11_attribute_init +gp11_attribute_init_invalid +gp11_attribute_init_empty +gp11_attribute_init_boolean +gp11_attribute_init_date +gp11_attribute_init_ulong +gp11_attribute_init_string +gp11_attribute_init_copy +gp11_attribute_new +gp11_attribute_new_invalid +gp11_attribute_new_empty +gp11_attribute_new_boolean +gp11_attribute_new_date +gp11_attribute_new_ulong +gp11_attribute_new_string +gp11_attribute_is_invalid +gp11_attribute_get_boolean +gp11_attribute_get_ulong +gp11_attribute_get_string +gp11_attribute_get_date +gp11_attribute_dup +gp11_attribute_clear +gp11_attribute_free +</SECTION> + +<SECTION> +<FILE>gp11-attributes</FILE> +GP11Attributes +GP11_TYPE_ATTRIBUTES +gp11_attributes_new +gp11_attributes_new_empty +gp11_attributes_newv +gp11_attributes_at +gp11_attributes_add +gp11_attributes_add_data +gp11_attributes_add_invalid +gp11_attributes_add_empty +gp11_attributes_add_boolean +gp11_attributes_add_string +gp11_attributes_add_date +gp11_attributes_add_ulong +gp11_attributes_find +gp11_attributes_find_boolean +gp11_attributes_find_ulong +gp11_attributes_find_string +gp11_attributes_find_date +gp11_attributes_count +gp11_attributes_ref +gp11_attributes_unref +GP11Allocator +GP11_BOOLEAN +GP11_ULONG +GP11_STRING +GP11_DATE +GP11_INVALID +</SECTION> + +<SECTION> +<FILE>gp11-module</FILE> +GP11Module +gp11_module_new +gp11_module_initialize +gp11_module_equal +gp11_module_hash +gp11_module_get_path +gp11_module_get_functions +gp11_module_get_info +gp11_module_get_slots +gp11_module_get_pool_sessions +gp11_module_set_pool_sessions +gp11_module_get_auto_authenticate +gp11_module_set_auto_authenticate +gp11_module_enumerate_objects +GP11ObjectForeachFunc +GP11ModuleInfo +gp11_module_info_free +</SECTION> + +<SECTION> +<FILE>gp11-slot</FILE> +GP11MechanismInfo +gp11_mechanism_info_free +GP11Mechanisms +gp11_mechanisms_length +gp11_mechanisms_at +gp11_mechanisms_free +gp11_mechanisms_check +GP11Slot +gp11_slot_equal +gp11_slot_hash +gp11_slot_get_module +gp11_slot_get_handle +gp11_slot_get_info +gp11_slot_get_token_info +gp11_slot_get_mechanisms +gp11_slot_get_mechanism_info +gp11_slot_has_flags +gp11_slot_open_session +gp11_slot_open_session_full +gp11_slot_open_session_async +gp11_slot_open_session_finish +GP11SlotInfo +gp11_slot_info_free +GP11TokenInfo +gp11_token_info_free +</SECTION> + +<SECTION> +<FILE>gp11-session</FILE> +GP11Session +gp11_session_from_handle +gp11_session_get_module +gp11_session_get_slot +gp11_session_get_handle +gp11_session_get_info +gp11_session_login +gp11_session_login_full +gp11_session_login_async +gp11_session_login_finish +gp11_session_logout +gp11_session_logout_full +gp11_session_logout_async +gp11_session_logout_finish +gp11_session_create_object +gp11_session_create_object_async +gp11_session_create_object_finish +gp11_session_find_objects +gp11_session_find_objects_async +gp11_session_find_objects_finish +gp11_session_encrypt +gp11_session_encrypt_full +gp11_session_encrypt_async +gp11_session_encrypt_finish +gp11_session_decrypt +gp11_session_decrypt_full +gp11_session_decrypt_async +gp11_session_decrypt_finish +gp11_session_sign +gp11_session_sign_full +gp11_session_sign_async +gp11_session_sign_finish +gp11_session_verify +gp11_session_verify_full +gp11_session_verify_async +gp11_session_verify_finish +GP11SessionInfo +gp11_session_info_free +GP11Mechanism +</SECTION> + +<SECTION> +<FILE>gp11-object</FILE> +GP11Object +gp11_object_from_handle +gp11_objects_from_handle_array +gp11_object_equal +gp11_object_hash +gp11_object_get_module +gp11_object_get_slot +gp11_object_get_handle +gp11_object_get_session +gp11_object_set_session +gp11_object_destroy +gp11_object_destroy_full +gp11_object_destroy_async +gp11_object_destroy_finish +gp11_object_set +gp11_object_set_async +gp11_object_set_finish +gp11_object_get +gp11_object_get_async +gp11_object_get_finish +gp11_object_get_data +gp11_object_get_data_full +gp11_object_get_data_async +gp11_object_get_data_finish +</SECTION> + +<SECTION> +<FILE>gp11-error</FILE> +GP11_VENDOR_CODE +GP11_ERROR +gp11_message_from_rv +CKR_GP11_MODULE_PROBLEM +</SECTION> + +<SECTION> +<FILE>gp11-misc</FILE> +gp11_list_ref_copy +gp11_list_unref_free +gp11_string_from_chars +</SECTION> diff --git a/gp11/reference/gp11.types b/docs/reference/gp11/gp11.types index 1c303808..1c303808 100644 --- a/gp11/reference/gp11.types +++ b/docs/reference/gp11/gp11.types diff --git a/gp11/Makefile.am b/gp11/Makefile.am index 65962f39..18942bd9 100644 --- a/gp11/Makefile.am +++ b/gp11/Makefile.am @@ -63,6 +63,5 @@ TESTS_DIR = endif SUBDIRS = . \ - reference \ $(TESTS_DIR)
\ No newline at end of file diff --git a/gp11/gp11-attributes.c b/gp11/gp11-attributes.c index e9101e4d..57793eaa 100644 --- a/gp11/gp11-attributes.c +++ b/gp11/gp11-attributes.c @@ -29,6 +29,24 @@ #include <stdlib.h> #include <string.h> +/** + * SECTION:gp11-attribute + * @title: GP11Attribute + * @short_description: A PKCS11 attribute. + * + * This structure represents a PKCS11 CK_ATTRIBUTE. These attributes contain information + * about a PKCS11 object. Use gp11_object_get() or gp11_object_set() to set and retrieve + * attributes on an object. + */ + +/** + * GP11Attribute: + * @type: The attribute type, such as CKA_LABEL. + * @value: The value of the attribute. May be NULL. + * @length: The length of the attribute. May be G_MAXULONG if the attribute is invalid. + * + * This structure represents a PKCS11 CK_ATTRIBUTE. + */ static void attribute_init (GP11Attribute *attr, gulong attr_type, @@ -611,6 +629,21 @@ gp11_attribute_free (GP11Attribute *attr) } } +/** + * SECTION:gp11-attributes + * @title: GP11Attributes + * @short_description: A set of PKCS11 attributes. + * + * A set of GP11Attribute structures. These attributes contain information + * about a PKCS11 object. Use gp11_object_get() or gp11_object_set() to set and retrieve + * attributes on an object. + */ + +/** + * GP11Attributes: + * + * A set of GP11Attribute structures. + */ struct _GP11Attributes { GArray *array; GP11Allocator allocator; @@ -619,6 +652,49 @@ struct _GP11Attributes { }; /** + * GP11_BOOLEAN: + * The attribute data is a gboolean. Used with variable argument functions. + */ + +/** + * GP11_ULONG: + * The attribute data is a gulong. Used with variable argument functions. + */ + +/** + * GP11_STRING: + * The attribute data is a gchar. Used with variable argument functions. + */ + +/** + * GP11_DATE: + * The attribute data is a GDate. Used with variable argument functions. + */ + +/** + * GP11_DATE: + * Signifies that no more attributes follow. Used with variable argument functions. + */ + +/** + * GP11_ATTRIBUTES_TYPE: + * + * A boxed type that can be used to hold a GP11Attributes object. + */ + +/** + * GP11Allocator: + * @data: Memory to allocate or deallocate. + * @length: New length of memory. + * + * An allocator used to allocate data for the attributes in this GP11Attributes set. + * + * This is a function that acts like g_realloc. Specifically it frees when length is + * set to zero, it allocates when data is set to NULL, and it reallocates when both + * are valid. + */ + +/** * gp11_attributes_get_boxed_type: * * Get the boxed type representing a GP11Attributes array. diff --git a/gp11/gp11-misc.c b/gp11/gp11-misc.c index 4c5a4ff1..5b097f0c 100644 --- a/gp11/gp11-misc.c +++ b/gp11/gp11-misc.c @@ -29,11 +29,34 @@ #include <glib/gi18n.h> /** - * gp11_get_error_quark: + * SECTION:gp11-error + * @title: Errors + * @short_description: GP11 Errors and error codes. * - * The error domain for GP11 library errors. + * GP11 errors are returned as GError structures. The code member of GError + * contains the raw PKCS11 CK_RV result value. + */ + +/** + * GP11_VENDOR_CODE: + * + * Custom PKCS11 errors that originate from the GP11 library, are + * based at this error code. + */ + +/** + * CKR_GP11_MODULE_PROBLEM: + * + * A result code that signifies there was a problem loading a PKCS11 + * module, usually a shared library. + * + * More details can be found in the error string. + */ + +/** + * GP11_ERROR: * - * Return value: The error domain. + * The error domain for GP11 library errors. */ GQuark gp11_get_error_quark (void) @@ -50,45 +73,6 @@ gp11_get_error_quark (void) } /** - * gp11_list_unref_free: - * reflist: List of Gobject reference counted pointers. - * - * Free a list of GObject based pointers. All objects in the list - * will be unreffed and then the list itself will be freed. - */ -void -gp11_list_unref_free (GList *reflist) -{ - GList *l; - for (l = reflist; l; l = g_list_next (l)) { - g_return_if_fail (G_IS_OBJECT (l->data)); - g_object_unref (l->data); - } - g_list_free (reflist); -} - -/** - * gp11_list_ref_copy: - * reflist: List of GObject reference counted objects. - * - * Copy a list of GObject based pointers. All objects - * in the list will be reffed and the list will be copied. - * - * Return value: The copied and reffed list. When done, free it with - * gp11_list_unref_free () - */ -GList* -gp11_list_ref_copy (GList *reflist) -{ - GList *l, *copy = g_list_copy (reflist); - for (l = copy; l; l = g_list_next (l)) { - g_return_val_if_fail (G_IS_OBJECT (l->data), NULL); - g_object_ref (l->data); - } - return copy; -} - -/** * gp11_message_from_rv: * rv: The PKCS#11 return value to get a message for. * @@ -279,7 +263,55 @@ gp11_message_from_rv (CK_RV rv) } /** - * gp11_string_form_chars: + * SECTION:gp11-misc + * @title: Miscellaneous Functions + * @short_description: Other miscellaneous functions. + * + * A few supporting functions that come in handy when dealing with the GP11 + * library or PKCS11 in general. + */ + +/** + * gp11_list_unref_free: + * reflist: List of Gobject reference counted pointers. + * + * Free a list of GObject based pointers. All objects in the list + * will be unreffed and then the list itself will be freed. + */ +void +gp11_list_unref_free (GList *reflist) +{ + GList *l; + for (l = reflist; l; l = g_list_next (l)) { + g_return_if_fail (G_IS_OBJECT (l->data)); + g_object_unref (l->data); + } + g_list_free (reflist); +} + +/** + * gp11_list_ref_copy: + * reflist: List of GObject reference counted objects. + * + * Copy a list of GObject based pointers. All objects + * in the list will be reffed and the list will be copied. + * + * Return value: The copied and reffed list. When done, free it with + * gp11_list_unref_free () + */ +GList* +gp11_list_ref_copy (GList *reflist) +{ + GList *l, *copy = g_list_copy (reflist); + for (l = copy; l; l = g_list_next (l)) { + g_return_val_if_fail (G_IS_OBJECT (l->data), NULL); + g_object_ref (l->data); + } + return copy; +} + +/** + * gp11_string_from_chars: * @data: The character data to turn into a null terminated string. * @max: The maximum length of the charater data. * diff --git a/gp11/gp11-module.c b/gp11/gp11-module.c index 119a8366..359b1b3b 100644 --- a/gp11/gp11-module.c +++ b/gp11/gp11-module.c @@ -29,6 +29,42 @@ #include <string.h> +/** + * SECTION:gp11-module + * @title: GP11Module + * @short_description: A loaded and initialized PKCS#11 module. + * + * A GP11Module object holds a loaded PKCS#11 module. A PKCS#11 module is a shared library. + * + * You can load and initialize a PKCS#11 module with the gp11_module_initialize() call. If you already + * have a loaded and initialized module that you'd like to use with the various GP11 functions, then + * you can use gp11_module_new(). + */ + +/** + * GP11Module: + * + * Holds a loaded and initialized PKCS#11 module. + */ + +/** + * GP11ModuleInfo: + * @pkcs11_version_major: The major version of the module. + * @pkcs11_version_minor: The minor version of the module. + * @manufacturer_id: The module manufacturer. + * @flags: The module PKCS#11 flags. + * @library_description: The module description. + * @library_version_major: The major version of the library. + * @library_version_minor: The minor version of the library. + * + * Holds information about the PKCS#11 module. + * + * This structure corresponds to CK_MODULE_INFO in the PKCS#11 standard. The + * strings are NULL terminated for easier use. + * + * Use gp11_module_info_free() to release this structure when done with it. + */ + /* * MT safe * @@ -543,27 +579,84 @@ gp11_module_class_init (GP11ModuleClass *klass) klass->authenticate_object = gp11_module_real_authenticate_object; klass->authenticate_slot = gp11_module_real_authenticate_slot; + /** + * GP11Module:path: + * + * The PKCS#11 module file path. + * + * This may be set to NULL if this object was created from an already + * initialized module via the gp11_module_new() function. + */ g_object_class_install_property (gobject_class, PROP_PATH, g_param_spec_string ("path", "Module Path", "Path to the PKCS11 Module", NULL, G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY)); + /** + * GP11Module:functions: + * + * The raw PKCS#11 function list for the module. + * + * This points to a CK_FUNCTION_LIST structure. + */ g_object_class_install_property (gobject_class, PROP_FUNCTIONS, g_param_spec_pointer ("functions", "Function List", "PKCS11 Function List", G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY)); + /** + * GP11Module:auto-authenticate: + * + * Whether or not to automatically authenticate token objects that need + * a C_Login call before they can be used. + * + * The #GP11Module::authenticate-object signal will be fired when an + * object needs to be authenticated. + */ g_object_class_install_property (gobject_class, PROP_AUTO_AUTHENTICATE, g_param_spec_int ("auto-authenticate", "Auto Authenticate", "Auto Login to Token when necessary", 0, G_MAXINT, 0, G_PARAM_READWRITE)); + /** + * GP11Module:pool-sessions: + * + * Whether or not to pool PKCS#11 sessions. When this is set, sessions + * will be pooled and reused if their flags match when gp11_slot_open_session() + * is called. + */ g_object_class_install_property (gobject_class, PROP_POOL_SESSIONS, g_param_spec_boolean ("pool-sessions", "Pool Sessions", "Pool sessions?", FALSE, G_PARAM_READWRITE)); - + + /** + * GP11Module::authenticate-slot: + * @module: The module + * @slot: The slot to be authenticated. + * @string: A displayable label which describes the object. + * @password: A gchar** where a password should be returned. + * + * This signal is emitted when a password is needed to authenticate a PKCS#11 + * slot. If the module prompts for passwords itself, then this signal will + * not be emitted. + * + * Returns: FALSE if the user cancelled, TRUE if we should proceed. + */ signals[AUTHENTICATE_SLOT] = g_signal_new ("authenticate-slot", GP11_TYPE_MODULE, G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GP11ModuleClass, authenticate_slot), g_signal_accumulator_true_handled, NULL, _gp11_marshal_BOOLEAN__OBJECT_STRING_POINTER, G_TYPE_BOOLEAN, 3, GP11_TYPE_SLOT, G_TYPE_STRING, G_TYPE_POINTER); + /** + * GP11Module::authenticate-object: + * @module: The module. + * @object: The object to be authenticated. + * @label: A displayable label which describes the object. + * @password: A gchar** where a password should be returned. + * + * This signal is emitted when a password is needed to authenticate a PKCS#11 + * object like a key. If the module prompts for passwords itself, then this signal will + * not be emitted. + * + * Returns: FALSE if the user cancelled, TRUE if we should proceed. + */ signals[AUTHENTICATE_OBJECT] = g_signal_new ("authenticate-object", GP11_TYPE_MODULE, G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GP11ModuleClass, authenticate_object), g_signal_accumulator_true_handled, NULL, _gp11_marshal_BOOLEAN__OBJECT_STRING_POINTER, @@ -1120,3 +1213,16 @@ gp11_module_enumerate_objects_full (GP11Module *self, GP11Attributes *attrs, return ret; } +/** + * GP11ObjectForeachFunc: + * @object: The enumerated object. + * @user_data: Data passed to enumerate function. + * + * This function is passed to gp11_module_enumerate_objects() or a similar function. + * It is called once for each object matched. + * + * The GP11Session through which the object is accessible can be retrieved by calling + * gp11_object_get_session() on object. + * + * Returns: TRUE to continue enumerating, FALSE to stop. + */ diff --git a/gp11/gp11-object.c b/gp11/gp11-object.c index fc2da1de..9952e06f 100644 --- a/gp11/gp11-object.c +++ b/gp11/gp11-object.c @@ -28,6 +28,21 @@ #include <string.h> +/** + * SECTION:gp11-object + * @title: GP11Object + * @short_description: Represents a PKCS11 object such as a key or certificate. + * + * A GP11Object holds a handle to a PKCS11 object such as a key or certificate. Token objects + * are stored on the token persistently. Others are transient and are called session objects. + */ + +/** + * GP11Object: + * + * Represents a PKCS11 object handle such as a key or certifiacte. + */ + /* * MT safe -- Nothing in GP11ObjectData changes between * init and finalize. All GP11ObjectPrivate access between init @@ -235,18 +250,45 @@ gp11_object_class_init (GP11ObjectClass *klass) gobject_class->set_property = gp11_object_set_property; gobject_class->finalize = gp11_object_finalize; + /** + * GP11Object:module: + * + * The GP11Module that this object belongs to. + */ g_object_class_install_property (gobject_class, PROP_MODULE, g_param_spec_object ("module", "Module", "PKCS11 Module", GP11_TYPE_MODULE, G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY)); + /** + * GP11Object:slot: + * + * The GP11Slot that this object belongs to. + * + * If this is a token object then it will be stored on the token in this slot. + * If this is a session object, then it belongs to a session opened on this slot. + */ g_object_class_install_property (gobject_class, PROP_SLOT, g_param_spec_object ("slot", "slot", "PKCS11 Slot", GP11_TYPE_SLOT, G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY)); + /** + * GP11Object:handle: + * + * The raw PKCS11 handle for this object. + */ g_object_class_install_property (gobject_class, PROP_HANDLE, g_param_spec_ulong ("handle", "Object Handle", "PKCS11 Object Handle", 0, G_MAXULONG, 0, G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY)); + /** + * GP11Object:session: + * + * The PKCS11 session to make calls on when this object needs to + * perform operations on itself. + * + * If this is NULL then a new session is opened for each operation, + * such as gp11_object_get(), gp11_object_set() or gp11_object_destroy(). + */ g_object_class_install_property (gobject_class, PROP_SESSION, g_param_spec_object ("session", "session", "PKCS11 Session to make calls on", GP11_TYPE_SESSION, G_PARAM_READWRITE)); diff --git a/gp11/gp11-session.c b/gp11/gp11-session.c index 68a5afe0..452c60d9 100644 --- a/gp11/gp11-session.c +++ b/gp11/gp11-session.c @@ -31,6 +31,30 @@ #include <glib/gi18n.h> +/** + * SECTION:gp11-session + * @title: GP11Session + * @short_description: Represents an open PKCS11 session. + * + * Before performing any PKCS11 operations, a session must be opened. This is + * analogous to an open database handle, or a file handle. + */ + +/** + * GP11Session: + * + * Represents an open PKCS11 session. + */ + +/** + * GP11Mechanism: + * @type: The mechanism type + * @parameter: Mechanism specific data. + * @n_parameter: Length of mechanism specific data. + * + * Represents a mechanism used with crypto operations. + */ + enum { DISCARD_HANDLE, LAST_SIGNAL @@ -248,18 +272,46 @@ gp11_session_class_init (GP11SessionClass *klass) klass->discard_handle = gp11_session_real_discard_handle; + /** + * GP11Session:module: + * + * The GP11Module that this session is opened on. + */ g_object_class_install_property (gobject_class, PROP_MODULE, g_param_spec_object ("module", "Module", "PKCS11 Module", GP11_TYPE_MODULE, G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY)); + /** + * GP11Session:handle: + * + * The raw CK_SESSION_HANDLE handle of this session. + */ g_object_class_install_property (gobject_class, PROP_HANDLE, g_param_spec_ulong ("handle", "Session Handle", "PKCS11 Session Handle", 0, G_MAXULONG, 0, G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY)); + /** + * GP11Session:slot: + * + * The GP11Slot this session is opened on. + */ g_object_class_install_property (gobject_class, PROP_SLOT, g_param_spec_object ("slot", "Slot that this session uses", "PKCS11 Slot", GP11_TYPE_SLOT, G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY)); + /** + * GP11Session::discard-handle: + * @session: The session. + * @handle: The handle being discarded. + * + * When a GP11Session is being disposed of it emits this signal to allow + * a session pool to pick up the handle and keep it around. + * + * If no signal handler claims the handle, then it is closed. This is used by + * gp11_module_set_pool_sessions() to implement the module session pool. + * + * Returns: Whether or not this handle was claimed. + */ signals[DISCARD_HANDLE] = g_signal_new ("discard-handle", GP11_TYPE_SESSION, G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GP11SessionClass, discard_handle), g_signal_accumulator_true_handled, NULL, @@ -273,6 +325,18 @@ gp11_session_class_init (GP11SessionClass *klass) */ /** + * GP11SessionInfo: + * @slot_id: The handle of the PKCS11 slot that this session is opened on. + * @state: The user login state of the session. + * @flags: Various PKCS11 flags. + * @device_error: The last device error that occurred from an operation on this session. + * + * Information about the session. This is analogous to a CK_SESSION_INFO structure. + * + * When done with this structure, release it using gp11_session_info_free(). + */ + +/** * gp11_session_info_free: * @session_info: Session info to free. * @@ -1320,14 +1384,45 @@ crypt_finish (GP11Session *self, GAsyncResult *result, gsize *n_result, GError * * ENCRYPT */ +/** + * gp11_session_encrypt: + * @self: The session. + * @key: The key to encrypt with. + * @mech_type: The mechanism type to use for encryption. + * @input: The data to encrypt. + * @n_input: The length of the data to encrypt. + * @n_result: A location to store the length of the result data. + * @err: A location to place error information. + * + * Encrypt data in a mechanism specific manner. This call may + * block for an indefinite period. + * + * Returns: The data that was encrypted, or NULL if an error occured. + */ guchar* -gp11_session_encrypt (GP11Session *self, GP11Object *key, gulong mech, const guchar *input, +gp11_session_encrypt (GP11Session *self, GP11Object *key, gulong mech_type, const guchar *input, gsize n_input, gsize *n_result, GError **err) { - GP11Mechanism mech_args = { mech, NULL, 0 }; + GP11Mechanism mech_args = { mech_type, NULL, 0 }; return gp11_session_encrypt_full (self, key, &mech_args, input, n_input, n_result, NULL, err); } +/** + * gp11_session_encrypt_full: + * @self: The session. + * @key: The key to encrypt with. + * @mech_args: The mechanism type and parameters to use for encryption. + * @input: The data to encrypt. + * @n_input: The length of the data to encrypt. + * @n_result: A location to store the length of the result data. + * @cancellable: A GCancellable which can be used to cancel the operation. + * @err: A location to place error information. + * + * Encrypt data in a mechanism specific manner. This call may + * block for an indefinite period. + * + * Returns: The data that was encrypted, or NULL if an error occured. + */ guchar* gp11_session_encrypt_full (GP11Session *self, GP11Object *key, GP11Mechanism *mech_args, const guchar *input, gsize n_input, gsize *n_result, @@ -1350,6 +1445,22 @@ gp11_session_encrypt_full (GP11Session *self, GP11Object *key, GP11Mechanism *me return ret; } +/** + * gp11_session_encrypt_async: + * @self: The session. + * @key: The key to encrypt with. + * @mech_args: The mechanism type and parameters to use for encryption. + * @input: The data to encrypt. + * @n_input: The length of the data to encrypt. + * @cancellable: A GCancellable which can be used to cancel the operation. + * @callback: Called when the operation completes. + * @user_data: A pointer to pass to the callback. + * + * Encrypt data in a mechanism specific manner. This call will + * return immediately and complete asynchronously. + * + * Returns: The data that was encrypted. + */ void gp11_session_encrypt_async (GP11Session *self, GP11Object *key, GP11Mechanism *mech_args, const guchar *input, gsize n_input, GCancellable *cancellable, @@ -1370,6 +1481,17 @@ gp11_session_encrypt_async (GP11Session *self, GP11Object *key, GP11Mechanism *m g_object_unref (module); } +/** + * gp11_session_encrypt_finish: + * @self: The session. + * @result: The result object passed to the callback. + * @n_result: A location to store the length of the result data. + * @err: A location to place error information. + * + * Get the result of an encryption operation. + * + * Returns: The data that was encrypted, or NULL if an error occurred. + */ guchar* gp11_session_encrypt_finish (GP11Session *self, GAsyncResult *result, gsize *n_result, GError **err) @@ -1381,6 +1503,21 @@ gp11_session_encrypt_finish (GP11Session *self, GAsyncResult *result, gsize *n_r * DECRYPT */ +/** + * gp11_session_decrypt: + * @self: The session. + * @key: The key to decrypt with. + * @mech_type: The mechanism type to use for decryption. + * @input: The data to decrypt. + * @n_input: The length of the data to decrypt. + * @n_result: A location to store the length of the result data. + * @err: A location to place an error. + * + * Decrypt data in a mechanism specific manner. This call may + * block for an indefinite period. + * + * Returns: The data that was decrypted, or NULL if an error occured. + */ guchar* gp11_session_decrypt (GP11Session *self, GP11Object *key, gulong mech_type, const guchar *input, gsize n_input, gsize *n_result, GError **err) @@ -1389,6 +1526,22 @@ gp11_session_decrypt (GP11Session *self, GP11Object *key, gulong mech_type, cons return gp11_session_decrypt_full (self, key, &mech_args, input, n_input, n_result, NULL, err); } +/** + * gp11_session_decrypt_full: + * @self: The session. + * @key: The key to decrypt with. + * @mech_args: The mechanism type and parameters to use for decryption. + * @input: The data to decrypt. + * @n_input: The length of the data to decrypt. + * @n_result: A location to store the length of the result data. + * @cancellable: A GCancellable which can be used to cancel the operation. + * @err: A location to place error information. + * + * Decrypt data in a mechanism specific manner. This call may + * block for an indefinite period. + * + * Returns: The data that was decrypted, or NULL if an error occured. + */ guchar* gp11_session_decrypt_full (GP11Session *self, GP11Object *key, GP11Mechanism *mech_args, const guchar *input, gsize n_input, gsize *n_result, @@ -1410,6 +1563,22 @@ gp11_session_decrypt_full (GP11Session *self, GP11Object *key, GP11Mechanism *me return ret; } +/** + * gp11_session_decrypt_async: + * @self: The session. + * @key: The key to decrypt with. + * @mech_args: The mechanism type and parameters to use for decryption. + * @input: The data to decrypt. + * @n_input: The length of the data to decrypt. + * @cancellable: A GCancellable which can be used to cancel the operation. + * @callback: Called when the operation completes. + * @user_data: A pointer to pass to the callback. + * + * Decrypt data in a mechanism specific manner. This call will + * return immediately and complete asynchronously. + * + * Returns: The data that was decrypted. + */ void gp11_session_decrypt_async (GP11Session *self, GP11Object *key, GP11Mechanism *mech_args, const guchar *input, gsize n_input, GCancellable *cancellable, @@ -1429,6 +1598,17 @@ gp11_session_decrypt_async (GP11Session *self, GP11Object *key, GP11Mechanism *m g_object_unref (module); } +/** + * gp11_session_decrypt_finish: + * @self: The session. + * @result: The result object passed to the callback. + * @n_result: A location to store the length of the result data. + * @err: A location to place error information. + * + * Get the result of an decryption operation. + * + * Returns: The data that was decrypted, or NULL if an error occurred. + */ guchar* gp11_session_decrypt_finish (GP11Session *self, GAsyncResult *result, gsize *n_result, GError **err) @@ -1440,6 +1620,21 @@ gp11_session_decrypt_finish (GP11Session *self, GAsyncResult *result, * SIGN */ +/** + * gp11_session_sign: + * @self: The session. + * @key: The key to sign with. + * @mech_type: The mechanism type to use for signing. + * @input: The data to sign. + * @n_input: The length of the data to sign. + * @n_result: A location to store the length of the result data. + * @err: A location to place an error. + * + * Sign data in a mechanism specific manner. This call may + * block for an indefinite period. + * + * Returns: The data that was signed, or NULL if an error occured. + */ guchar* gp11_session_sign (GP11Session *self, GP11Object *key, gulong mech_type, const guchar *input, gsize n_input, gsize *n_result, GError **err) @@ -1448,6 +1643,22 @@ gp11_session_sign (GP11Session *self, GP11Object *key, gulong mech_type, const g return gp11_session_sign_full (self, key, &mech_args, input, n_input, n_result, NULL, err); } +/** + * gp11_session_sign_full: + * @self: The session. + * @key: The key to sign with. + * @mech_args: The mechanism type and parameters to use for signing. + * @input: The data to sign. + * @n_input: The length of the data to sign. + * @n_result: A location to store the length of the result data. + * @cancellable: A GCancellable which can be used to cancel the operation. + * @err: A location to place error information. + * + * Sign data in a mechanism specific manner. This call may + * block for an indefinite period. + * + * Returns: The data that was signed, or NULL if an error occured. + */ guchar* gp11_session_sign_full (GP11Session *self, GP11Object *key, GP11Mechanism *mech_args, const guchar *input, gsize n_input, gsize *n_result, @@ -1469,6 +1680,22 @@ gp11_session_sign_full (GP11Session *self, GP11Object *key, GP11Mechanism *mech_ return ret; } +/** + * gp11_session_sign_async: + * @self: The session. + * @key: The key to sign with. + * @mech_args: The mechanism type and parameters to use for signing. + * @input: The data to sign. + * @n_input: The length of the data to sign. + * @cancellable: A GCancellable which can be used to cancel the operation. + * @callback: Called when the operation completes. + * @user_data: A pointer to pass to the callback. + * + * Sign data in a mechanism specific manner. This call will + * return immediately and complete asynchronously. + * + * Returns: The data that was signed. + */ void gp11_session_sign_async (GP11Session *self, GP11Object *key, GP11Mechanism *mech_args, const guchar *input, gsize n_input, GCancellable *cancellable, @@ -1488,6 +1715,17 @@ gp11_session_sign_async (GP11Session *self, GP11Object *key, GP11Mechanism *mech g_object_unref (module); } +/** + * gp11_session_sign_finish: + * @self: The session. + * @result: The result object passed to the callback. + * @n_result: A location to store the length of the result data. + * @err: A location to place error information. + * + * Get the result of an signing operation. + * + * Returns: The data that was signed, or NULL if an error occurred. + */ guchar* gp11_session_sign_finish (GP11Session *self, GAsyncResult *result, gsize *n_result, GError **err) @@ -1553,6 +1791,22 @@ free_verify (Verify *args) g_free (args); } +/** + * gp11_session_verify: + * @self: The session. + * @key: The key to verify with. + * @mech_type: The mechanism type to use for verifying. + * @input: The data to verify. + * @n_input: The length of the data to verify. + * @signature: The signature. + * @n_signature: The length of the signature. + * @err: A location to place an error. + * + * Verify data in a mechanism specific manner. This call may + * block for an indefinite period. + * + * Returns: TRUE if the data verified correctly, otherwise a failure or error occurred. + */ gboolean gp11_session_verify (GP11Session *self, GP11Object *key, gulong mech_type, const guchar *input, gsize n_input, const guchar *signature, gsize n_signature, GError **err) @@ -1562,6 +1816,23 @@ gp11_session_verify (GP11Session *self, GP11Object *key, gulong mech_type, const signature, n_signature, NULL, err); } +/** + * gp11_session_verify_full: + * @self: The session. + * @key: The key to verify with. + * @mech_args: The mechanism type and parameters to use for signing. + * @input: The data to verify. + * @n_input: The length of the data to verify. + * @signature: The signature. + * @n_signature: The length of the signature. + * @cancellable: A GCancellable which can be used to cancel the operation. + * @err: A location to place an error. + * + * Verify data in a mechanism specific manner. This call may + * block for an indefinite period. + * + * Returns: TRUE if the data verified correctly, otherwise a failure or error occurred. + */ gboolean gp11_session_verify_full (GP11Session *self, GP11Object *key, GP11Mechanism *mech_args, const guchar *input, gsize n_input, const guchar *signature, @@ -1594,6 +1865,22 @@ gp11_session_verify_full (GP11Session *self, GP11Object *key, GP11Mechanism *mec return _gp11_call_sync (self, perform_verify, complete_verify, &args, cancellable, err); } +/** + * gp11_session_verify_async: + * @self: The session. + * @key: The key to verify with. + * @mech_args: The mechanism type and parameters to use for signing. + * @input: The data to verify. + * @n_input: The length of the data to verify. + * @signature: The signature. + * @n_signature: The length of the signature. + * @cancellable: A GCancellable which can be used to cancel the operation. + * @callback: Called when the operation completes. + * @user_data: A pointer to pass to the callback. + * + * Verify data in a mechanism specific manner. This call returns + * immediately and completes asynchronously. + */ void gp11_session_verify_async (GP11Session *self, GP11Object *key, GP11Mechanism *mech_args, const guchar *input, gsize n_input, const guchar *signature, @@ -1626,6 +1913,16 @@ gp11_session_verify_async (GP11Session *self, GP11Object *key, GP11Mechanism *me _gp11_call_async_ready_go (args, cancellable, callback, user_data); } +/** + * gp11_session_verify_finish: + * @self: The session. + * @result: The result object passed to the callback. + * @err: A location to place error information. + * + * Get the result of an verify operation. + * + * Returns: TRUE if the data verified correctly, otherwise a failure or error occurred. + */ gboolean gp11_session_verify_finish (GP11Session *self, GAsyncResult *result, GError **err) { diff --git a/gp11/gp11-slot.c b/gp11/gp11-slot.c index 63d6d22c..ed44c484 100644 --- a/gp11/gp11-slot.c +++ b/gp11/gp11-slot.c @@ -28,6 +28,21 @@ #include <string.h> +/** + * SECTION:gp11-slot + * @title: GP11Slot + * @short_description: Represents a PKCS11 slot that can contain a token. + * + * A PKCS11 slot can contain a token. As an example, a slot might be a card reader, and the token + * the card. If the PKCS11 module is not a hardware driver, often the slot and token are equivalent. + */ + +/** + * GP11Slot: + * + * Represents a PKCS11 slot. + */ + enum { PROP_0, PROP_MODULE, @@ -187,10 +202,20 @@ gp11_slot_class_init (GP11SlotClass *klass) gobject_class->dispose = gp11_slot_dispose; gobject_class->finalize = gp11_slot_finalize; + /** + * GP11Slot:module: + * + * The PKCS11 object that this slot is a part of. + */ g_object_class_install_property (gobject_class, PROP_MODULE, g_param_spec_object ("module", "Module", "PKCS11 Module", GP11_TYPE_MODULE, G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY)); + /** + * GP11Slot:handle: + * + * The raw CK_SLOT_ID handle of this slot. + */ g_object_class_install_property (gobject_class, PROP_HANDLE, g_param_spec_ulong ("handle", "Handle", "PKCS11 Slot ID", 0, G_MAXULONG, 0, G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY)); @@ -203,6 +228,25 @@ gp11_slot_class_init (GP11SlotClass *klass) */ /** + * GP11SlotInfo: + * @slot_description: Description of the slot. + * @manufacturer_id: The manufacturer of this slot. + * @flags: Various PKCS11 flags that apply to this slot. + * @hardware_version_major: The major version of the hardware. + * @hardware_version_minor: The minor version of the hardware. + * @firmware_version_major: The major version of the firmware. + * @firmware_version_minor: The minor version of the firmware. + * + * Represents information about a PKCS11 slot. + * + * This is analogous to a CK_SLOT_INFO structure, but the + * strings are far more usable. + * + * When you're done with this structure it should be released with + * gp11_slot_info_free(). + */ + +/** * gp11_slot_info_free: * @slot_info: The slot info to free, or NULL. * @@ -219,6 +263,38 @@ gp11_slot_info_free (GP11SlotInfo *slot_info) } /** + * GP11TokenInfo: + * @label: The displayable token label. + * @manufacturer_id: The manufacturer of this slot. + * @model: The token model number as a string. + * @serial_number: The token serial number as a string. + * @flags: Various PKCS11 flags that apply to this token. + * @max_session_count: The maximum number of sessions allowed on this token. + * @session_count: The number of sessions open on this token. + * @max_rw_session_count: The maximum number of read/write sessions allowed on this token. + * @rw_session_count: The number of sessions open on this token. + * @max_pin_len: The maximum length of a PIN for locking this token. + * @min_pin_len: The minimum length of a PIN for locking this token. + * @total_public_memory: The total amount of memory on this token for storing public objects. + * @free_public_memory: The available amount of memory on this token for storing public objects. + * @total_private_memory: The total amount of memory on this token for storing private objects. + * @free_private_memory: The available amount of memory on this token for storing private objects. + * @hardware_version_major: The major version of the hardware. + * @hardware_version_minor: The minor version of the hardware. + * @firmware_version_major: The major version of the firmware. + * @firmware_version_minor: The minor version of the firmware. + * @utc_time: If the token has a hardware clock, this is set to the number of seconds since the epoch. + * + * Represents information about a PKCS11 token. + * + * This is analogous to a CK_TOKEN_INFO structure, but the + * strings are far more usable. + * + * When you're done with this structure it should be released with + * gp11_token_info_free(). + */ + +/** * gp11_token_info_free: * @token_info: The token info to free, or NULL. * @@ -237,6 +313,20 @@ gp11_token_info_free (GP11TokenInfo *token_info) } /** + * GP11MechanismInfo: + * @min_key_size: The minimum key size that can be used with this mechanism. + * @max_key_size: The maximum key size that can be used with this mechanism. + * @flags: Various PKCS11 flags that apply to this mechanism. + * + * Represents information about a PKCS11 mechanism. + * + * This is analogous to a CK_MECHANISM_INFO structure. + * + * When you're done with this structure it should be released with + * gp11_mechanism_info_free(). + */ + +/** * gp11_mechanism_info_free: * @mech_info: The mechanism info to free, or NULL. * @@ -251,6 +341,38 @@ gp11_mechanism_info_free (GP11MechanismInfo *mech_info) } /** + * GP11Mechanisms: + * + * A set of GP11MechanismInfo structures. + */ + +/** + * gp11_mechanisms_length: + * @a: A GP11Mechanisms set. + * + * Get the number of GP11MechanismInfo in the set. + * + * Returns: The number in the set. + */ + +/** + * gp11_mechanisms_at: + * @a: A GP11Mechanisms set. + * @i: The index of a GP11MechanismInfo. + * + * Get a specific GP11MechanismInfo in a the set. + * + * Returns: The GP11MechanismInfo. + */ + +/** + * gp11_mechanisms_free: + * @a: A GP11Mechanisms set. + * + * Free a GP11Mechanisms set. + */ + +/** * gp11_mechanisms_check: * @mechanisms: A list of mechanisms, perhaps retrieved from gp11_slot_get_mechanisms(). * @@ -608,6 +730,15 @@ gp11_slot_get_mechanism_info (GP11Slot *self, gulong mech_type) return mechinfo; } +/** + * gp11_slot_has_flags: + * @self: The GP11Slot object. + * @flags: The flags to check. + * + * Check if the PKCS11 slot has the given flags. + * + * Returns: Whether one or more flags exist. + */ gboolean gp11_slot_has_flags (GP11Slot *self, gulong flags) { diff --git a/gp11/gp11.h b/gp11/gp11.h index 49209c16..0ae18213 100644 --- a/gp11/gp11.h +++ b/gp11/gp11.h @@ -446,8 +446,6 @@ GP11Module* gp11_slot_get_module (GP11Slot *self); CK_SLOT_ID gp11_slot_get_handle (GP11Slot *self); -gint gp11_slot_get_max_pin_length (GP11Slot *self); - GP11SlotInfo* gp11_slot_get_info (GP11Slot *self); GP11TokenInfo* gp11_slot_get_token_info (GP11Slot *self); @@ -546,8 +544,6 @@ GP11Slot* gp11_session_get_slot (GP11Session *self); CK_SESSION_HANDLE gp11_session_get_handle (GP11Session *self); -CK_SESSION_HANDLE gp11_session_steal_handle (GP11Session *self); - GP11SessionInfo* gp11_session_get_info (GP11Session *self); #if UNIMPLEMENTED @@ -766,7 +762,7 @@ guchar* gp11_session_generate_random_finish (GP11Session *self, guchar* gp11_session_encrypt (GP11Session *self, GP11Object *key, - gulong mech, + gulong mech_type, const guchar *input, gsize n_input, gsize *n_result, diff --git a/gp11/reference/.gitignore b/gp11/reference/.gitignore deleted file mode 100644 index f00506eb..00000000 --- a/gp11/reference/.gitignore +++ /dev/null @@ -1,17 +0,0 @@ -/.* -/*.bak -/Makefile -/Makefile.in -/gp11.args -/gp11.hierarchy -/gp11.interfaces -/gp11.prerequisites -/gp11.signals -/gp11-decl.txt -/gp11-decl-list.txt -/gp11-overrides.txt -/gp11-undocumented.txt -/gp11-unused.txt -/*.stamp -/xml -/html diff --git a/gp11/reference/gp11-docs.sgml b/gp11/reference/gp11-docs.sgml deleted file mode 100644 index 3908b09d..00000000 --- a/gp11/reference/gp11-docs.sgml +++ /dev/null @@ -1,21 +0,0 @@ -<?xml version="1.0"?> -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" - "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"> -<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude"> - <bookinfo> - <title>gp11 Reference Manual</title> - <releaseinfo> - for gp11 [VERSION] - The latest version of this documentation can be found on-line at - <ulink role="online-location" url="http://[SERVER]/gp11/index.html">http://[SERVER]/gp11/</ulink>. - </releaseinfo> - </bookinfo> - - <chapter> - <title>[Insert title here]</title> - <xi:include href="xml/gp11.xml"/> - <xi:include href="xml/gp11-private.xml"/> - <xi:include href="xml/pkcs11.xml"/> - <xi:include href="xml/gp11-test.xml"/> - </chapter> -</book> diff --git a/gp11/reference/gp11-sections.txt b/gp11/reference/gp11-sections.txt deleted file mode 100644 index f2979ac2..00000000 --- a/gp11/reference/gp11-sections.txt +++ /dev/null @@ -1,888 +0,0 @@ -<SECTION> -<FILE>gp11</FILE> -GP11_VENDOR_CODE -CKR_GP11_MODULE_PROBLEM -GP11_ERROR -gp11_get_error_quark -gp11_list_unref_free -gp11_message_from_rv -gp11_string_from_chars -GP11Mechanism -GP11Attribute -GP11_INVALID -gp11_attribute_init -gp11_attribute_init_invalid -gp11_attribute_init_boolean -gp11_attribute_init_date -gp11_attribute_init_ulong -gp11_attribute_init_string -gp11_attribute_init_copy -gp11_attribute_new -gp11_attribute_new_invalid -gp11_attribute_new_boolean -gp11_attribute_new_date -gp11_attribute_new_ulong -gp11_attribute_new_string -gp11_attribute_is_invalid -gp11_attribute_get_boolean -gp11_attribute_get_ulong -gp11_attribute_get_string -gp11_attribute_get_date -gp11_attribute_dup -gp11_attribute_clear -gp11_attribute_free -GP11Attributes -GP11_TYPE_ATTRIBUTES -gp11_attributes_get_boxed_type -gp11_attributes_new -gp11_attributes_newv -gp11_attributes_new_valist -gp11_attributes_set_immutable -gp11_attributes_is_immutable -gp11_attributes_at -gp11_attributes_add -gp11_attributes_add_data -gp11_attributes_add_invalid -gp11_attributes_add_boolean -gp11_attributes_add_string -gp11_attributes_add_date -gp11_attributes_add_ulong -gp11_attributes_find -gp11_attributes_find_boolean -gp11_attributes_find_ulong -gp11_attributes_find_string -gp11_attributes_find_date -gp11_attributes_count -gp11_attributes_ref -gp11_attributes_unref -GP11ModuleInfo -gp11_module_info_free -<TITLE>GP11Module</TITLE> -GP11Module -gp11_module_initialize -gp11_module_get_info -gp11_module_get_slots -GP11SlotInfo -gp11_slot_info_free -GP11TokenInfo -gp11_token_info_free -GP11MechanismInfo -gp11_mechanism_info_free -GP11Mechanisms -gp11_mechanisms_length -gp11_mechanisms_at -gp11_mechanisms_free -GP11_TYPE_SLOT -GP11_SLOT -GP11_SLOT_CLASS -GP11_IS_SLOT -GP11_IS_SLOT_CLASS -GP11_SLOT_GET_CLASS -<TITLE>GP11Slot</TITLE> -GP11Slot -gp11_slot_get_type -gp11_slot_get_handle -gp11_slot_get_reuse_sessions -gp11_slot_set_reuse_sessions -gp11_slot_get_auto_login -gp11_slot_set_auto_login -gp11_slot_get_max_pin_length -gp11_slot_get_info -gp11_slot_get_token_info -gp11_slot_get_mechanisms -gp11_slot_get_mechanism_info -gp11_slot_init_token -gp11_slot_init_token_async -gp11_slot_init_token_finish -gp11_slot_open_session -gp11_slot_open_session_full -gp11_slot_open_session_async -gp11_slot_open_session_finish -GP11SessionInfo -gp11_session_info_free -GP11_TYPE_SESSION -GP11_SESSION -GP11_SESSION_CLASS -GP11_IS_SESSION -GP11_IS_SESSION_CLASS -GP11_SESSION_GET_CLASS -<TITLE>GP11Session</TITLE> -GP11Session -gp11_session_get_type -gp11_session_from_handle -gp11_session_get_handle -gp11_session_get_info -gp11_session_init_pin -gp11_session_init_pin_async -gp11_session_init_pin_finish -gp11_session_set_pin -gp11_session_set_pin_async -gp11_session_set_pin_finish -gp11_session_get_operation_state -gp11_session_get_operation_state_async -gp11_session_get_operation_state_finish -gp11_session_set_operation_state -gp11_session_set_operation_state_async -gp11_session_set_operation_state_finish -gp11_session_login -gp11_session_login_full -gp11_session_login_async -gp11_session_login_finish -gp11_session_logout -gp11_session_logout_full -gp11_session_logout_async -gp11_session_logout_finish -gp11_session_create_object -gp11_session_create_object_full -gp11_session_create_object_async -gp11_session_create_object_finish -gp11_session_find_objects -gp11_session_find_objects_full -gp11_session_find_objects_async -gp11_session_find_objects_finish -gp11_session_generate_key -gp11_session_generate_key_async -gp11_session_generate_key_finish -gp11_session_generate_key_pair -gp11_session_generate_key_pair_async -gp11_session_generate_key_pair_finish -gp11_session_seed_random -gp11_session_seed_random_async -gp11_session_seed_random_finish -gp11_session_generate_random -gp11_session_generate_random_async -gp11_session_generate_random_finish -gp11_session_encrypt -gp11_session_encrypt_full -gp11_session_encrypt_async -gp11_session_encrypt_finish -gp11_session_batch_encrypt -gp11_session_batch_encrypt_async -gp11_session_batch_encrypt_finish -gp11_session_decrypt -gp11_session_decrypt_full -gp11_session_decrypt_async -gp11_session_decrypt_finish -gp11_session_batch_decrypt -gp11_session_batch_decrypt_async -gp11_session_batch_decrypt_finish -gp11_session_digest -gp11_session_digest_full -gp11_session_digest_async -gp11_session_digest_finish -gp11_session_batch_digest -gp11_session_batch_digest_async -gp11_session_batch_digest_finish -gp11_session_batch_digest_encrypt -gp11_session_batch_digest_encrypt_async -gp11_session_batch_digest_encrypt_finish -gp11_session_batch_digest_decrypt -gp11_session_batch_digest_decrypt_async -gp11_session_batch_digest_decrypt_finish -gp11_session_batch_decrypt_verify -gp11_session_batch_decrypt_verify_async -gp11_session_batch_decrypt_verify_finish -gp11_session_sign -gp11_session_sign_full -gp11_session_sign_async -gp11_session_sign_finish -gp11_session_batch_sign -gp11_session_batch_sign_async -gp11_session_batch_sign_finish -gp11_session_batch_sign_encrypt -gp11_session_batch_sign_encrypt_async -gp11_session_batch_sign_encrypt_finish -gp11_session_sign_recover -gp11_session_sign_recover_full -gp11_session_sign_recover_async -gp11_session_sign_recover_finish -gp11_session_verify -gp11_session_verify_full -gp11_session_verify_async -gp11_session_verify_finish -gp11_session_batch_verify -gp11_session_batch_verify_async -gp11_session_batch_verify_finish -gp11_session_verify_recover -gp11_session_verify_recover_full -gp11_session_verify_recover_async -gp11_session_verify_recover_finish -gp11_session_wrap -gp11_session_wrap_async -gp11_session_wrap_finish -gp11_session_unwrap -gp11_session_unwrap_async -gp11_session_unwrap_finish -gp11_session_derive -gp11_session_derive_full -gp11_session_derive_async -gp11_session_derive_finish -GP11_TYPE_OBJECT -GP11_OBJECT -GP11_OBJECT_CLASS -GP11_IS_OBJECT -GP11_IS_OBJECT_CLASS -GP11_OBJECT_GET_CLASS -<TITLE>GP11Object</TITLE> -GP11Object -gp11_object_get_type -gp11_object_from_handle -gp11_objects_from_handle_array -gp11_object_get_handle -gp11_object_copy -gp11_object_copy_full -gp11_object_copy_async -gp11_object_copy_finish -gp11_object_destroy -gp11_object_destroy_full -gp11_object_destroy_async -gp11_object_destroy_finish -gp11_object_get_size -gp11_object_get_size_full -gp11_object_get_size_async -gp11_object_get_size_finish -gp11_object_set -gp11_object_set_full -gp11_object_set_async -gp11_object_set_finish -gp11_object_get -gp11_object_get_full -gp11_object_get_async -gp11_object_get_finish -gp11_object_get_one -gp11_object_get_one_full -gp11_object_get_one_async -gp11_object_get_one_finish -gp11_processor_step -gp11_processor_step_async -gp11_processor_step_finish -gp11_processor_close -gp11_processor_close_async -gp11_processor_close_finish -<SUBSECTION Standard> -GP11_MODULE -GP11_IS_MODULE -GP11_TYPE_MODULE -gp11_module_get_type -GP11_MODULE_CLASS -GP11_IS_MODULE_CLASS -GP11_MODULE_GET_CLASS -</SECTION> - -<SECTION> -<FILE>gp11-private</FILE> -GP11CallFunc -GP11Arguments -GP11_ARGUMENTS_INIT -<TITLE>GP11Call</TITLE> -GP11Call -<SUBSECTION Standard> -GP11_CALL -GP11_IS_CALL -GP11_TYPE_CALL -GP11_CALL_CLASS -GP11_IS_CALL_CLASS -GP11_CALL_GET_CLASS -</SECTION> - -<SECTION> -<FILE>pkcs11</FILE> -CRYPTOKI_VERSION_MAJOR -CRYPTOKI_VERSION_MINOR -CRYPTOKI_VERSION_REVISION -CRYPTOKI_COMPAT -CK_SPEC -ck_flags_t -ck_version -ck_info -cryptoki_version -manufacturer_id -library_description -library_version -ck_notification_t -ck_slot_id_t -ck_slot_info -slot_description -hardware_version -firmware_version -ck_token_info -serial_number -max_session_count -session_count -max_rw_session_count -rw_session_count -max_pin_len -min_pin_len -total_public_memory -free_public_memory -total_private_memory -free_private_memory -utc_time -ck_session_handle_t -ck_user_type_t -ck_state_t -ck_session_info -slot_id -device_error -ck_object_handle_t -ck_object_class_t -ck_hw_feature_type_t -ck_key_type_t -ck_certificate_type_t -ck_attribute_type_t -ck_attribute -value -value_len -ck_date -ck_mechanism_type_t -ck_mechanism -parameter -parameter_len -ck_mechanism_info -min_key_size -max_key_size -ck_rv_t -ck_notify_t -ck_function_list -ck_createmutex_t -ck_destroymutex_t -ck_lockmutex_t -ck_unlockmutex_t -ck_c_initialize_args -create_mutex -destroy_mutex -lock_mutex -unlock_mutex -reserved -CKN_SURRENDER -CKF_TOKEN_PRESENT -CKF_REMOVABLE_DEVICE -CKF_HW_SLOT -CKF_ARRAY_ATTRIBUTE -CKF_RNG -CKF_WRITE_PROTECTED -CKF_LOGIN_REQUIRED -CKF_USER_PIN_INITIALIZED -CKF_RESTORE_KEY_NOT_NEEDED -CKF_CLOCK_ON_TOKEN -CKF_PROTECTED_AUTHENTICATION_PATH -CKF_DUAL_CRYPTO_OPERATIONS -CKF_TOKEN_INITIALIZED -CKF_SECONDARY_AUTHENTICATION -CKF_USER_PIN_COUNT_LOW -CKF_USER_PIN_FINAL_TRY -CKF_USER_PIN_LOCKED -CKF_USER_PIN_TO_BE_CHANGED -CKF_SO_PIN_COUNT_LOW -CKF_SO_PIN_FINAL_TRY -CKF_SO_PIN_LOCKED -CKF_SO_PIN_TO_BE_CHANGED -CK_UNAVAILABLE_INFORMATION -CK_EFFECTIVELY_INFINITE -CK_INVALID_HANDLE -CKU_SO -CKU_USER -CKU_CONTEXT_SPECIFIC -CKS_RO_PUBLIC_SESSION -CKS_RO_USER_FUNCTIONS -CKS_RW_PUBLIC_SESSION -CKS_RW_USER_FUNCTIONS -CKS_RW_SO_FUNCTIONS -CKF_RW_SESSION -CKF_SERIAL_SESSION -CKO_DATA -CKO_CERTIFICATE -CKO_PUBLIC_KEY -CKO_PRIVATE_KEY -CKO_SECRET_KEY -CKO_HW_FEATURE -CKO_DOMAIN_PARAMETERS -CKO_MECHANISM -CKO_VENDOR_DEFINED -CKH_MONOTONIC_COUNTER -CKH_CLOCK -CKH_USER_INTERFACE -CKH_VENDOR_DEFINED -CKK_RSA -CKK_DSA -CKK_DH -CKK_ECDSA -CKK_EC -CKK_X9_42_DH -CKK_KEA -CKK_GENERIC_SECRET -CKK_RC2 -CKK_RC4 -CKK_DES -CKK_DES2 -CKK_DES3 -CKK_CAST -CKK_CAST3 -CKK_CAST128 -CKK_RC5 -CKK_IDEA -CKK_SKIPJACK -CKK_BATON -CKK_JUNIPER -CKK_CDMF -CKK_AES -CKK_BLOWFISH -CKK_TWOFISH -CKK_VENDOR_DEFINED -CKC_X_509 -CKC_X_509_ATTR_CERT -CKC_WTLS -CKC_VENDOR_DEFINED -CKA_CLASS -CKA_TOKEN -CKA_PRIVATE -CKA_LABEL -CKA_APPLICATION -CKA_VALUE -CKA_OBJECT_ID -CKA_CERTIFICATE_TYPE -CKA_ISSUER -CKA_SERIAL_NUMBER -CKA_AC_ISSUER -CKA_OWNER -CKA_ATTR_TYPES -CKA_TRUSTED -CKA_CERTIFICATE_CATEGORY -CKA_JAVA_MIDP_SECURITY_DOMAIN -CKA_URL -CKA_HASH_OF_SUBJECT_PUBLIC_KEY -CKA_HASH_OF_ISSUER_PUBLIC_KEY -CKA_CHECK_VALUE -CKA_KEY_TYPE -CKA_SUBJECT -CKA_ID -CKA_SENSITIVE -CKA_ENCRYPT -CKA_DECRYPT -CKA_WRAP -CKA_UNWRAP -CKA_SIGN -CKA_SIGN_RECOVER -CKA_VERIFY -CKA_VERIFY_RECOVER -CKA_DERIVE -CKA_START_DATE -CKA_END_DATE -CKA_MODULUS -CKA_MODULUS_BITS -CKA_PUBLIC_EXPONENT -CKA_PRIVATE_EXPONENT -CKA_PRIME_1 -CKA_PRIME_2 -CKA_EXPONENT_1 -CKA_EXPONENT_2 -CKA_COEFFICIENT -CKA_PRIME -CKA_SUBPRIME -CKA_BASE -CKA_PRIME_BITS -CKA_SUB_PRIME_BITS -CKA_VALUE_BITS -CKA_VALUE_LEN -CKA_EXTRACTABLE -CKA_LOCAL -CKA_NEVER_EXTRACTABLE -CKA_ALWAYS_SENSITIVE -CKA_KEY_GEN_MECHANISM -CKA_MODIFIABLE -CKA_ECDSA_PARAMS -CKA_EC_PARAMS -CKA_EC_POINT -CKA_SECONDARY_AUTH -CKA_AUTH_PIN_FLAGS -CKA_ALWAYS_AUTHENTICATE -CKA_WRAP_WITH_TRUSTED -CKA_HW_FEATURE_TYPE -CKA_RESET_ON_INIT -CKA_HAS_RESET -CKA_PIXEL_X -CKA_PIXEL_Y -CKA_RESOLUTION -CKA_CHAR_ROWS -CKA_CHAR_COLUMNS -CKA_COLOR -CKA_BITS_PER_PIXEL -CKA_CHAR_SETS -CKA_ENCODING_METHODS -CKA_MIME_TYPES -CKA_MECHANISM_TYPE -CKA_REQUIRED_CMS_ATTRIBUTES -CKA_DEFAULT_CMS_ATTRIBUTES -CKA_SUPPORTED_CMS_ATTRIBUTES -CKA_WRAP_TEMPLATE -CKA_UNWRAP_TEMPLATE -CKA_ALLOWED_MECHANISMS -CKA_VENDOR_DEFINED -CKM_RSA_PKCS_KEY_PAIR_GEN -CKM_RSA_PKCS -CKM_RSA_9796 -CKM_RSA_X_509 -CKM_MD2_RSA_PKCS -CKM_MD5_RSA_PKCS -CKM_SHA1_RSA_PKCS -CKM_RIPEMD128_RSA_PKCS -CKM_RIPEMD160_RSA_PKCS -CKM_RSA_PKCS_OAEP -CKM_RSA_X9_31_KEY_PAIR_GEN -CKM_RSA_X9_31 -CKM_SHA1_RSA_X9_31 -CKM_RSA_PKCS_PSS -CKM_SHA1_RSA_PKCS_PSS -CKM_DSA_KEY_PAIR_GEN -CKM_DSA -CKM_DSA_SHA1 -CKM_DH_PKCS_KEY_PAIR_GEN -CKM_DH_PKCS_DERIVE -CKM_X9_42_DH_KEY_PAIR_GEN -CKM_X9_42_DH_DERIVE -CKM_X9_42_DH_HYBRID_DERIVE -CKM_X9_42_MQV_DERIVE -CKM_SHA256_RSA_PKCS -CKM_SHA384_RSA_PKCS -CKM_SHA512_RSA_PKCS -CKM_SHA256_RSA_PKCS_PSS -CKM_SHA384_RSA_PKCS_PSS -CKM_SHA512_RSA_PKCS_PSS -CKM_RC2_KEY_GEN -CKM_RC2_ECB -CKM_RC2_CBC -CKM_RC2_MAC -CKM_RC2_MAC_GENERAL -CKM_RC2_CBC_PAD -CKM_RC4_KEY_GEN -CKM_RC4 -CKM_DES_KEY_GEN -CKM_DES_ECB -CKM_DES_CBC -CKM_DES_MAC -CKM_DES_MAC_GENERAL -CKM_DES_CBC_PAD -CKM_DES2_KEY_GEN -CKM_DES3_KEY_GEN -CKM_DES3_ECB -CKM_DES3_CBC -CKM_DES3_MAC -CKM_DES3_MAC_GENERAL -CKM_DES3_CBC_PAD -CKM_CDMF_KEY_GEN -CKM_CDMF_ECB -CKM_CDMF_CBC -CKM_CDMF_MAC -CKM_CDMF_MAC_GENERAL -CKM_CDMF_CBC_PAD -CKM_MD2 -CKM_MD2_HMAC -CKM_MD2_HMAC_GENERAL -CKM_MD5 -CKM_MD5_HMAC -CKM_MD5_HMAC_GENERAL -CKM_SHA_1 -CKM_SHA_1_HMAC -CKM_SHA_1_HMAC_GENERAL -CKM_RIPEMD128 -CKM_RIPEMD128_HMAC -CKM_RIPEMD128_HMAC_GENERAL -CKM_RIPEMD160 -CKM_RIPEMD160_HMAC -CKM_RIPEMD160_HMAC_GENERAL -CKM_SHA256 -CKM_SHA256_HMAC -CKM_SHA256_HMAC_GENERAL -CKM_SHA384 -CKM_SHA384_HMAC -CKM_SHA384_HMAC_GENERAL -CKM_SHA512 -CKM_SHA512_HMAC -CKM_SHA512_HMAC_GENERAL -CKM_CAST_KEY_GEN -CKM_CAST_ECB -CKM_CAST_CBC -CKM_CAST_MAC -CKM_CAST_MAC_GENERAL -CKM_CAST_CBC_PAD -CKM_CAST3_KEY_GEN -CKM_CAST3_ECB -CKM_CAST3_CBC -CKM_CAST3_MAC -CKM_CAST3_MAC_GENERAL -CKM_CAST3_CBC_PAD -CKM_CAST5_KEY_GEN -CKM_CAST128_KEY_GEN -CKM_CAST5_ECB -CKM_CAST128_ECB -CKM_CAST5_CBC -CKM_CAST128_CBC -CKM_CAST5_MAC -CKM_CAST128_MAC -CKM_CAST5_MAC_GENERAL -CKM_CAST128_MAC_GENERAL -CKM_CAST5_CBC_PAD -CKM_CAST128_CBC_PAD -CKM_RC5_KEY_GEN -CKM_RC5_ECB -CKM_RC5_CBC -CKM_RC5_MAC -CKM_RC5_MAC_GENERAL -CKM_RC5_CBC_PAD -CKM_IDEA_KEY_GEN -CKM_IDEA_ECB -CKM_IDEA_CBC -CKM_IDEA_MAC -CKM_IDEA_MAC_GENERAL -CKM_IDEA_CBC_PAD -CKM_GENERIC_SECRET_KEY_GEN -CKM_CONCATENATE_BASE_AND_KEY -CKM_CONCATENATE_BASE_AND_DATA -CKM_CONCATENATE_DATA_AND_BASE -CKM_XOR_BASE_AND_DATA -CKM_EXTRACT_KEY_FROM_KEY -CKM_SSL3_PRE_MASTER_KEY_GEN -CKM_SSL3_MASTER_KEY_DERIVE -CKM_SSL3_KEY_AND_MAC_DERIVE -CKM_SSL3_MASTER_KEY_DERIVE_DH -CKM_TLS_PRE_MASTER_KEY_GEN -CKM_TLS_MASTER_KEY_DERIVE -CKM_TLS_KEY_AND_MAC_DERIVE -CKM_TLS_MASTER_KEY_DERIVE_DH -CKM_SSL3_MD5_MAC -CKM_SSL3_SHA1_MAC -CKM_MD5_KEY_DERIVATION -CKM_MD2_KEY_DERIVATION -CKM_SHA1_KEY_DERIVATION -CKM_PBE_MD2_DES_CBC -CKM_PBE_MD5_DES_CBC -CKM_PBE_MD5_CAST_CBC -CKM_PBE_MD5_CAST3_CBC -CKM_PBE_MD5_CAST5_CBC -CKM_PBE_MD5_CAST128_CBC -CKM_PBE_SHA1_CAST5_CBC -CKM_PBE_SHA1_CAST128_CBC -CKM_PBE_SHA1_RC4_128 -CKM_PBE_SHA1_RC4_40 -CKM_PBE_SHA1_DES3_EDE_CBC -CKM_PBE_SHA1_DES2_EDE_CBC -CKM_PBE_SHA1_RC2_128_CBC -CKM_PBE_SHA1_RC2_40_CBC -CKM_PKCS5_PBKD2 -CKM_PBA_SHA1_WITH_SHA1_HMAC -CKM_KEY_WRAP_LYNKS -CKM_KEY_WRAP_SET_OAEP -CKM_SKIPJACK_KEY_GEN -CKM_SKIPJACK_ECB64 -CKM_SKIPJACK_CBC64 -CKM_SKIPJACK_OFB64 -CKM_SKIPJACK_CFB64 -CKM_SKIPJACK_CFB32 -CKM_SKIPJACK_CFB16 -CKM_SKIPJACK_CFB8 -CKM_SKIPJACK_WRAP -CKM_SKIPJACK_PRIVATE_WRAP -CKM_SKIPJACK_RELAYX -CKM_KEA_KEY_PAIR_GEN -CKM_KEA_KEY_DERIVE -CKM_FORTEZZA_TIMESTAMP -CKM_BATON_KEY_GEN -CKM_BATON_ECB128 -CKM_BATON_ECB96 -CKM_BATON_CBC128 -CKM_BATON_COUNTER -CKM_BATON_SHUFFLE -CKM_BATON_WRAP -CKM_ECDSA_KEY_PAIR_GEN -CKM_EC_KEY_PAIR_GEN -CKM_ECDSA -CKM_ECDSA_SHA1 -CKM_ECDH1_DERIVE -CKM_ECDH1_COFACTOR_DERIVE -CKM_ECMQV_DERIVE -CKM_JUNIPER_KEY_GEN -CKM_JUNIPER_ECB128 -CKM_JUNIPER_CBC128 -CKM_JUNIPER_COUNTER -CKM_JUNIPER_SHUFFLE -CKM_JUNIPER_WRAP -CKM_FASTHASH -CKM_AES_KEY_GEN -CKM_AES_ECB -CKM_AES_CBC -CKM_AES_MAC -CKM_AES_MAC_GENERAL -CKM_AES_CBC_PAD -CKM_DSA_PARAMETER_GEN -CKM_DH_PKCS_PARAMETER_GEN -CKM_X9_42_DH_PARAMETER_GEN -CKM_VENDOR_DEFINED -CKF_HW -CKF_ENCRYPT -CKF_DECRYPT -CKF_DIGEST -CKF_SIGN -CKF_SIGN_RECOVER -CKF_VERIFY -CKF_VERIFY_RECOVER -CKF_GENERATE -CKF_GENERATE_KEY_PAIR -CKF_WRAP -CKF_UNWRAP -CKF_DERIVE -CKF_EXTENSION -CKF_DONT_BLOCK -args -CKF_LIBRARY_CANT_CREATE_OS_THREADS -CKF_OS_LOCKING_OK -CKR_OK -CKR_CANCEL -CKR_HOST_MEMORY -CKR_SLOT_ID_INVALID -CKR_GENERAL_ERROR -CKR_FUNCTION_FAILED -CKR_ARGUMENTS_BAD -CKR_NO_EVENT -CKR_NEED_TO_CREATE_THREADS -CKR_CANT_LOCK -CKR_ATTRIBUTE_READ_ONLY -CKR_ATTRIBUTE_SENSITIVE -CKR_ATTRIBUTE_TYPE_INVALID -CKR_ATTRIBUTE_VALUE_INVALID -CKR_DATA_INVALID -CKR_DATA_LEN_RANGE -CKR_DEVICE_ERROR -CKR_DEVICE_MEMORY -CKR_DEVICE_REMOVED -CKR_ENCRYPTED_DATA_INVALID -CKR_ENCRYPTED_DATA_LEN_RANGE -CKR_FUNCTION_CANCELED -CKR_FUNCTION_NOT_PARALLEL -CKR_FUNCTION_NOT_SUPPORTED -CKR_KEY_HANDLE_INVALID -CKR_KEY_SIZE_RANGE -CKR_KEY_TYPE_INCONSISTENT -CKR_KEY_NOT_NEEDED -CKR_KEY_CHANGED -CKR_KEY_NEEDED -CKR_KEY_INDIGESTIBLE -CKR_KEY_FUNCTION_NOT_PERMITTED -CKR_KEY_NOT_WRAPPABLE -CKR_KEY_UNEXTRACTABLE -CKR_MECHANISM_INVALID -CKR_MECHANISM_PARAM_INVALID -CKR_OBJECT_HANDLE_INVALID -CKR_OPERATION_ACTIVE -CKR_OPERATION_NOT_INITIALIZED -CKR_PIN_INCORRECT -CKR_PIN_INVALID -CKR_PIN_LEN_RANGE -CKR_PIN_EXPIRED -CKR_PIN_LOCKED -CKR_SESSION_CLOSED -CKR_SESSION_COUNT -CKR_SESSION_HANDLE_INVALID -CKR_SESSION_PARALLEL_NOT_SUPPORTED -CKR_SESSION_READ_ONLY -CKR_SESSION_EXISTS -CKR_SESSION_READ_ONLY_EXISTS -CKR_SESSION_READ_WRITE_SO_EXISTS -CKR_SIGNATURE_INVALID -CKR_SIGNATURE_LEN_RANGE -CKR_TEMPLATE_INCOMPLETE -CKR_TEMPLATE_INCONSISTENT -CKR_TOKEN_NOT_PRESENT -CKR_TOKEN_NOT_RECOGNIZED -CKR_TOKEN_WRITE_PROTECTED -CKR_UNWRAPPING_KEY_HANDLE_INVALID -CKR_UNWRAPPING_KEY_SIZE_RANGE -CKR_UNWRAPPING_KEY_TYPE_INCONSISTENT -CKR_USER_ALREADY_LOGGED_IN -CKR_USER_NOT_LOGGED_IN -CKR_USER_PIN_NOT_INITIALIZED -CKR_USER_TYPE_INVALID -CKR_USER_ANOTHER_ALREADY_LOGGED_IN -CKR_USER_TOO_MANY_TYPES -CKR_WRAPPED_KEY_INVALID -CKR_WRAPPED_KEY_LEN_RANGE -CKR_WRAPPING_KEY_HANDLE_INVALID -CKR_WRAPPING_KEY_SIZE_RANGE -CKR_WRAPPING_KEY_TYPE_INCONSISTENT -CKR_RANDOM_SEED_NOT_SUPPORTED -CKR_RANDOM_NO_RNG -CKR_DOMAIN_PARAMS_INVALID -CKR_BUFFER_TOO_SMALL -CKR_SAVED_STATE_INVALID -CKR_INFORMATION_SENSITIVE -CKR_STATE_UNSAVEABLE -CKR_CRYPTOKI_NOT_INITIALIZED -CKR_CRYPTOKI_ALREADY_INITIALIZED -CKR_MUTEX_BAD -CKR_MUTEX_NOT_LOCKED -CKR_FUNCTION_REJECTED -CKR_VENDOR_DEFINED -CK_DEFINE_FUNCTION -CK_BYTE -CK_CHAR -CK_UTF8CHAR -CK_BBOOL -CK_ULONG -CK_LONG -CK_BYTE_PTR -CK_CHAR_PTR -CK_UTF8CHAR_PTR -CK_ULONG_PTR -CK_VOID_PTR -CK_VOID_PTR_PTR -CK_FALSE -CK_TRUE -CK_VERSION -CK_VERSION_PTR -CK_INFO -CK_INFO_PTR -CK_SLOT_ID_PTR -CK_SLOT_INFO -CK_SLOT_INFO_PTR -CK_TOKEN_INFO -CK_TOKEN_INFO_PTR -CK_SESSION_HANDLE_PTR -CK_SESSION_INFO -CK_SESSION_INFO_PTR -CK_OBJECT_HANDLE_PTR -CK_OBJECT_CLASS_PTR -CK_ATTRIBUTE -CK_ATTRIBUTE_PTR -CK_DATE -CK_DATE_PTR -CK_MECHANISM_TYPE_PTR -CK_MECHANISM -CK_MECHANISM_PTR -CK_MECHANISM_INFO -CK_MECHANISM_INFO_PTR -CK_FUNCTION_LIST -CK_FUNCTION_LIST_PTR -CK_FUNCTION_LIST_PTR_PTR -CK_C_INITIALIZE_ARGS -CK_C_INITIALIZE_ARGS_PTR -NULL_PTR -</SECTION> - -<SECTION> -<FILE>gp11-marshal</FILE> -</SECTION> - -<SECTION> -<FILE>run-prompt-test</FILE> -</SECTION> - -<SECTION> -<FILE>gp11-test</FILE> -FAIL_RES -SUCCESS_RES -WAIT_UNTIL -</SECTION> - -<SECTION> -<FILE>run-auto-test</FILE> -</SECTION> - diff --git a/gp11/reference/gp11-undeclared.txt b/gp11/reference/gp11-undeclared.txt deleted file mode 100644 index 999caac3..00000000 --- a/gp11/reference/gp11-undeclared.txt +++ /dev/null @@ -1,606 +0,0 @@ -CKA_AC_ISSUER -CKA_ALLOWED_MECHANISMS -CKA_ALWAYS_AUTHENTICATE -CKA_ALWAYS_SENSITIVE -CKA_APPLICATION -CKA_ATTR_TYPES -CKA_AUTH_PIN_FLAGS -CKA_BASE -CKA_BITS_PER_PIXEL -CKA_CERTIFICATE_CATEGORY -CKA_CERTIFICATE_TYPE -CKA_CHAR_COLUMNS -CKA_CHAR_ROWS -CKA_CHAR_SETS -CKA_CHECK_VALUE -CKA_CLASS -CKA_COEFFICIENT -CKA_COLOR -CKA_DECRYPT -CKA_DEFAULT_CMS_ATTRIBUTES -CKA_DERIVE -CKA_ECDSA_PARAMS -CKA_EC_PARAMS -CKA_EC_POINT -CKA_ENCODING_METHODS -CKA_ENCRYPT -CKA_END_DATE -CKA_EXPONENT_1 -CKA_EXPONENT_2 -CKA_EXTRACTABLE -CKA_HASH_OF_ISSUER_PUBLIC_KEY -CKA_HASH_OF_SUBJECT_PUBLIC_KEY -CKA_HAS_RESET -CKA_HW_FEATURE_TYPE -CKA_ID -CKA_ISSUER -CKA_JAVA_MIDP_SECURITY_DOMAIN -CKA_KEY_GEN_MECHANISM -CKA_KEY_TYPE -CKA_LABEL -CKA_LOCAL -CKA_MECHANISM_TYPE -CKA_MIME_TYPES -CKA_MODIFIABLE -CKA_MODULUS -CKA_MODULUS_BITS -CKA_NEVER_EXTRACTABLE -CKA_OBJECT_ID -CKA_OWNER -CKA_PIXEL_X -CKA_PIXEL_Y -CKA_PRIME -CKA_PRIME_1 -CKA_PRIME_2 -CKA_PRIME_BITS -CKA_PRIVATE -CKA_PRIVATE_EXPONENT -CKA_PUBLIC_EXPONENT -CKA_REQUIRED_CMS_ATTRIBUTES -CKA_RESET_ON_INIT -CKA_RESOLUTION -CKA_SECONDARY_AUTH -CKA_SENSITIVE -CKA_SERIAL_NUMBER -CKA_SIGN -CKA_SIGN_RECOVER -CKA_START_DATE -CKA_SUBJECT -CKA_SUBPRIME -CKA_SUB_PRIME_BITS -CKA_SUPPORTED_CMS_ATTRIBUTES -CKA_TOKEN -CKA_TRUSTED -CKA_UNWRAP -CKA_UNWRAP_TEMPLATE -CKA_URL -CKA_VALUE -CKA_VALUE_BITS -CKA_VALUE_LEN -CKA_VENDOR_DEFINED -CKA_VERIFY -CKA_VERIFY_RECOVER -CKA_WRAP -CKA_WRAP_TEMPLATE -CKA_WRAP_WITH_TRUSTED -CKC_VENDOR_DEFINED -CKC_WTLS -CKC_X_509 -CKC_X_509_ATTR_CERT -CKF_ARRAY_ATTRIBUTE -CKF_CLOCK_ON_TOKEN -CKF_DECRYPT -CKF_DERIVE -CKF_DIGEST -CKF_DONT_BLOCK -CKF_DUAL_CRYPTO_OPERATIONS -CKF_ENCRYPT -CKF_EXTENSION -CKF_GENERATE -CKF_GENERATE_KEY_PAIR -CKF_HW -CKF_HW_SLOT -CKF_LIBRARY_CANT_CREATE_OS_THREADS -CKF_LOGIN_REQUIRED -CKF_OS_LOCKING_OK -CKF_PROTECTED_AUTHENTICATION_PATH -CKF_REMOVABLE_DEVICE -CKF_RESTORE_KEY_NOT_NEEDED -CKF_RNG -CKF_RW_SESSION -CKF_SECONDARY_AUTHENTICATION -CKF_SERIAL_SESSION -CKF_SIGN -CKF_SIGN_RECOVER -CKF_SO_PIN_COUNT_LOW -CKF_SO_PIN_FINAL_TRY -CKF_SO_PIN_LOCKED -CKF_SO_PIN_TO_BE_CHANGED -CKF_TOKEN_INITIALIZED -CKF_TOKEN_PRESENT -CKF_UNWRAP -CKF_USER_PIN_COUNT_LOW -CKF_USER_PIN_FINAL_TRY -CKF_USER_PIN_INITIALIZED -CKF_USER_PIN_LOCKED -CKF_USER_PIN_TO_BE_CHANGED -CKF_VERIFY -CKF_VERIFY_RECOVER -CKF_WRAP -CKF_WRITE_PROTECTED -CKH_CLOCK -CKH_MONOTONIC_COUNTER -CKH_USER_INTERFACE -CKH_VENDOR_DEFINED -CKK_AES -CKK_BATON -CKK_BLOWFISH -CKK_CAST -CKK_CAST128 -CKK_CAST3 -CKK_CDMF -CKK_DES -CKK_DES2 -CKK_DES3 -CKK_DH -CKK_DSA -CKK_EC -CKK_ECDSA -CKK_GENERIC_SECRET -CKK_IDEA -CKK_JUNIPER -CKK_KEA -CKK_RC2 -CKK_RC4 -CKK_RC5 -CKK_RSA -CKK_SKIPJACK -CKK_TWOFISH -CKK_VENDOR_DEFINED -CKK_X9_42_DH -CKM_AES_CBC -CKM_AES_CBC_PAD -CKM_AES_ECB -CKM_AES_KEY_GEN -CKM_AES_MAC -CKM_AES_MAC_GENERAL -CKM_BATON_CBC128 -CKM_BATON_COUNTER -CKM_BATON_ECB128 -CKM_BATON_ECB96 -CKM_BATON_KEY_GEN -CKM_BATON_SHUFFLE -CKM_BATON_WRAP -CKM_CAST128_CBC -CKM_CAST128_CBC_PAD -CKM_CAST128_ECB -CKM_CAST128_KEY_GEN -CKM_CAST128_MAC -CKM_CAST128_MAC_GENERAL -CKM_CAST3_CBC -CKM_CAST3_CBC_PAD -CKM_CAST3_ECB -CKM_CAST3_KEY_GEN -CKM_CAST3_MAC -CKM_CAST3_MAC_GENERAL -CKM_CAST5_CBC -CKM_CAST5_CBC_PAD -CKM_CAST5_ECB -CKM_CAST5_KEY_GEN -CKM_CAST5_MAC -CKM_CAST5_MAC_GENERAL -CKM_CAST_CBC -CKM_CAST_CBC_PAD -CKM_CAST_ECB -CKM_CAST_KEY_GEN -CKM_CAST_MAC -CKM_CAST_MAC_GENERAL -CKM_CDMF_CBC -CKM_CDMF_CBC_PAD -CKM_CDMF_ECB -CKM_CDMF_KEY_GEN -CKM_CDMF_MAC -CKM_CDMF_MAC_GENERAL -CKM_CONCATENATE_BASE_AND_DATA -CKM_CONCATENATE_BASE_AND_KEY -CKM_CONCATENATE_DATA_AND_BASE -CKM_DES2_KEY_GEN -CKM_DES3_CBC -CKM_DES3_CBC_PAD -CKM_DES3_ECB -CKM_DES3_KEY_GEN -CKM_DES3_MAC -CKM_DES3_MAC_GENERAL -CKM_DES_CBC -CKM_DES_CBC_PAD -CKM_DES_ECB -CKM_DES_KEY_GEN -CKM_DES_MAC -CKM_DES_MAC_GENERAL -CKM_DH_PKCS_DERIVE -CKM_DH_PKCS_KEY_PAIR_GEN -CKM_DH_PKCS_PARAMETER_GEN -CKM_DSA -CKM_DSA_KEY_PAIR_GEN -CKM_DSA_PARAMETER_GEN -CKM_DSA_SHA1 -CKM_ECDH1_COFACTOR_DERIVE -CKM_ECDH1_DERIVE -CKM_ECDSA -CKM_ECDSA_KEY_PAIR_GEN -CKM_ECDSA_SHA1 -CKM_ECMQV_DERIVE -CKM_EC_KEY_PAIR_GEN -CKM_EXTRACT_KEY_FROM_KEY -CKM_FASTHASH -CKM_FORTEZZA_TIMESTAMP -CKM_GENERIC_SECRET_KEY_GEN -CKM_IDEA_CBC -CKM_IDEA_CBC_PAD -CKM_IDEA_ECB -CKM_IDEA_KEY_GEN -CKM_IDEA_MAC -CKM_IDEA_MAC_GENERAL -CKM_JUNIPER_CBC128 -CKM_JUNIPER_COUNTER -CKM_JUNIPER_ECB128 -CKM_JUNIPER_KEY_GEN -CKM_JUNIPER_SHUFFLE -CKM_JUNIPER_WRAP -CKM_KEA_KEY_DERIVE -CKM_KEA_KEY_PAIR_GEN -CKM_KEY_WRAP_LYNKS -CKM_KEY_WRAP_SET_OAEP -CKM_MD2 -CKM_MD2_HMAC -CKM_MD2_HMAC_GENERAL -CKM_MD2_KEY_DERIVATION -CKM_MD2_RSA_PKCS -CKM_MD5 -CKM_MD5_HMAC -CKM_MD5_HMAC_GENERAL -CKM_MD5_KEY_DERIVATION -CKM_MD5_RSA_PKCS -CKM_PBA_SHA1_WITH_SHA1_HMAC -CKM_PBE_MD2_DES_CBC -CKM_PBE_MD5_CAST128_CBC -CKM_PBE_MD5_CAST3_CBC -CKM_PBE_MD5_CAST5_CBC -CKM_PBE_MD5_CAST_CBC -CKM_PBE_MD5_DES_CBC -CKM_PBE_SHA1_CAST128_CBC -CKM_PBE_SHA1_CAST5_CBC -CKM_PBE_SHA1_DES2_EDE_CBC -CKM_PBE_SHA1_DES3_EDE_CBC -CKM_PBE_SHA1_RC2_128_CBC -CKM_PBE_SHA1_RC2_40_CBC -CKM_PBE_SHA1_RC4_128 -CKM_PBE_SHA1_RC4_40 -CKM_PKCS5_PBKD2 -CKM_RC2_CBC -CKM_RC2_CBC_PAD -CKM_RC2_ECB -CKM_RC2_KEY_GEN -CKM_RC2_MAC -CKM_RC2_MAC_GENERAL -CKM_RC4 -CKM_RC4_KEY_GEN -CKM_RC5_CBC -CKM_RC5_CBC_PAD -CKM_RC5_ECB -CKM_RC5_KEY_GEN -CKM_RC5_MAC -CKM_RC5_MAC_GENERAL -CKM_RIPEMD128 -CKM_RIPEMD128_HMAC -CKM_RIPEMD128_HMAC_GENERAL -CKM_RIPEMD128_RSA_PKCS -CKM_RIPEMD160 -CKM_RIPEMD160_HMAC -CKM_RIPEMD160_HMAC_GENERAL -CKM_RIPEMD160_RSA_PKCS -CKM_RSA_9796 -CKM_RSA_PKCS -CKM_RSA_PKCS_KEY_PAIR_GEN -CKM_RSA_PKCS_OAEP -CKM_RSA_PKCS_PSS -CKM_RSA_X9_31 -CKM_RSA_X9_31_KEY_PAIR_GEN -CKM_RSA_X_509 -CKM_SHA1_KEY_DERIVATION -CKM_SHA1_RSA_PKCS -CKM_SHA1_RSA_PKCS_PSS -CKM_SHA1_RSA_X9_31 -CKM_SHA256 -CKM_SHA256_HMAC -CKM_SHA256_HMAC_GENERAL -CKM_SHA256_RSA_PKCS -CKM_SHA256_RSA_PKCS_PSS -CKM_SHA384 -CKM_SHA384_HMAC -CKM_SHA384_HMAC_GENERAL -CKM_SHA384_RSA_PKCS -CKM_SHA384_RSA_PKCS_PSS -CKM_SHA512 -CKM_SHA512_HMAC -CKM_SHA512_HMAC_GENERAL -CKM_SHA512_RSA_PKCS -CKM_SHA512_RSA_PKCS_PSS -CKM_SHA_1 -CKM_SHA_1_HMAC -CKM_SHA_1_HMAC_GENERAL -CKM_SKIPJACK_CBC64 -CKM_SKIPJACK_CFB16 -CKM_SKIPJACK_CFB32 -CKM_SKIPJACK_CFB64 -CKM_SKIPJACK_CFB8 -CKM_SKIPJACK_ECB64 -CKM_SKIPJACK_KEY_GEN -CKM_SKIPJACK_OFB64 -CKM_SKIPJACK_PRIVATE_WRAP -CKM_SKIPJACK_RELAYX -CKM_SKIPJACK_WRAP -CKM_SSL3_KEY_AND_MAC_DERIVE -CKM_SSL3_MASTER_KEY_DERIVE -CKM_SSL3_MASTER_KEY_DERIVE_DH -CKM_SSL3_MD5_MAC -CKM_SSL3_PRE_MASTER_KEY_GEN -CKM_SSL3_SHA1_MAC -CKM_TLS_KEY_AND_MAC_DERIVE -CKM_TLS_MASTER_KEY_DERIVE -CKM_TLS_MASTER_KEY_DERIVE_DH -CKM_TLS_PRE_MASTER_KEY_GEN -CKM_VENDOR_DEFINED -CKM_X9_42_DH_DERIVE -CKM_X9_42_DH_HYBRID_DERIVE -CKM_X9_42_DH_KEY_PAIR_GEN -CKM_X9_42_DH_PARAMETER_GEN -CKM_X9_42_MQV_DERIVE -CKM_XOR_BASE_AND_DATA -CKN_SURRENDER -CKO_CERTIFICATE -CKO_DATA -CKO_DOMAIN_PARAMETERS -CKO_HW_FEATURE -CKO_MECHANISM -CKO_PRIVATE_KEY -CKO_PUBLIC_KEY -CKO_SECRET_KEY -CKO_VENDOR_DEFINED -CKR_ARGUMENTS_BAD -CKR_ATTRIBUTE_READ_ONLY -CKR_ATTRIBUTE_SENSITIVE -CKR_ATTRIBUTE_TYPE_INVALID -CKR_ATTRIBUTE_VALUE_INVALID -CKR_BUFFER_TOO_SMALL -CKR_CANCEL -CKR_CANT_LOCK -CKR_CRYPTOKI_ALREADY_INITIALIZED -CKR_CRYPTOKI_NOT_INITIALIZED -CKR_DATA_INVALID -CKR_DATA_LEN_RANGE -CKR_DEVICE_ERROR -CKR_DEVICE_MEMORY -CKR_DEVICE_REMOVED -CKR_DOMAIN_PARAMS_INVALID -CKR_ENCRYPTED_DATA_INVALID -CKR_ENCRYPTED_DATA_LEN_RANGE -CKR_FUNCTION_CANCELED -CKR_FUNCTION_FAILED -CKR_FUNCTION_NOT_PARALLEL -CKR_FUNCTION_NOT_SUPPORTED -CKR_FUNCTION_REJECTED -CKR_GENERAL_ERROR -CKR_HOST_MEMORY -CKR_INFORMATION_SENSITIVE -CKR_KEY_CHANGED -CKR_KEY_FUNCTION_NOT_PERMITTED -CKR_KEY_HANDLE_INVALID -CKR_KEY_INDIGESTIBLE -CKR_KEY_NEEDED -CKR_KEY_NOT_NEEDED -CKR_KEY_NOT_WRAPPABLE -CKR_KEY_SIZE_RANGE -CKR_KEY_TYPE_INCONSISTENT -CKR_KEY_UNEXTRACTABLE -CKR_MECHANISM_INVALID -CKR_MECHANISM_PARAM_INVALID -CKR_MUTEX_BAD -CKR_MUTEX_NOT_LOCKED -CKR_NEED_TO_CREATE_THREADS -CKR_NO_EVENT -CKR_OBJECT_HANDLE_INVALID -CKR_OK -CKR_OPERATION_ACTIVE -CKR_OPERATION_NOT_INITIALIZED -CKR_PIN_EXPIRED -CKR_PIN_INCORRECT -CKR_PIN_INVALID -CKR_PIN_LEN_RANGE -CKR_PIN_LOCKED -CKR_RANDOM_NO_RNG -CKR_RANDOM_SEED_NOT_SUPPORTED -CKR_SAVED_STATE_INVALID -CKR_SESSION_CLOSED -CKR_SESSION_COUNT -CKR_SESSION_EXISTS -CKR_SESSION_HANDLE_INVALID -CKR_SESSION_PARALLEL_NOT_SUPPORTED -CKR_SESSION_READ_ONLY -CKR_SESSION_READ_ONLY_EXISTS -CKR_SESSION_READ_WRITE_SO_EXISTS -CKR_SIGNATURE_INVALID -CKR_SIGNATURE_LEN_RANGE -CKR_SLOT_ID_INVALID -CKR_STATE_UNSAVEABLE -CKR_TEMPLATE_INCOMPLETE -CKR_TEMPLATE_INCONSISTENT -CKR_TOKEN_NOT_PRESENT -CKR_TOKEN_NOT_RECOGNIZED -CKR_TOKEN_WRITE_PROTECTED -CKR_UNWRAPPING_KEY_HANDLE_INVALID -CKR_UNWRAPPING_KEY_SIZE_RANGE -CKR_UNWRAPPING_KEY_TYPE_INCONSISTENT -CKR_USER_ALREADY_LOGGED_IN -CKR_USER_ANOTHER_ALREADY_LOGGED_IN -CKR_USER_NOT_LOGGED_IN -CKR_USER_PIN_NOT_INITIALIZED -CKR_USER_TOO_MANY_TYPES -CKR_USER_TYPE_INVALID -CKR_VENDOR_DEFINED -CKR_WRAPPED_KEY_INVALID -CKR_WRAPPED_KEY_LEN_RANGE -CKR_WRAPPING_KEY_HANDLE_INVALID -CKR_WRAPPING_KEY_SIZE_RANGE -CKR_WRAPPING_KEY_TYPE_INCONSISTENT -CKS_RO_PUBLIC_SESSION -CKS_RO_USER_FUNCTIONS -CKS_RW_PUBLIC_SESSION -CKS_RW_SO_FUNCTIONS -CKS_RW_USER_FUNCTIONS -CKU_CONTEXT_SPECIFIC -CKU_SO -CKU_USER -CK_ATTRIBUTE -CK_ATTRIBUTE_PTR -CK_BBOOL -CK_BYTE -CK_BYTE_PTR -CK_CHAR -CK_CHAR_PTR -CK_C_INITIALIZE_ARGS -CK_C_INITIALIZE_ARGS_PTR -CK_DATE -CK_DATE_PTR -CK_DEFINE_FUNCTION -CK_EFFECTIVELY_INFINITE -CK_FALSE -CK_FUNCTION_LIST -CK_FUNCTION_LIST_PTR -CK_FUNCTION_LIST_PTR_PTR -CK_INFO -CK_INFO_PTR -CK_INVALID_HANDLE -CK_LONG -CK_MECHANISM -CK_MECHANISM_INFO -CK_MECHANISM_INFO_PTR -CK_MECHANISM_PTR -CK_MECHANISM_TYPE_PTR -CK_OBJECT_CLASS_PTR -CK_OBJECT_HANDLE_PTR -CK_SESSION_HANDLE_PTR -CK_SESSION_INFO -CK_SESSION_INFO_PTR -CK_SLOT_ID_PTR -CK_SLOT_INFO -CK_SLOT_INFO_PTR -CK_SPEC -CK_TOKEN_INFO -CK_TOKEN_INFO_PTR -CK_TRUE -CK_ULONG -CK_ULONG_PTR -CK_UNAVAILABLE_INFORMATION -CK_UTF8CHAR -CK_UTF8CHAR_PTR -CK_VERSION -CK_VERSION_PTR -CK_VOID_PTR -CK_VOID_PTR_PTR -CRYPTOKI_COMPAT -CRYPTOKI_VERSION_MAJOR -CRYPTOKI_VERSION_MINOR -CRYPTOKI_VERSION_REVISION -GP11Arguments -GP11Call -GP11CallFunc -GP11_ARGUMENTS_INIT -NULL_PTR -args -ck_attribute -ck_attribute_type_t -ck_c_initialize_args -ck_certificate_type_t -ck_createmutex_t -ck_date -ck_destroymutex_t -ck_flags_t -ck_function_list -ck_hw_feature_type_t -ck_info -ck_key_type_t -ck_lockmutex_t -ck_mechanism -ck_mechanism_info -ck_mechanism_type_t -ck_notification_t -ck_notify_t -ck_object_class_t -ck_object_handle_t -ck_rv_t -ck_session_handle_t -ck_session_info -ck_slot_id_t -ck_slot_info -ck_state_t -ck_token_info -ck_unlockmutex_t -ck_user_type_t -ck_version -create_mutex -cryptoki_version -destroy_mutex -device_error -firmware_version -free_private_memory -free_public_memory -gp11_attributes_is_immutable -gp11_attributes_new_valist -gp11_attributes_set_immutable -gp11_object_get_full -gp11_object_get_one -gp11_object_get_one_async -gp11_object_get_one_finish -gp11_object_get_one_full -gp11_object_set_full -gp11_session_create_object_full -gp11_session_derive_async -gp11_session_derive_full -gp11_session_find_objects_full -gp11_session_generate_key_async -gp11_session_generate_key_finish -gp11_session_generate_key_pair -gp11_session_generate_key_pair_async -gp11_session_generate_key_pair_finish -gp11_session_seed_random -gp11_session_unwrap_async -gp11_slot_get_auto_login -gp11_slot_get_reuse_sessions -gp11_slot_set_auto_login -gp11_slot_set_reuse_sessions -hardware_version -library_description -library_version -lock_mutex -manufacturer_id -max_key_size -max_pin_len -max_rw_session_count -max_session_count -min_key_size -min_pin_len -parameter -parameter_len -reserved -rw_session_count -serial_number -session_count -slot_description -slot_id -total_private_memory -total_public_memory -unlock_mutex -utc_time -value -value_len diff --git a/gp11/reference/tmpl/.gitignore b/gp11/reference/tmpl/.gitignore deleted file mode 100644 index 99db6263..00000000 --- a/gp11/reference/tmpl/.gitignore +++ /dev/null @@ -1,7 +0,0 @@ -/*.bak -/gp11-marshal.sgml -/gp11-private.sgml -/gp11-test.sgml -/pkcs11.sgml -/run-auto-test.sgml -/run-prompt-test.sgml diff --git a/gp11/reference/tmpl/gp11-unused.sgml b/gp11/reference/tmpl/gp11-unused.sgml deleted file mode 100644 index a8fc8f59..00000000 --- a/gp11/reference/tmpl/gp11-unused.sgml +++ /dev/null @@ -1,3788 +0,0 @@ -<!-- ##### MACRO CKA_AC_ISSUER ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_ALLOWED_MECHANISMS ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_ALWAYS_AUTHENTICATE ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_ALWAYS_SENSITIVE ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_APPLICATION ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_ATTR_TYPES ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_AUTH_PIN_FLAGS ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_BASE ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_BITS_PER_PIXEL ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_CERTIFICATE_CATEGORY ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_CERTIFICATE_TYPE ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_CHAR_COLUMNS ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_CHAR_ROWS ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_CHAR_SETS ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_CHECK_VALUE ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_CLASS ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_COEFFICIENT ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_COLOR ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_DECRYPT ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_DEFAULT_CMS_ATTRIBUTES ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_DERIVE ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_ECDSA_PARAMS ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_EC_PARAMS ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_EC_POINT ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_ENCODING_METHODS ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_ENCRYPT ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_END_DATE ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_EXPONENT_1 ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_EXPONENT_2 ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_EXTRACTABLE ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_HASH_OF_ISSUER_PUBLIC_KEY ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_HASH_OF_SUBJECT_PUBLIC_KEY ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_HAS_RESET ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_HW_FEATURE_TYPE ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_ID ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_ISSUER ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_JAVA_MIDP_SECURITY_DOMAIN ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_KEY_GEN_MECHANISM ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_KEY_TYPE ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_LABEL ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_LOCAL ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_MECHANISM_TYPE ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_MIME_TYPES ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_MODIFIABLE ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_MODULUS ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_MODULUS_BITS ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_NEVER_EXTRACTABLE ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_OBJECT_ID ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_OWNER ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_PIXEL_X ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_PIXEL_Y ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_PRIME ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_PRIME_1 ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_PRIME_2 ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_PRIME_BITS ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_PRIVATE ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_PRIVATE_EXPONENT ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_PUBLIC_EXPONENT ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_REQUIRED_CMS_ATTRIBUTES ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_RESET_ON_INIT ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_RESOLUTION ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_SECONDARY_AUTH ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_SENSITIVE ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_SERIAL_NUMBER ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_SIGN ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_SIGN_RECOVER ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_START_DATE ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_SUBJECT ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_SUBPRIME ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_SUB_PRIME_BITS ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_SUPPORTED_CMS_ATTRIBUTES ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_TOKEN ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_TRUSTED ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_UNWRAP ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_UNWRAP_TEMPLATE ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_URL ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_VALUE ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_VALUE_BITS ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_VALUE_LEN ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_VENDOR_DEFINED ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_VERIFY ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_VERIFY_RECOVER ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_WRAP ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_WRAP_TEMPLATE ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKA_WRAP_WITH_TRUSTED ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKC_VENDOR_DEFINED ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKC_WTLS ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKC_X_509 ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKC_X_509_ATTR_CERT ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKF_ARRAY_ATTRIBUTE ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKF_CLOCK_ON_TOKEN ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKF_DECRYPT ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKF_DERIVE ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKF_DIGEST ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKF_DONT_BLOCK ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKF_DUAL_CRYPTO_OPERATIONS ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKF_ENCRYPT ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKF_EXTENSION ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKF_GENERATE ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKF_GENERATE_KEY_PAIR ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKF_HW ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKF_HW_SLOT ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKF_LIBRARY_CANT_CREATE_OS_THREADS ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKF_LOGIN_REQUIRED ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKF_OS_LOCKING_OK ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKF_PROTECTED_AUTHENTICATION_PATH ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKF_REMOVABLE_DEVICE ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKF_RESTORE_KEY_NOT_NEEDED ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKF_RNG ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKF_RW_SESSION ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKF_SECONDARY_AUTHENTICATION ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKF_SERIAL_SESSION ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKF_SIGN ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKF_SIGN_RECOVER ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKF_SO_PIN_COUNT_LOW ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKF_SO_PIN_FINAL_TRY ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKF_SO_PIN_LOCKED ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKF_SO_PIN_TO_BE_CHANGED ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKF_TOKEN_INITIALIZED ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKF_TOKEN_PRESENT ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKF_UNWRAP ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKF_USER_PIN_COUNT_LOW ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKF_USER_PIN_FINAL_TRY ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKF_USER_PIN_INITIALIZED ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKF_USER_PIN_LOCKED ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKF_USER_PIN_TO_BE_CHANGED ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKF_VERIFY ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKF_VERIFY_RECOVER ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKF_WRAP ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKF_WRITE_PROTECTED ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKH_CLOCK ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKH_MONOTONIC_COUNTER ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKH_USER_INTERFACE ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKH_VENDOR_DEFINED ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKK_AES ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKK_BATON ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKK_BLOWFISH ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKK_CAST ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKK_CAST128 ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKK_CAST3 ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKK_CDMF ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKK_DES ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKK_DES2 ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKK_DES3 ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKK_DH ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKK_DSA ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKK_EC ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKK_ECDSA ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKK_GENERIC_SECRET ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKK_IDEA ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKK_JUNIPER ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKK_KEA ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKK_RC2 ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKK_RC4 ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKK_RC5 ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKK_RSA ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKK_SKIPJACK ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKK_TWOFISH ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKK_VENDOR_DEFINED ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKK_X9_42_DH ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_AES_CBC ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_AES_CBC_PAD ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_AES_ECB ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_AES_KEY_GEN ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_AES_MAC ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_AES_MAC_GENERAL ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_BATON_CBC128 ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_BATON_COUNTER ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_BATON_ECB128 ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_BATON_ECB96 ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_BATON_KEY_GEN ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_BATON_SHUFFLE ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_BATON_WRAP ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_CAST128_CBC ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_CAST128_CBC_PAD ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_CAST128_ECB ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_CAST128_KEY_GEN ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_CAST128_MAC ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_CAST128_MAC_GENERAL ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_CAST3_CBC ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_CAST3_CBC_PAD ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_CAST3_ECB ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_CAST3_KEY_GEN ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_CAST3_MAC ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_CAST3_MAC_GENERAL ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_CAST5_CBC ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_CAST5_CBC_PAD ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_CAST5_ECB ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_CAST5_KEY_GEN ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_CAST5_MAC ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_CAST5_MAC_GENERAL ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_CAST_CBC ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_CAST_CBC_PAD ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_CAST_ECB ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_CAST_KEY_GEN ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_CAST_MAC ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_CAST_MAC_GENERAL ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_CDMF_CBC ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_CDMF_CBC_PAD ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_CDMF_ECB ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_CDMF_KEY_GEN ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_CDMF_MAC ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_CDMF_MAC_GENERAL ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_CONCATENATE_BASE_AND_DATA ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_CONCATENATE_BASE_AND_KEY ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_CONCATENATE_DATA_AND_BASE ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_DES2_KEY_GEN ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_DES3_CBC ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_DES3_CBC_PAD ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_DES3_ECB ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_DES3_KEY_GEN ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_DES3_MAC ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_DES3_MAC_GENERAL ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_DES_CBC ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_DES_CBC_PAD ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_DES_ECB ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_DES_KEY_GEN ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_DES_MAC ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_DES_MAC_GENERAL ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_DH_PKCS_DERIVE ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_DH_PKCS_KEY_PAIR_GEN ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_DH_PKCS_PARAMETER_GEN ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_DSA ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_DSA_KEY_PAIR_GEN ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_DSA_PARAMETER_GEN ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_DSA_SHA1 ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_ECDH1_COFACTOR_DERIVE ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_ECDH1_DERIVE ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_ECDSA ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_ECDSA_KEY_PAIR_GEN ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_ECDSA_SHA1 ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_ECMQV_DERIVE ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_EC_KEY_PAIR_GEN ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_EXTRACT_KEY_FROM_KEY ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_FASTHASH ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_FORTEZZA_TIMESTAMP ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_GENERIC_SECRET_KEY_GEN ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_IDEA_CBC ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_IDEA_CBC_PAD ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_IDEA_ECB ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_IDEA_KEY_GEN ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_IDEA_MAC ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_IDEA_MAC_GENERAL ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_JUNIPER_CBC128 ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_JUNIPER_COUNTER ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_JUNIPER_ECB128 ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_JUNIPER_KEY_GEN ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_JUNIPER_SHUFFLE ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_JUNIPER_WRAP ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_KEA_KEY_DERIVE ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_KEA_KEY_PAIR_GEN ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_KEY_WRAP_LYNKS ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_KEY_WRAP_SET_OAEP ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_MD2 ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_MD2_HMAC ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_MD2_HMAC_GENERAL ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_MD2_KEY_DERIVATION ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_MD2_RSA_PKCS ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_MD5 ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_MD5_HMAC ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_MD5_HMAC_GENERAL ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_MD5_KEY_DERIVATION ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_MD5_RSA_PKCS ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_PBA_SHA1_WITH_SHA1_HMAC ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_PBE_MD2_DES_CBC ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_PBE_MD5_CAST128_CBC ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_PBE_MD5_CAST3_CBC ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_PBE_MD5_CAST5_CBC ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_PBE_MD5_CAST_CBC ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_PBE_MD5_DES_CBC ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_PBE_SHA1_CAST128_CBC ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_PBE_SHA1_CAST5_CBC ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_PBE_SHA1_DES2_EDE_CBC ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_PBE_SHA1_DES3_EDE_CBC ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_PBE_SHA1_RC2_128_CBC ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_PBE_SHA1_RC2_40_CBC ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_PBE_SHA1_RC4_128 ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_PBE_SHA1_RC4_40 ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_PKCS5_PBKD2 ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_RC2_CBC ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_RC2_CBC_PAD ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_RC2_ECB ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_RC2_KEY_GEN ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_RC2_MAC ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_RC2_MAC_GENERAL ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_RC4 ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_RC4_KEY_GEN ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_RC5_CBC ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_RC5_CBC_PAD ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_RC5_ECB ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_RC5_KEY_GEN ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_RC5_MAC ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_RC5_MAC_GENERAL ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_RIPEMD128 ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_RIPEMD128_HMAC ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_RIPEMD128_HMAC_GENERAL ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_RIPEMD128_RSA_PKCS ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_RIPEMD160 ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_RIPEMD160_HMAC ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_RIPEMD160_HMAC_GENERAL ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_RIPEMD160_RSA_PKCS ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_RSA_9796 ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_RSA_PKCS ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_RSA_PKCS_KEY_PAIR_GEN ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_RSA_PKCS_OAEP ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_RSA_PKCS_PSS ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_RSA_X9_31 ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_RSA_X9_31_KEY_PAIR_GEN ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_RSA_X_509 ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_SHA1_KEY_DERIVATION ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_SHA1_RSA_PKCS ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_SHA1_RSA_PKCS_PSS ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_SHA1_RSA_X9_31 ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_SHA256 ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_SHA256_HMAC ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_SHA256_HMAC_GENERAL ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_SHA256_RSA_PKCS ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_SHA256_RSA_PKCS_PSS ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_SHA384 ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_SHA384_HMAC ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_SHA384_HMAC_GENERAL ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_SHA384_RSA_PKCS ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_SHA384_RSA_PKCS_PSS ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_SHA512 ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_SHA512_HMAC ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_SHA512_HMAC_GENERAL ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_SHA512_RSA_PKCS ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_SHA512_RSA_PKCS_PSS ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_SHA_1 ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_SHA_1_HMAC ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_SHA_1_HMAC_GENERAL ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_SKIPJACK_CBC64 ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_SKIPJACK_CFB16 ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_SKIPJACK_CFB32 ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_SKIPJACK_CFB64 ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_SKIPJACK_CFB8 ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_SKIPJACK_ECB64 ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_SKIPJACK_KEY_GEN ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_SKIPJACK_OFB64 ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_SKIPJACK_PRIVATE_WRAP ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_SKIPJACK_RELAYX ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_SKIPJACK_WRAP ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_SSL3_KEY_AND_MAC_DERIVE ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_SSL3_MASTER_KEY_DERIVE ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_SSL3_MASTER_KEY_DERIVE_DH ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_SSL3_MD5_MAC ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_SSL3_PRE_MASTER_KEY_GEN ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_SSL3_SHA1_MAC ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_TLS_KEY_AND_MAC_DERIVE ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_TLS_MASTER_KEY_DERIVE ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_TLS_MASTER_KEY_DERIVE_DH ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_TLS_PRE_MASTER_KEY_GEN ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_VENDOR_DEFINED ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_X9_42_DH_DERIVE ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_X9_42_DH_HYBRID_DERIVE ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_X9_42_DH_KEY_PAIR_GEN ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_X9_42_DH_PARAMETER_GEN ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_X9_42_MQV_DERIVE ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKM_XOR_BASE_AND_DATA ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKN_SURRENDER ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKO_CERTIFICATE ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKO_DATA ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKO_DOMAIN_PARAMETERS ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKO_HW_FEATURE ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKO_MECHANISM ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKO_PRIVATE_KEY ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKO_PUBLIC_KEY ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKO_SECRET_KEY ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKO_VENDOR_DEFINED ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_ARGUMENTS_BAD ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_ATTRIBUTE_READ_ONLY ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_ATTRIBUTE_SENSITIVE ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_ATTRIBUTE_TYPE_INVALID ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_ATTRIBUTE_VALUE_INVALID ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_BUFFER_TOO_SMALL ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_CANCEL ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_CANT_LOCK ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_CRYPTOKI_ALREADY_INITIALIZED ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_CRYPTOKI_NOT_INITIALIZED ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_DATA_INVALID ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_DATA_LEN_RANGE ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_DEVICE_ERROR ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_DEVICE_MEMORY ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_DEVICE_REMOVED ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_DOMAIN_PARAMS_INVALID ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_ENCRYPTED_DATA_INVALID ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_ENCRYPTED_DATA_LEN_RANGE ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_FUNCTION_CANCELED ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_FUNCTION_FAILED ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_FUNCTION_NOT_PARALLEL ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_FUNCTION_NOT_SUPPORTED ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_FUNCTION_REJECTED ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_GENERAL_ERROR ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_HOST_MEMORY ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_INFORMATION_SENSITIVE ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_KEY_CHANGED ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_KEY_FUNCTION_NOT_PERMITTED ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_KEY_HANDLE_INVALID ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_KEY_INDIGESTIBLE ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_KEY_NEEDED ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_KEY_NOT_NEEDED ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_KEY_NOT_WRAPPABLE ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_KEY_SIZE_RANGE ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_KEY_TYPE_INCONSISTENT ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_KEY_UNEXTRACTABLE ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_MECHANISM_INVALID ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_MECHANISM_PARAM_INVALID ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_MUTEX_BAD ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_MUTEX_NOT_LOCKED ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_NEED_TO_CREATE_THREADS ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_NO_EVENT ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_OBJECT_HANDLE_INVALID ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_OK ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_OPERATION_ACTIVE ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_OPERATION_NOT_INITIALIZED ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_PIN_EXPIRED ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_PIN_INCORRECT ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_PIN_INVALID ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_PIN_LEN_RANGE ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_PIN_LOCKED ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_RANDOM_NO_RNG ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_RANDOM_SEED_NOT_SUPPORTED ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_SAVED_STATE_INVALID ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_SESSION_CLOSED ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_SESSION_COUNT ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_SESSION_EXISTS ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_SESSION_HANDLE_INVALID ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_SESSION_PARALLEL_NOT_SUPPORTED ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_SESSION_READ_ONLY ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_SESSION_READ_ONLY_EXISTS ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_SESSION_READ_WRITE_SO_EXISTS ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_SIGNATURE_INVALID ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_SIGNATURE_LEN_RANGE ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_SLOT_ID_INVALID ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_STATE_UNSAVEABLE ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_TEMPLATE_INCOMPLETE ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_TEMPLATE_INCONSISTENT ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_TOKEN_NOT_PRESENT ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_TOKEN_NOT_RECOGNIZED ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_TOKEN_WRITE_PROTECTED ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_UNWRAPPING_KEY_HANDLE_INVALID ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_UNWRAPPING_KEY_SIZE_RANGE ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_UNWRAPPING_KEY_TYPE_INCONSISTENT ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_USER_ALREADY_LOGGED_IN ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_USER_ANOTHER_ALREADY_LOGGED_IN ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_USER_NOT_LOGGED_IN ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_USER_PIN_NOT_INITIALIZED ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_USER_TOO_MANY_TYPES ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_USER_TYPE_INVALID ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_VENDOR_DEFINED ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_WRAPPED_KEY_INVALID ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_WRAPPED_KEY_LEN_RANGE ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_WRAPPING_KEY_HANDLE_INVALID ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_WRAPPING_KEY_SIZE_RANGE ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKR_WRAPPING_KEY_TYPE_INCONSISTENT ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKS_RO_PUBLIC_SESSION ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKS_RO_USER_FUNCTIONS ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKS_RW_PUBLIC_SESSION ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKS_RW_SO_FUNCTIONS ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKS_RW_USER_FUNCTIONS ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKU_CONTEXT_SPECIFIC ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKU_SO ##### --> -<para> - -</para> - - -<!-- ##### MACRO CKU_USER ##### --> -<para> - -</para> - - -<!-- ##### TYPEDEF CK_ATTRIBUTE ##### --> -<para> - -</para> - - -<!-- ##### TYPEDEF CK_ATTRIBUTE_PTR ##### --> -<para> - -</para> - - -<!-- ##### TYPEDEF CK_BBOOL ##### --> -<para> - -</para> - - -<!-- ##### TYPEDEF CK_BYTE ##### --> -<para> - -</para> - - -<!-- ##### TYPEDEF CK_BYTE_PTR ##### --> -<para> - -</para> - - -<!-- ##### TYPEDEF CK_CHAR ##### --> -<para> - -</para> - - -<!-- ##### TYPEDEF CK_CHAR_PTR ##### --> -<para> - -</para> - - -<!-- ##### TYPEDEF CK_C_INITIALIZE_ARGS ##### --> -<para> - -</para> - - -<!-- ##### TYPEDEF CK_C_INITIALIZE_ARGS_PTR ##### --> -<para> - -</para> - - -<!-- ##### TYPEDEF CK_DATE ##### --> -<para> - -</para> - - -<!-- ##### TYPEDEF CK_DATE_PTR ##### --> -<para> - -</para> - - -<!-- ##### MACRO CK_DEFINE_FUNCTION ##### --> -<para> - -</para> - -@retval: -@name: - -<!-- ##### MACRO CK_EFFECTIVELY_INFINITE ##### --> -<para> - -</para> - - -<!-- ##### MACRO CK_FALSE ##### --> -<para> - -</para> - - -<!-- ##### TYPEDEF CK_FUNCTION_LIST ##### --> -<para> - -</para> - - -<!-- ##### TYPEDEF CK_FUNCTION_LIST_PTR ##### --> -<para> - -</para> - - -<!-- ##### TYPEDEF CK_FUNCTION_LIST_PTR_PTR ##### --> -<para> - -</para> - - -<!-- ##### TYPEDEF CK_INFO ##### --> -<para> - -</para> - - -<!-- ##### TYPEDEF CK_INFO_PTR ##### --> -<para> - -</para> - - -<!-- ##### MACRO CK_INVALID_HANDLE ##### --> -<para> - -</para> - - -<!-- ##### TYPEDEF CK_LONG ##### --> -<para> - -</para> - - -<!-- ##### TYPEDEF CK_MECHANISM ##### --> -<para> - -</para> - - -<!-- ##### TYPEDEF CK_MECHANISM_INFO ##### --> -<para> - -</para> - - -<!-- ##### TYPEDEF CK_MECHANISM_INFO_PTR ##### --> -<para> - -</para> - - -<!-- ##### TYPEDEF CK_MECHANISM_PTR ##### --> -<para> - -</para> - - -<!-- ##### TYPEDEF CK_MECHANISM_TYPE_PTR ##### --> -<para> - -</para> - - -<!-- ##### TYPEDEF CK_OBJECT_CLASS_PTR ##### --> -<para> - -</para> - - -<!-- ##### TYPEDEF CK_OBJECT_HANDLE_PTR ##### --> -<para> - -</para> - - -<!-- ##### TYPEDEF CK_SESSION_HANDLE_PTR ##### --> -<para> - -</para> - - -<!-- ##### TYPEDEF CK_SESSION_INFO ##### --> -<para> - -</para> - - -<!-- ##### TYPEDEF CK_SESSION_INFO_PTR ##### --> -<para> - -</para> - - -<!-- ##### TYPEDEF CK_SLOT_ID_PTR ##### --> -<para> - -</para> - - -<!-- ##### TYPEDEF CK_SLOT_INFO ##### --> -<para> - -</para> - - -<!-- ##### TYPEDEF CK_SLOT_INFO_PTR ##### --> -<para> - -</para> - - -<!-- ##### MACRO CK_SPEC ##### --> -<para> - -</para> - - -<!-- ##### TYPEDEF CK_TOKEN_INFO ##### --> -<para> - -</para> - - -<!-- ##### TYPEDEF CK_TOKEN_INFO_PTR ##### --> -<para> - -</para> - - -<!-- ##### MACRO CK_TRUE ##### --> -<para> - -</para> - - -<!-- ##### TYPEDEF CK_ULONG ##### --> -<para> - -</para> - - -<!-- ##### TYPEDEF CK_ULONG_PTR ##### --> -<para> - -</para> - - -<!-- ##### MACRO CK_UNAVAILABLE_INFORMATION ##### --> -<para> - -</para> - - -<!-- ##### TYPEDEF CK_UTF8CHAR ##### --> -<para> - -</para> - - -<!-- ##### TYPEDEF CK_UTF8CHAR_PTR ##### --> -<para> - -</para> - - -<!-- ##### TYPEDEF CK_VERSION ##### --> -<para> - -</para> - - -<!-- ##### TYPEDEF CK_VERSION_PTR ##### --> -<para> - -</para> - - -<!-- ##### TYPEDEF CK_VOID_PTR ##### --> -<para> - -</para> - - -<!-- ##### TYPEDEF CK_VOID_PTR_PTR ##### --> -<para> - -</para> - - -<!-- ##### MACRO CRYPTOKI_COMPAT ##### --> -<para> - -</para> - - -<!-- ##### MACRO CRYPTOKI_VERSION_MAJOR ##### --> -<para> - -</para> - - -<!-- ##### MACRO CRYPTOKI_VERSION_MINOR ##### --> -<para> - -</para> - - -<!-- ##### MACRO CRYPTOKI_VERSION_REVISION ##### --> -<para> - -</para> - - -<!-- ##### STRUCT GP11Arguments ##### --> -<para> - -</para> - -@call: -@pkcs11: -@handle: - -<!-- ##### STRUCT GP11Call ##### --> -<para> - -</para> - -@parent: -@func: -@args: -@cancellable: -@destroy: -@rv: -@object: -@callback: -@user_data: -@do_login: -@password: - -<!-- ##### USER_FUNCTION GP11CallFunc ##### --> -<para> - -</para> - -@call_data: -@Returns: - -<!-- ##### ARG GP11Module:module-path ##### --> -<para> - -</para> - - -<!-- ##### SIGNAL GP11Slot::authenticate-token ##### --> -<para> - -</para> - -@gp11slot: the object which received the signal. -@arg1: -@Returns: - -<!-- ##### ARG GP11Slot:auto-login ##### --> -<para> - -</para> - - -<!-- ##### ARG GP11Slot:reuse-sessions ##### --> -<para> - -</para> - - -<!-- ##### MACRO GP11_ARGUMENTS_INIT ##### --> -<para> - -</para> - - -<!-- ##### MACRO NULL_PTR ##### --> -<para> - -</para> - - -<!-- ##### TYPEDEF args ##### --> -<para> - -</para> - - -<!-- ##### MACRO ck_attribute ##### --> -<para> - -</para> - - -<!-- ##### MACRO ck_attribute_type_t ##### --> -<para> - -</para> - - -<!-- ##### MACRO ck_c_initialize_args ##### --> -<para> - -</para> - - -<!-- ##### MACRO ck_certificate_type_t ##### --> -<para> - -</para> - - -<!-- ##### MACRO ck_createmutex_t ##### --> -<para> - -</para> - - -<!-- ##### MACRO ck_date ##### --> -<para> - -</para> - - -<!-- ##### MACRO ck_destroymutex_t ##### --> -<para> - -</para> - - -<!-- ##### MACRO ck_flags_t ##### --> -<para> - -</para> - - -<!-- ##### MACRO ck_function_list ##### --> -<para> - -</para> - - -<!-- ##### MACRO ck_hw_feature_type_t ##### --> -<para> - -</para> - - -<!-- ##### MACRO ck_info ##### --> -<para> - -</para> - - -<!-- ##### MACRO ck_key_type_t ##### --> -<para> - -</para> - - -<!-- ##### MACRO ck_lockmutex_t ##### --> -<para> - -</para> - - -<!-- ##### MACRO ck_mechanism ##### --> -<para> - -</para> - - -<!-- ##### MACRO ck_mechanism_info ##### --> -<para> - -</para> - - -<!-- ##### MACRO ck_mechanism_type_t ##### --> -<para> - -</para> - - -<!-- ##### MACRO ck_notification_t ##### --> -<para> - -</para> - - -<!-- ##### MACRO ck_notify_t ##### --> -<para> - -</para> - - -<!-- ##### MACRO ck_object_class_t ##### --> -<para> - -</para> - - -<!-- ##### MACRO ck_object_handle_t ##### --> -<para> - -</para> - - -<!-- ##### MACRO ck_rv_t ##### --> -<para> - -</para> - - -<!-- ##### MACRO ck_session_handle_t ##### --> -<para> - -</para> - - -<!-- ##### MACRO ck_session_info ##### --> -<para> - -</para> - - -<!-- ##### MACRO ck_slot_id_t ##### --> -<para> - -</para> - - -<!-- ##### MACRO ck_slot_info ##### --> -<para> - -</para> - - -<!-- ##### MACRO ck_state_t ##### --> -<para> - -</para> - - -<!-- ##### MACRO ck_token_info ##### --> -<para> - -</para> - - -<!-- ##### MACRO ck_unlockmutex_t ##### --> -<para> - -</para> - - -<!-- ##### MACRO ck_user_type_t ##### --> -<para> - -</para> - - -<!-- ##### MACRO ck_version ##### --> -<para> - -</para> - - -<!-- ##### MACRO create_mutex ##### --> -<para> - -</para> - - -<!-- ##### MACRO cryptoki_version ##### --> -<para> - -</para> - - -<!-- ##### MACRO destroy_mutex ##### --> -<para> - -</para> - - -<!-- ##### MACRO device_error ##### --> -<para> - -</para> - - -<!-- ##### MACRO firmware_version ##### --> -<para> - -</para> - - -<!-- ##### MACRO free_private_memory ##### --> -<para> - -</para> - - -<!-- ##### MACRO free_public_memory ##### --> -<para> - -</para> - - -<!-- ##### FUNCTION gp11_attributes_is_immutable ##### --> -<para> - -</para> - -@attrs: -@Returns: - -<!-- ##### FUNCTION gp11_attributes_new_valist ##### --> -<para> - -</para> - -@allocator: -@va: -@Returns: - -<!-- ##### FUNCTION gp11_attributes_set_immutable ##### --> -<para> - -</para> - -@attrs: - -<!-- ##### FUNCTION gp11_object_get_full ##### --> -<para> - -</para> - -@self: -@attrs: -@cancellable: -@err: -@Returns: - -<!-- ##### FUNCTION gp11_object_get_one ##### --> -<para> - -</para> - -@object: -@attr_type: -@err: -@Returns: - -<!-- ##### FUNCTION gp11_object_get_one_async ##### --> -<para> - -</para> - -@object: -@attr_type: -@cancellable: -@callback: -@user_data: - -<!-- ##### FUNCTION gp11_object_get_one_finish ##### --> -<para> - -</para> - -@object: -@result: -@err: -@Returns: - -<!-- ##### FUNCTION gp11_object_get_one_full ##### --> -<para> - -</para> - -@object: -@attr_type: -@cancellable: -@err: -@Returns: - -<!-- ##### FUNCTION gp11_object_set_full ##### --> -<para> - -</para> - -@self: -@attrs: -@cancellable: -@err: -@Returns: - -<!-- ##### FUNCTION gp11_session_create_object_full ##### --> -<para> - -</para> - -@self: -@attrs: -@cancellable: -@err: -@Returns: - -<!-- ##### FUNCTION gp11_session_derive_async ##### --> -<para> - -</para> - -@self: -@key: -@mech_args: -@cancellable: -@callback: -@user_data: - -<!-- ##### FUNCTION gp11_session_derive_full ##### --> -<para> - -</para> - -@self: -@key: -@mech_args: -@cancellable: -@err: -@Varargs: -@Returns: - -<!-- ##### FUNCTION gp11_session_find_objects_full ##### --> -<para> - -</para> - -@self: -@attrs: -@cancellable: -@err: -@Returns: - -<!-- ##### FUNCTION gp11_session_generate_key_async ##### --> -<para> - -</para> - -@self: -@mechanism: -@callback: -@user_data: -@Varargs: - -<!-- ##### FUNCTION gp11_session_generate_key_finish ##### --> -<para> - -</para> - -@self: -@result: -@err: -@Varargs: -@Returns: - -<!-- ##### FUNCTION gp11_session_generate_key_pair ##### --> -<para> - -</para> - -@self: -@mechanism: -@public_key: -@private_key: -@err: -@Varargs: -@Returns: - -<!-- ##### FUNCTION gp11_session_generate_key_pair_async ##### --> -<para> - -</para> - -@self: -@mechanism: -@callback: -@user_data: -@Varargs: - -<!-- ##### FUNCTION gp11_session_generate_key_pair_finish ##### --> -<para> - -</para> - -@self: -@result: -@public_key: -@private_key: -@err: -@Varargs: -@Returns: - -<!-- ##### FUNCTION gp11_session_seed_random ##### --> -<para> - -</para> - -@self: -@seed: -@n_seed: -@err: -@Returns: - -<!-- ##### FUNCTION gp11_session_unwrap_async ##### --> -<para> - -</para> - -@self: -@key: -@mech_args: -@input: -@n_input: -@cancellable: -@callback: -@user_data: - -<!-- ##### FUNCTION gp11_slot_get_auto_login ##### --> -<para> - -</para> - -@slot: -@Returns: - -<!-- ##### FUNCTION gp11_slot_get_reuse_sessions ##### --> -<para> - -</para> - -@slot: -@Returns: - -<!-- ##### FUNCTION gp11_slot_set_auto_login ##### --> -<para> - -</para> - -@slot: -@auto_login: - -<!-- ##### FUNCTION gp11_slot_set_reuse_sessions ##### --> -<para> - -</para> - -@slot: -@reuse: - -<!-- ##### MACRO hardware_version ##### --> -<para> - -</para> - - -<!-- ##### MACRO library_description ##### --> -<para> - -</para> - - -<!-- ##### MACRO library_version ##### --> -<para> - -</para> - - -<!-- ##### MACRO lock_mutex ##### --> -<para> - -</para> - - -<!-- ##### MACRO manufacturer_id ##### --> -<para> - -</para> - - -<!-- ##### MACRO max_key_size ##### --> -<para> - -</para> - - -<!-- ##### MACRO max_pin_len ##### --> -<para> - -</para> - - -<!-- ##### MACRO max_rw_session_count ##### --> -<para> - -</para> - - -<!-- ##### MACRO max_session_count ##### --> -<para> - -</para> - - -<!-- ##### MACRO min_key_size ##### --> -<para> - -</para> - - -<!-- ##### MACRO min_pin_len ##### --> -<para> - -</para> - - -<!-- ##### MACRO parameter ##### --> -<para> - -</para> - - -<!-- ##### MACRO parameter_len ##### --> -<para> - -</para> - - -<!-- ##### MACRO reserved ##### --> -<para> - -</para> - - -<!-- ##### MACRO rw_session_count ##### --> -<para> - -</para> - - -<!-- ##### MACRO serial_number ##### --> -<para> - -</para> - - -<!-- ##### MACRO session_count ##### --> -<para> - -</para> - - -<!-- ##### MACRO slot_description ##### --> -<para> - -</para> - - -<!-- ##### MACRO slot_id ##### --> -<para> - -</para> - - -<!-- ##### MACRO total_private_memory ##### --> -<para> - -</para> - - -<!-- ##### MACRO total_public_memory ##### --> -<para> - -</para> - - -<!-- ##### MACRO unlock_mutex ##### --> -<para> - -</para> - - -<!-- ##### MACRO utc_time ##### --> -<para> - -</para> - - -<!-- ##### MACRO value ##### --> -<para> - -</para> - - -<!-- ##### MACRO value_len ##### --> -<para> - -</para> - - diff --git a/gp11/reference/tmpl/gp11.sgml b/gp11/reference/tmpl/gp11.sgml deleted file mode 100644 index d2f6d92c..00000000 --- a/gp11/reference/tmpl/gp11.sgml +++ /dev/null @@ -1,2626 +0,0 @@ -<!-- ##### SECTION Title ##### --> -GP11Object - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### MACRO GP11_VENDOR_CODE ##### --> -<para> - -</para> - - - -<!-- ##### MACRO CKR_GP11_MODULE_PROBLEM ##### --> -<para> - -</para> - - - -<!-- ##### MACRO GP11_ERROR ##### --> -<para> - -</para> - - - -<!-- ##### FUNCTION gp11_get_error_quark ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION gp11_list_unref_free ##### --> -<para> - -</para> - -@reflist: - - -<!-- ##### FUNCTION gp11_message_from_rv ##### --> -<para> - -</para> - -@rv: -@Returns: - - -<!-- ##### FUNCTION gp11_string_from_chars ##### --> -<para> - -</para> - -@data: -@max: -@Returns: - - -<!-- ##### STRUCT GP11Mechanism ##### --> -<para> - -</para> - -@type: -@parameter: -@n_parameter: - -<!-- ##### STRUCT GP11Attribute ##### --> -<para> - -</para> - -@type: -@value: -@length: - -<!-- ##### MACRO GP11_INVALID ##### --> -<para> - -</para> - - - -<!-- ##### FUNCTION gp11_attribute_init ##### --> -<para> - -</para> - -@attr: -@attr_type: -@value: -@length: - - -<!-- ##### FUNCTION gp11_attribute_init_invalid ##### --> -<para> - -</para> - -@attr: -@attr_type: - - -<!-- ##### FUNCTION gp11_attribute_init_boolean ##### --> -<para> - -</para> - -@attr: -@attr_type: -@value: - - -<!-- ##### FUNCTION gp11_attribute_init_date ##### --> -<para> - -</para> - -@attr: -@attr_type: -@value: - - -<!-- ##### FUNCTION gp11_attribute_init_ulong ##### --> -<para> - -</para> - -@attr: -@attr_type: -@value: - - -<!-- ##### FUNCTION gp11_attribute_init_string ##### --> -<para> - -</para> - -@attr: -@attr_type: -@value: - - -<!-- ##### FUNCTION gp11_attribute_init_copy ##### --> -<para> - -</para> - -@dest: -@src: - - -<!-- ##### FUNCTION gp11_attribute_new ##### --> -<para> - -</para> - -@attr_type: -@value: -@length: -@Returns: - - -<!-- ##### FUNCTION gp11_attribute_new_invalid ##### --> -<para> - -</para> - -@attr_type: -@Returns: - - -<!-- ##### FUNCTION gp11_attribute_new_boolean ##### --> -<para> - -</para> - -@attr_type: -@value: -@Returns: - - -<!-- ##### FUNCTION gp11_attribute_new_date ##### --> -<para> - -</para> - -@attr_type: -@value: -@Returns: - - -<!-- ##### FUNCTION gp11_attribute_new_ulong ##### --> -<para> - -</para> - -@attr_type: -@value: -@Returns: - - -<!-- ##### FUNCTION gp11_attribute_new_string ##### --> -<para> - -</para> - -@attr_type: -@value: -@Returns: - - -<!-- ##### FUNCTION gp11_attribute_is_invalid ##### --> -<para> - -</para> - -@attr: -@Returns: - - -<!-- ##### FUNCTION gp11_attribute_get_boolean ##### --> -<para> - -</para> - -@attr: -@Returns: - - -<!-- ##### FUNCTION gp11_attribute_get_ulong ##### --> -<para> - -</para> - -@attr: -@Returns: - - -<!-- ##### FUNCTION gp11_attribute_get_string ##### --> -<para> - -</para> - -@attr: -@Returns: - - -<!-- ##### FUNCTION gp11_attribute_get_date ##### --> -<para> - -</para> - -@attr: -@value: - - -<!-- ##### FUNCTION gp11_attribute_dup ##### --> -<para> - -</para> - -@attr: -@Returns: - - -<!-- ##### FUNCTION gp11_attribute_clear ##### --> -<para> - -</para> - -@attr: - - -<!-- ##### FUNCTION gp11_attribute_free ##### --> -<para> - -</para> - -@attr: - - -<!-- ##### STRUCT GP11Attributes ##### --> -<para> - -</para> - - -<!-- ##### MACRO GP11_TYPE_ATTRIBUTES ##### --> -<para> - -</para> - - - -<!-- ##### FUNCTION gp11_attributes_get_boxed_type ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION gp11_attributes_new ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION gp11_attributes_newv ##### --> -<para> - -</para> - -@attr_type: -@Returns: - - -<!-- ##### FUNCTION gp11_attributes_at ##### --> -<para> - -</para> - -@attrs: -@index: -@Returns: - - -<!-- ##### FUNCTION gp11_attributes_add ##### --> -<para> - -</para> - -@attrs: -@attr: - - -<!-- ##### FUNCTION gp11_attributes_add_data ##### --> -<para> - -</para> - -@attrs: -@attr_type: -@value: -@length: - - -<!-- ##### FUNCTION gp11_attributes_add_invalid ##### --> -<para> - -</para> - -@attrs: -@attr_type: - - -<!-- ##### FUNCTION gp11_attributes_add_boolean ##### --> -<para> - -</para> - -@attrs: -@attr_type: -@value: - - -<!-- ##### FUNCTION gp11_attributes_add_string ##### --> -<para> - -</para> - -@attrs: -@attr_type: -@string: - - -<!-- ##### FUNCTION gp11_attributes_add_date ##### --> -<para> - -</para> - -@attrs: -@attr_type: -@date: - - -<!-- ##### FUNCTION gp11_attributes_add_ulong ##### --> -<para> - -</para> - -@attrs: -@attr_type: -@value: - - -<!-- ##### FUNCTION gp11_attributes_find ##### --> -<para> - -</para> - -@attrs: -@attr_type: -@Returns: - - -<!-- ##### FUNCTION gp11_attributes_find_boolean ##### --> -<para> - -</para> - -@attrs: -@attr_type: -@value: -@Returns: - - -<!-- ##### FUNCTION gp11_attributes_find_ulong ##### --> -<para> - -</para> - -@attrs: -@attr_type: -@value: -@Returns: - - -<!-- ##### FUNCTION gp11_attributes_find_string ##### --> -<para> - -</para> - -@attrs: -@attr_type: -@value: -@Returns: - - -<!-- ##### FUNCTION gp11_attributes_find_date ##### --> -<para> - -</para> - -@attrs: -@attr_type: -@value: -@Returns: - - -<!-- ##### FUNCTION gp11_attributes_count ##### --> -<para> - -</para> - -@attrs: -@Returns: - - -<!-- ##### FUNCTION gp11_attributes_ref ##### --> -<para> - -</para> - -@attrs: -@Returns: - - -<!-- ##### FUNCTION gp11_attributes_unref ##### --> -<para> - -</para> - -@attrs: - - -<!-- ##### STRUCT GP11ModuleInfo ##### --> -<para> - -</para> - -@pkcs11_version_major: -@pkcs11_version_minor: -@manufacturer_id: -@flags: -@library_description: -@library_version_major: -@library_version_minor: - -<!-- ##### FUNCTION gp11_module_info_free ##### --> -<para> - -</para> - -@module_info: - - -<!-- ##### STRUCT GP11Module ##### --> -<para> - -</para> - - -<!-- ##### SIGNAL GP11Module::authenticate-object ##### --> -<para> - -</para> - -@gp11module: the object which received the signal. -@arg1: -@arg2: -@arg3: -@Returns: - -<!-- ##### SIGNAL GP11Module::authenticate-slot ##### --> -<para> - -</para> - -@gp11module: the object which received the signal. -@arg1: -@arg2: -@arg3: -@Returns: - -<!-- ##### ARG GP11Module:auto-authenticate ##### --> -<para> - -</para> - -<!-- ##### ARG GP11Module:functions ##### --> -<para> - -</para> - -<!-- ##### ARG GP11Module:path ##### --> -<para> - -</para> - -<!-- ##### ARG GP11Module:pool-sessions ##### --> -<para> - -</para> - -<!-- ##### FUNCTION gp11_module_initialize ##### --> -<para> - -</para> - -@path: -@reserved: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_module_get_info ##### --> -<para> - -</para> - -@self: -@Returns: - - -<!-- ##### FUNCTION gp11_module_get_slots ##### --> -<para> - -</para> - -@self: -@token_present: -@Returns: - - -<!-- ##### STRUCT GP11SlotInfo ##### --> -<para> - -</para> - -@slot_description: -@manufacturer_id: -@flags: -@hardware_version_major: -@hardware_version_minor: -@firmware_version_major: -@firmware_version_minor: - -<!-- ##### FUNCTION gp11_slot_info_free ##### --> -<para> - -</para> - -@slot_info: - - -<!-- ##### STRUCT GP11TokenInfo ##### --> -<para> - -</para> - -@label: -@manufacturer_id: -@model: -@serial_number: -@flags: -@max_session_count: -@session_count: -@max_rw_session_count: -@rw_session_count: -@max_pin_len: -@min_pin_len: -@total_public_memory: -@free_public_memory: -@total_private_memory: -@free_private_memory: -@hardware_version_major: -@hardware_version_minor: -@firmware_version_major: -@firmware_version_minor: -@utc_time: - -<!-- ##### FUNCTION gp11_token_info_free ##### --> -<para> - -</para> - -@token_info: - - -<!-- ##### STRUCT GP11MechanismInfo ##### --> -<para> - -</para> - -@min_key_size: -@max_key_size: -@flags: - -<!-- ##### FUNCTION gp11_mechanism_info_free ##### --> -<para> - -</para> - -@mech_info: - - -<!-- ##### TYPEDEF GP11Mechanisms ##### --> -<para> - -</para> - - -<!-- ##### MACRO gp11_mechanisms_length ##### --> -<para> - -</para> - -@a: - - -<!-- ##### MACRO gp11_mechanisms_at ##### --> -<para> - -</para> - -@a: -@i: - - -<!-- ##### MACRO gp11_mechanisms_free ##### --> -<para> - -</para> - -@a: - - -<!-- ##### MACRO GP11_TYPE_SLOT ##### --> -<para> - -</para> - - - -<!-- ##### MACRO GP11_SLOT ##### --> -<para> - -</para> - -@obj: - - -<!-- ##### MACRO GP11_SLOT_CLASS ##### --> -<para> - -</para> - -@klass: - - -<!-- ##### MACRO GP11_IS_SLOT ##### --> -<para> - -</para> - -@obj: - - -<!-- ##### MACRO GP11_IS_SLOT_CLASS ##### --> -<para> - -</para> - -@klass: - - -<!-- ##### MACRO GP11_SLOT_GET_CLASS ##### --> -<para> - -</para> - -@obj: - - -<!-- ##### STRUCT GP11Slot ##### --> -<para> - -</para> - - -<!-- ##### ARG GP11Slot:handle ##### --> -<para> - -</para> - -<!-- ##### ARG GP11Slot:module ##### --> -<para> - -</para> - -<!-- ##### FUNCTION gp11_slot_get_type ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION gp11_slot_get_handle ##### --> -<para> - -</para> - -@self: -@Returns: - - -<!-- ##### FUNCTION gp11_slot_get_max_pin_length ##### --> -<para> - -</para> - -@self: -@Returns: - - -<!-- ##### FUNCTION gp11_slot_get_info ##### --> -<para> - -</para> - -@self: -@Returns: - - -<!-- ##### FUNCTION gp11_slot_get_token_info ##### --> -<para> - -</para> - -@self: -@Returns: - - -<!-- ##### FUNCTION gp11_slot_get_mechanisms ##### --> -<para> - -</para> - -@self: -@Returns: - - -<!-- ##### FUNCTION gp11_slot_get_mechanism_info ##### --> -<para> - -</para> - -@self: -@mech_type: -@Returns: - - -<!-- ##### FUNCTION gp11_slot_init_token ##### --> -<para> - -</para> - -@self: -@pin: -@length: -@label: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_slot_init_token_async ##### --> -<para> - -</para> - -@self: -@pin: -@length: -@label: -@callback: -@user_data: - - -<!-- ##### FUNCTION gp11_slot_init_token_finish ##### --> -<para> - -</para> - -@self: -@result: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_slot_open_session ##### --> -<para> - -</para> - -@self: -@flags: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_slot_open_session_full ##### --> -<para> - -</para> - -@self: -@flags: -@cancellable: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_slot_open_session_async ##### --> -<para> - -</para> - -@self: -@flags: -@cancellable: -@callback: -@user_data: - - -<!-- ##### FUNCTION gp11_slot_open_session_finish ##### --> -<para> - -</para> - -@self: -@result: -@err: -@Returns: - - -<!-- ##### STRUCT GP11SessionInfo ##### --> -<para> - -</para> - -@slot_id: -@state: -@flags: -@device_error: - -<!-- ##### FUNCTION gp11_session_info_free ##### --> -<para> - -</para> - -@session_info: - - -<!-- ##### MACRO GP11_TYPE_SESSION ##### --> -<para> - -</para> - - - -<!-- ##### MACRO GP11_SESSION ##### --> -<para> - -</para> - -@obj: - - -<!-- ##### MACRO GP11_SESSION_CLASS ##### --> -<para> - -</para> - -@klass: - - -<!-- ##### MACRO GP11_IS_SESSION ##### --> -<para> - -</para> - -@obj: - - -<!-- ##### MACRO GP11_IS_SESSION_CLASS ##### --> -<para> - -</para> - -@klass: - - -<!-- ##### MACRO GP11_SESSION_GET_CLASS ##### --> -<para> - -</para> - -@obj: - - -<!-- ##### STRUCT GP11Session ##### --> -<para> - -</para> - - -<!-- ##### SIGNAL GP11Session::discard-handle ##### --> -<para> - -</para> - -@gp11session: the object which received the signal. -@Param2: -@Returns: - -<!-- ##### ARG GP11Session:handle ##### --> -<para> - -</para> - -<!-- ##### ARG GP11Session:module ##### --> -<para> - -</para> - -<!-- ##### ARG GP11Session:slot ##### --> -<para> - -</para> - -<!-- ##### FUNCTION gp11_session_get_type ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION gp11_session_from_handle ##### --> -<para> - -</para> - -@slot: -@handle: -@Returns: - - -<!-- ##### FUNCTION gp11_session_get_handle ##### --> -<para> - -</para> - -@self: -@Returns: - - -<!-- ##### FUNCTION gp11_session_get_info ##### --> -<para> - -</para> - -@self: -@Returns: - - -<!-- ##### FUNCTION gp11_session_init_pin ##### --> -<para> - -</para> - -@self: -@pin: -@n_pin: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_init_pin_async ##### --> -<para> - -</para> - -@self: -@pin: -@n_pin: -@callback: -@user_data: - - -<!-- ##### FUNCTION gp11_session_init_pin_finish ##### --> -<para> - -</para> - -@self: -@result: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_set_pin ##### --> -<para> - -</para> - -@self: -@old_pin: -@n_old_pin: -@new_pin: -@n_new_pin: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_set_pin_async ##### --> -<para> - -</para> - -@self: -@old_pin: -@n_old_pin: -@new_pin: -@n_new_pin: -@callback: -@user_data: - - -<!-- ##### FUNCTION gp11_session_set_pin_finish ##### --> -<para> - -</para> - -@self: -@result: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_get_operation_state ##### --> -<para> - -</para> - -@self: -@n_result: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_get_operation_state_async ##### --> -<para> - -</para> - -@self: -@n_result: -@callback: -@user_data: - - -<!-- ##### FUNCTION gp11_session_get_operation_state_finish ##### --> -<para> - -</para> - -@self: -@result: -@n_result: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_set_operation_state ##### --> -<para> - -</para> - -@self: -@state: -@n_state: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_set_operation_state_async ##### --> -<para> - -</para> - -@self: -@state: -@n_state: -@callback: -@user_data: - - -<!-- ##### FUNCTION gp11_session_set_operation_state_finish ##### --> -<para> - -</para> - -@self: -@result: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_login ##### --> -<para> - -</para> - -@self: -@user_type: -@pin: -@n_pin: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_login_full ##### --> -<para> - -</para> - -@self: -@user_type: -@pin: -@n_pin: -@cancellable: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_login_async ##### --> -<para> - -</para> - -@self: -@user_type: -@pin: -@n_pin: -@cancellable: -@callback: -@user_data: - - -<!-- ##### FUNCTION gp11_session_login_finish ##### --> -<para> - -</para> - -@self: -@result: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_logout ##### --> -<para> - -</para> - -@self: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_logout_full ##### --> -<para> - -</para> - -@self: -@cancellable: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_logout_async ##### --> -<para> - -</para> - -@self: -@cancellable: -@callback: -@user_data: - - -<!-- ##### FUNCTION gp11_session_logout_finish ##### --> -<para> - -</para> - -@self: -@result: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_create_object ##### --> -<para> - -</para> - -@self: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_create_object_async ##### --> -<para> - -</para> - -@self: -@attrs: -@cancellable: -@callback: -@user_data: - - -<!-- ##### FUNCTION gp11_session_create_object_finish ##### --> -<para> - -</para> - -@self: -@result: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_find_objects ##### --> -<para> - -</para> - -@self: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_find_objects_async ##### --> -<para> - -</para> - -@self: -@attrs: -@cancellable: -@callback: -@user_data: - - -<!-- ##### FUNCTION gp11_session_find_objects_finish ##### --> -<para> - -</para> - -@self: -@result: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_generate_key ##### --> -<para> - -</para> - -@self: -@mechanism: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_seed_random_async ##### --> -<para> - -</para> - -@self: -@seed: -@n_seed: -@callback: -@user_data: - - -<!-- ##### FUNCTION gp11_session_seed_random_finish ##### --> -<para> - -</para> - -@self: -@result: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_generate_random ##### --> -<para> - -</para> - -@self: -@n_random: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_generate_random_async ##### --> -<para> - -</para> - -@self: -@n_random: -@callback: -@user_data: - - -<!-- ##### FUNCTION gp11_session_generate_random_finish ##### --> -<para> - -</para> - -@self: -@result: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_encrypt ##### --> -<para> - -</para> - -@self: -@key: -@mech: -@input: -@n_input: -@n_result: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_encrypt_full ##### --> -<para> - -</para> - -@self: -@key: -@mech_args: -@input: -@n_input: -@n_result: -@cancellable: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_encrypt_async ##### --> -<para> - -</para> - -@self: -@key: -@mech_args: -@input: -@n_input: -@cancellable: -@callback: -@user_data: - - -<!-- ##### FUNCTION gp11_session_encrypt_finish ##### --> -<para> - -</para> - -@self: -@result: -@n_result: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_batch_encrypt ##### --> -<para> - -</para> - -@self: -@key: -@mech_args: -@cancellable: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_batch_encrypt_async ##### --> -<para> - -</para> - -@self: -@key: -@mech_args: -@cancellable: -@callback: -@user_data: - - -<!-- ##### FUNCTION gp11_session_batch_encrypt_finish ##### --> -<para> - -</para> - -@self: -@key: -@result: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_decrypt ##### --> -<para> - -</para> - -@self: -@key: -@mech_type: -@input: -@n_input: -@n_result: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_decrypt_full ##### --> -<para> - -</para> - -@self: -@key: -@mech_args: -@input: -@n_input: -@n_result: -@cancellable: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_decrypt_async ##### --> -<para> - -</para> - -@self: -@key: -@mech_args: -@input: -@n_input: -@cancellable: -@callback: -@user_data: - - -<!-- ##### FUNCTION gp11_session_decrypt_finish ##### --> -<para> - -</para> - -@self: -@result: -@n_result: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_batch_decrypt ##### --> -<para> - -</para> - -@self: -@key: -@mech_args: -@cancellable: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_batch_decrypt_async ##### --> -<para> - -</para> - -@self: -@key: -@mech_args: -@cancellable: -@callback: -@user_data: - - -<!-- ##### FUNCTION gp11_session_batch_decrypt_finish ##### --> -<para> - -</para> - -@self: -@result: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_digest ##### --> -<para> - -</para> - -@self: -@mech_type: -@input: -@n_input: -@n_result: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_digest_full ##### --> -<para> - -</para> - -@self: -@mech_args: -@input: -@n_input: -@n_result: -@cancellable: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_digest_async ##### --> -<para> - -</para> - -@self: -@mech_args: -@input: -@n_input: -@cancellable: -@callback: -@user_data: - - -<!-- ##### FUNCTION gp11_session_digest_finish ##### --> -<para> - -</para> - -@self: -@result: -@n_result: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_batch_digest ##### --> -<para> - -</para> - -@self: -@mech_args: -@cancellable: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_batch_digest_async ##### --> -<para> - -</para> - -@self: -@mech_args: -@cancellable: -@callback: -@user_data: - - -<!-- ##### FUNCTION gp11_session_batch_digest_finish ##### --> -<para> - -</para> - -@self: -@result: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_batch_digest_encrypt ##### --> -<para> - -</para> - -@self: -@key: -@digest_mech: -@encrypt_mech: -@cancellable: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_batch_digest_encrypt_async ##### --> -<para> - -</para> - -@self: -@key: -@digest_mech: -@encrypt_mech: -@cancellable: -@callback: -@user_data: - - -<!-- ##### FUNCTION gp11_session_batch_digest_encrypt_finish ##### --> -<para> - -</para> - -@self: -@result: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_batch_digest_decrypt ##### --> -<para> - -</para> - -@self: -@key: -@digest_mech: -@decrypt_mech: -@cancellable: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_batch_digest_decrypt_async ##### --> -<para> - -</para> - -@self: -@key: -@digest_mech: -@decrypt_mech: -@cancellable: -@callback: -@user_data: - - -<!-- ##### FUNCTION gp11_session_batch_digest_decrypt_finish ##### --> -<para> - -</para> - -@self: -@result: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_batch_decrypt_verify ##### --> -<para> - -</para> - -@self: -@key: -@decrypt_mech: -@verify_mech: -@cancellable: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_batch_decrypt_verify_async ##### --> -<para> - -</para> - -@self: -@key: -@decrypt_mech: -@verify_mech: -@cancellable: -@callback: -@user_data: - - -<!-- ##### FUNCTION gp11_session_batch_decrypt_verify_finish ##### --> -<para> - -</para> - -@self: -@result: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_sign ##### --> -<para> - -</para> - -@self: -@key: -@mech_type: -@input: -@n_input: -@n_result: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_sign_full ##### --> -<para> - -</para> - -@self: -@key: -@mech_args: -@input: -@n_input: -@n_result: -@cancellable: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_sign_async ##### --> -<para> - -</para> - -@self: -@key: -@mech_args: -@input: -@n_input: -@cancellable: -@callback: -@user_data: - - -<!-- ##### FUNCTION gp11_session_sign_finish ##### --> -<para> - -</para> - -@self: -@result: -@n_result: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_batch_sign ##### --> -<para> - -</para> - -@self: -@key: -@mech_args: -@cancellable: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_batch_sign_async ##### --> -<para> - -</para> - -@self: -@key: -@mech_args: -@cancellable: -@callback: -@user_data: - - -<!-- ##### FUNCTION gp11_session_batch_sign_finish ##### --> -<para> - -</para> - -@self: -@result: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_batch_sign_encrypt ##### --> -<para> - -</para> - -@self: -@key: -@sign_mech: -@encrypt_mech: -@cancellable: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_batch_sign_encrypt_async ##### --> -<para> - -</para> - -@self: -@key: -@sign_mechanism: -@encrypt_mech: -@cancellable: -@callback: -@user_data: - - -<!-- ##### FUNCTION gp11_session_batch_sign_encrypt_finish ##### --> -<para> - -</para> - -@self: -@result: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_sign_recover ##### --> -<para> - -</para> - -@self: -@key: -@mech_type: -@input: -@n_input: -@n_result: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_sign_recover_full ##### --> -<para> - -</para> - -@self: -@key: -@mech_args: -@input: -@n_input: -@n_result: -@cancellable: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_sign_recover_async ##### --> -<para> - -</para> - -@self: -@key: -@mech_args: -@input: -@n_input: -@cancellable: -@callback: -@user_data: - - -<!-- ##### FUNCTION gp11_session_sign_recover_finish ##### --> -<para> - -</para> - -@self: -@result: -@n_result: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_verify ##### --> -<para> - -</para> - -@self: -@key: -@mech_type: -@input: -@n_input: -@signature: -@n_signature: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_verify_full ##### --> -<para> - -</para> - -@self: -@key: -@mech_args: -@input: -@n_input: -@signature: -@n_signature: -@cancellable: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_verify_async ##### --> -<para> - -</para> - -@self: -@key: -@mechanism: -@input: -@n_input: -@signature: -@n_signature: -@cancellable: -@callback: -@user_data: - - -<!-- ##### FUNCTION gp11_session_verify_finish ##### --> -<para> - -</para> - -@self: -@result: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_batch_verify ##### --> -<para> - -</para> - -@self: -@key: -@mech_type: -@input: -@n_input: -@n_result: -@cancellable: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_batch_verify_async ##### --> -<para> - -</para> - -@self: -@key: -@mech_args: -@input: -@n_input: -@cancellable: -@callback: -@user_data: - - -<!-- ##### FUNCTION gp11_session_batch_verify_finish ##### --> -<para> - -</para> - -@self: -@result: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_verify_recover ##### --> -<para> - -</para> - -@self: -@key: -@mech_type: -@input: -@n_input: -@n_result: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_verify_recover_full ##### --> -<para> - -</para> - -@self: -@key: -@mech_args: -@input: -@n_input: -@n_result: -@cancellable: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_verify_recover_async ##### --> -<para> - -</para> - -@self: -@key: -@mech_args: -@input: -@n_input: -@cancellable: -@callback: -@user_data: - - -<!-- ##### FUNCTION gp11_session_verify_recover_finish ##### --> -<para> - -</para> - -@self: -@result: -@n_result: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_wrap ##### --> -<para> - -</para> - -@self: -@key: -@mech_type: -@wrapped_key: -@n_result: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_wrap_async ##### --> -<para> - -</para> - -@self: -@key: -@mech_args: -@wrapped_key: -@cancellable: -@callback: -@user_data: - - -<!-- ##### FUNCTION gp11_session_wrap_finish ##### --> -<para> - -</para> - -@self: -@result: -@n_result: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_unwrap ##### --> -<para> - -</para> - -@self: -@key: -@mech_type: -@input: -@n_input: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_unwrap_finish ##### --> -<para> - -</para> - -@self: -@result: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_derive ##### --> -<para> - -</para> - -@self: -@key: -@mech_type: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_session_derive_finish ##### --> -<para> - -</para> - -@self: -@result: -@err: -@Returns: - - -<!-- ##### MACRO GP11_TYPE_OBJECT ##### --> -<para> - -</para> - - - -<!-- ##### MACRO GP11_OBJECT ##### --> -<para> - -</para> - -@obj: - - -<!-- ##### MACRO GP11_OBJECT_CLASS ##### --> -<para> - -</para> - -@klass: - - -<!-- ##### MACRO GP11_IS_OBJECT ##### --> -<para> - -</para> - -@obj: - - -<!-- ##### MACRO GP11_IS_OBJECT_CLASS ##### --> -<para> - -</para> - -@klass: - - -<!-- ##### MACRO GP11_OBJECT_GET_CLASS ##### --> -<para> - -</para> - -@obj: - - -<!-- ##### STRUCT GP11Object ##### --> -<para> - -</para> - - -<!-- ##### ARG GP11Object:handle ##### --> -<para> - -</para> - -<!-- ##### ARG GP11Object:module ##### --> -<para> - -</para> - -<!-- ##### ARG GP11Object:session ##### --> -<para> - -</para> - -<!-- ##### ARG GP11Object:slot ##### --> -<para> - -</para> - -<!-- ##### FUNCTION gp11_object_get_type ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION gp11_object_from_handle ##### --> -<para> - -</para> - -@slot: -@handle: -@Returns: - - -<!-- ##### FUNCTION gp11_objects_from_handle_array ##### --> -<para> - -</para> - -@slot: -@handles: -@n_handles: -@Returns: - - -<!-- ##### FUNCTION gp11_object_get_handle ##### --> -<para> - -</para> - -@self: -@Returns: - - -<!-- ##### FUNCTION gp11_object_copy ##### --> -<para> - -</para> - -@self: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_object_copy_full ##### --> -<para> - -</para> - -@self: -@additional: -@cancellable: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_object_copy_async ##### --> -<para> - -</para> - -@self: -@additional: -@cancellable: -@callback: -@user_data: - - -<!-- ##### FUNCTION gp11_object_copy_finish ##### --> -<para> - -</para> - -@self: -@result: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_object_destroy ##### --> -<para> - -</para> - -@self: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_object_destroy_full ##### --> -<para> - -</para> - -@self: -@cancellable: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_object_destroy_async ##### --> -<para> - -</para> - -@self: -@cancellable: -@callback: -@user_data: - - -<!-- ##### FUNCTION gp11_object_destroy_finish ##### --> -<para> - -</para> - -@self: -@result: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_object_get_size ##### --> -<para> - -</para> - -@self: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_object_get_size_full ##### --> -<para> - -</para> - -@self: -@cancellable: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_object_get_size_async ##### --> -<para> - -</para> - -@self: -@callback: -@user_data: - - -<!-- ##### FUNCTION gp11_object_get_size_finish ##### --> -<para> - -</para> - -@self: -@result: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_object_set ##### --> -<para> - -</para> - -@self: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_object_set_async ##### --> -<para> - -</para> - -@self: -@attrs: -@cancellable: -@callback: -@user_data: - - -<!-- ##### FUNCTION gp11_object_set_finish ##### --> -<para> - -</para> - -@self: -@result: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_object_get ##### --> -<para> - -</para> - -@self: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_object_get_async ##### --> -<para> - -</para> - -@self: -@attrs: -@cancellable: -@callback: -@user_data: - - -<!-- ##### FUNCTION gp11_object_get_finish ##### --> -<para> - -</para> - -@self: -@result: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_processor_step ##### --> -<para> - -</para> - -@processor: -@input: -@n_input: -@n_result: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_processor_step_async ##### --> -<para> - -</para> - -@processor: -@input: -@n_input: -@callback: -@user_data: - - -<!-- ##### FUNCTION gp11_processor_step_finish ##### --> -<para> - -</para> - -@processor: -@result: -@n_result: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_processor_close ##### --> -<para> - -</para> - -@processor: -@n_result: -@err: -@Returns: - - -<!-- ##### FUNCTION gp11_processor_close_async ##### --> -<para> - -</para> - -@processor: -@callback: -@user_data: -@Returns: - - -<!-- ##### FUNCTION gp11_processor_close_finish ##### --> -<para> - -</para> - -@processor: -@result: -@n_result: -@err: -@Returns: - - diff --git a/library/Makefile.am b/library/Makefile.am index 45fc4225..b94f64c4 100644 --- a/library/Makefile.am +++ b/library/Makefile.am @@ -62,5 +62,4 @@ TESTS_DIR = endif SUBDIRS = . \ - reference \ $(TESTS_DIR) diff --git a/library/gnome-keyring-memory.c b/library/gnome-keyring-memory.c index d016bab2..e135de76 100644 --- a/library/gnome-keyring-memory.c +++ b/library/gnome-keyring-memory.c @@ -32,6 +32,22 @@ #include <string.h> +/** + * SECTION:gnome-keyring-memory + * @title: Non-pageable Memory + * @short_description: Secure Non-pageable Memory + * + * Normal allocated memory can be paged to disk at the whim of the operating system. + * This can be a serious problem for sensitive information like passwords, keys and secrets. + * + * GNOME Keyring holds passwords in non-pageable, or locked memory. This happens + * both in the daemon and in the library. This is only possible if the OS contains + * support for it. + * + * These functions allow applications to use to hold passwords and other + * sensitive information. + */ + static GStaticMutex memory_mutex = G_STATIC_MUTEX_INIT; #define WARNING "couldn't allocate secure memory to keep passwords " \ diff --git a/library/gnome-keyring-utils.c b/library/gnome-keyring-utils.c index 010350ce..8ec4e527 100644 --- a/library/gnome-keyring-utils.c +++ b/library/gnome-keyring-utils.c @@ -32,6 +32,17 @@ #include "egg/egg-secure-memory.h" +/** + * SECTION:gnome-keyring-result + * @title: Result Codes + * @short_description: Gnome Keyring Result Codes + * + * <para> + * Result codes used through out GNOME Keyring. Additional result codes may be + * added from time to time and these should be handled gracefully. + * </para> + */ + /* Functions used by both the library and the daemon */ /* @@ -211,6 +222,18 @@ gnome_keyring_found_list_free (GList *found_list) } /** + * SECTION:gnome-keyring-attributes + * @title: Item Attributes + * @short_description: Attributes of individual keyring items. + * + * Attributes allow various other pieces of information to be associated with an item. + * These can also be used to search for relevant items. Use gnome_keyring_item_get_attributes() + * or gnome_keyring_item_set_attributes(). + * + * Each attribute has either a string, or unsigned integer value. + */ + +/** * gnome_keyring_attribute_list_append_string: * @attributes: A #GnomeKeyringAttributeList * @name: The name of the new attribute @@ -315,6 +338,15 @@ gnome_keyring_attribute_list_copy (GnomeKeyringAttributeList *attributes) } /** + * SECTION:gnome-keyring-keyring-info + * @title: Keyring Info + * @short_description: Keyring Information + * + * Use gnome_keyring_get_info() or gnome_keyring_get_info_sync() to get a #GnomeKeyringInfo + * pointer to use with these functions. + */ + +/** * gnome_keyring_info_free: * @keyring_info: The keyring info to free. * @@ -328,6 +360,15 @@ gnome_keyring_info_free (GnomeKeyringInfo *keyring_info) } /** + * SECTION:gnome-keyring-item-info + * @title: Item Information + * @short_description: Keyring Item Info + * + * #GnomeKeyringItemInfo represents the basic information about a keyring item. + * Use gnome_keyring_item_get_info() or gnome_keyring_item_set_info(). + */ + +/** * gnome_keyring_info_copy: * @keyring_info: The keyring info to copy. * diff --git a/library/gnome-keyring.c b/library/gnome-keyring.c index 4ae3db0e..38a46c57 100644 --- a/library/gnome-keyring.c +++ b/library/gnome-keyring.c @@ -44,6 +44,12 @@ #include <sys/uio.h> #include <stdarg.h> +/** + * SECTION:gnome-keyring-generic-callbacks + * @title: Callbacks + * @short_description: Different callbacks for retrieving async results + */ + typedef enum { CALLBACK_DONE, CALLBACK_GET_STRING, @@ -387,6 +393,12 @@ run_sync_operation (EggBuffer *buffer, } /** + * SECTION:gnome-keyring-misc + * @title: Miscellaneous Functions + * @short_description: Miscellaneous functions. + */ + +/** * gnome_keyring_is_available: * * Check whether you can communicate with a gnome-keyring-daemon. @@ -490,6 +502,18 @@ int_reply (GnomeKeyringOperation *op) } /** + * SECTION:gnome-keyring-keyrings + * @title: Keyrings + * @short_description: Listing and managing keyrings + * + * %gnome-keyring-daemon manages multiple keyrings. Each keyring can store one or more items containing secrets. + * + * One of the keyrings is the default keyring, which can in many cases be used by specifying %NULL for a keyring name. + * + * Each keyring can be in a locked or unlocked state. A password must be specified, either by the user or the calling application, to unlock the keyring. + */ + +/** * gnome_keyring_set_default_keyring: * @keyring: The keyring to make default * @callback: A callback which will be called when the request completes or fails. @@ -1522,6 +1546,14 @@ gnome_keyring_list_item_ids_sync (const char *keyring, } /** + * SECTION:gnome-keyring-daemon + * @title: Daemon Management Functions + * @short_description: Functions used by session to run the Gnome Keyring Daemon. + * + * These functions are not used by most applications using Gnome Keyring. + */ + +/** * gnome_keyring_daemon_set_display_sync: * @display: Deprecated * @@ -1744,6 +1776,18 @@ find_items_reply (GnomeKeyringOperation *op) } /** + * SECTION:gnome-keyring-find + * @title: Search Functionality + * @short_description: Find Keyring Items + * + * A find operation searches through all keyrings for items that match the + * attributes. The user may have been prompted to unlock necessary keyrings, and + * user will have been prompted for access to the items if needed. + * + * A find operation may return multiple or zero results. + */ + +/** * gnome_keyring_find_items: * @type: The type of items to find. * @attributes: A list of attributes to search for. This cannot be an empty list. @@ -1980,6 +2024,30 @@ gnome_keyring_find_itemsv_sync (GnomeKeyringItemType type, return res; } +/** + * SECTION:gnome-keyring-items + * @title: Keyring Items + * @short_description: Keyring items each hold a secret and a number of attributes. + * + * A keyring contains multiple items. Each item has a secret, attributes and access + * information associated with it. + * + * An item is identified by an unsigned integer unique to the keyring in which it + * exists. An item's name is for displaying to the user. Each item has a single secret, + * which is a null-terminated string. This secret is stored in non-pageable memory, and + * encrypted on disk. All of this information is exposed via #GnomeKeyringItemInfo + * pointers. + * + * Attributes allow various other pieces of information to be associated with an item. + * These can also be used to search for relevant items. Attributes are accessed with + * #GnomeKeyringAttribute structures and built into lists using #GnomeKeyringAttributeList. + * + * Each item has an access control list, which specifies the applications that + * can read, write or delete an item. The read access applies only to reading the secret. + * All applications can read other parts of the item. ACLs are accessed and changed + * through #GnomeKeyringAccessControl pointers. + */ + /** * gnome_keyring_item_create: * @keyring: The name of the keyring in which to create the item, or NULL for the default keyring. @@ -3149,6 +3217,17 @@ gnome_keyring_item_info_get_ctime (GnomeKeyringItemInfo *item_info) } /** + * SECTION:gnome-keyring-acl + * @title: Item ACLs + * @short_description: Access control lists for keyring items. + * + * Each item has an access control list, which specifies the applications that + * can read, write or delete an item. The read access applies only to reading the secret. + * All applications can read other parts of the item. ACLs are accessed and changed + * gnome_keyring_item_get_acl() and gnome_keyring_item_set_acl(). + */ + +/** * gnome_keyring_item_ac_get_display_name: * @ac: A #GnomeKeyringAccessControl pointer. * @@ -3238,6 +3317,15 @@ gnome_keyring_item_ac_set_access_type (GnomeKeyringAccessControl *ac, * NETWORK PASSWORD APIS */ +/** + * SECTION:gnome-keyring-network + * @title: Network Passwords + * @short_description: Saving of network passwords. + * + * Networks passwords are a simple way of saving passwords associated with a + * certain user/server/protocol and other fields. + */ + struct FindNetworkPasswordInfo { GnomeKeyringOperationGetListCallback callback; gpointer data; @@ -3689,6 +3777,56 @@ gnome_keyring_set_network_password_sync (const char * * SIMPLE PASSWORD APIS */ +/** + * SECTION:gnome-keyring-password + * @title: Simple Password Storage + * @short_description: Store and lookup passwords with a set of attributes. + * + * This is a simple API for storing passwords and retrieving passwords in the keyring. + * + * Each password is associated with a set of attributes. Attribute values can be either + * strings or unsigned integers. + * + * The names and types of allowed attributes for a given password are defined with a + * schema. Certain schemas are predefined such as %GNOME_KEYRING_NETWORK_PASSWORD. + * Additional schemas can be defined via the %GnomeKeyringPasswordSchema structure. + * + * Each function accepts a variable list of attributes names and their values. + * Include a %NULL to terminate the list of attributes. + * + * <example> + * <title>Passing attributes to the functions</title> + * <programlisting> + * res = gnome_keyring_delete_password_sync (GNOME_KEYRING_NETWORK_PASSWORD, + * "user", "me", // A string attribute + * "server, "example.gnome.org", + * "port", "8080", // An integer attribute + * NULL); + * </programlisting></example> + */ + +/** + * GnomeKeyringPasswordSchema: + * + * Describes a password schema. Often you'll want to use a predefined schema such + * as %GNOME_KEYRING_NETWORK_PASSWORD. + * + * <para> + * The last attribute name in a schema must be %NULL. + * + * <programlisting> + * GnomeKeyringPasswordSchema my_schema = { + * GNOME_KEYRING_ITEM_GENERIC_SECRET, + * { + * { "string-attr", GNOME_KEYRING_ATTRIBUTE_TYPE_STRING }, + * { "uint-attr", GNOME_KEYRING_ATTRIBUTE_TYPE_UINT32 }, + * { NULL, 0 } + * } + * }; + * </programlisting> + * </para> + */ + static const GnomeKeyringPasswordSchema network_password_schema = { GNOME_KEYRING_ITEM_NETWORK_PASSWORD, { @@ -3702,9 +3840,40 @@ static const GnomeKeyringPasswordSchema network_password_schema = { } }; +/** + * GNOME_KEYRING_NETWORK_PASSWORD: + * + * <para> + * A predefined schema for network paswsords. It contains the following attributes: + * </para> + * <itemizedlist> + * <listitem>user: A string for the user login.</listitem> + * <listitem>server: The server being connected to.</listitem> + * <listitem>protocol: The protocol used to access the server, such as 'http' or 'smb'</listitem> + * <listitem>domain: A realm or domain, such as a Windows login domain.</listitem> + * <listitem>port: The network port to used to connect to the server.</listitem> + * </itemizedlist> + */ + /* Declared in gnome-keyring.h */ const GnomeKeyringPasswordSchema *GNOME_KEYRING_NETWORK_PASSWORD = &network_password_schema; +/** + * GNOME_KEYRING_DEFAULT: + * + * <para> + * The default keyring. + * </para> + */ + +/** + * GNOME_KEYRING_SESSION: + * + * <para> + * A keyring only stored in memory. + * </para> + */ + static GnomeKeyringAttributeList* schema_attribute_list_va (const GnomeKeyringPasswordSchema *schema, va_list args) { diff --git a/library/reference/.cvsignore b/library/reference/.cvsignore deleted file mode 100644 index 8e6e462d..00000000 --- a/library/reference/.cvsignore +++ /dev/null @@ -1,14 +0,0 @@ -Makefile -Makefile.in -gnome-keyring.args -gnome-keyring.hierarchy -gnome-keyring.interfaces -gnome-keyring.prerequisites -gnome-keyring.signals -gnome-keyring-decl.txt -gnome-keyring-decl-list.txt -gnome-keyring-overrides.txt -gnome-keyring-undocumented.txt -gnome-keyring-unused.txt -*.stamp -xml diff --git a/library/reference/.gitignore b/library/reference/.gitignore deleted file mode 100644 index bce135a3..00000000 --- a/library/reference/.gitignore +++ /dev/null @@ -1,16 +0,0 @@ -/*.bak -/Makefile -/Makefile.in -/gnome-keyring.args -/gnome-keyring.hierarchy -/gnome-keyring.interfaces -/gnome-keyring.prerequisites -/gnome-keyring.signals -/gnome-keyring-decl.txt -/gnome-keyring-decl-list.txt -/gnome-keyring-overrides.txt -/gnome-keyring-undocumented.txt -/gnome-keyring-unused.txt -/*.stamp -/xml -/html diff --git a/library/reference/tmpl/.cvsignore b/library/reference/tmpl/.cvsignore deleted file mode 100644 index 078ee879..00000000 --- a/library/reference/tmpl/.cvsignore +++ /dev/null @@ -1 +0,0 @@ -*.sgml diff --git a/library/reference/tmpl/.gitignore b/library/reference/tmpl/.gitignore deleted file mode 100644 index dc3432a6..00000000 --- a/library/reference/tmpl/.gitignore +++ /dev/null @@ -1 +0,0 @@ -/*.bak diff --git a/library/reference/tmpl/empty.sgml b/library/reference/tmpl/empty.sgml deleted file mode 100644 index e69de29b..00000000 --- a/library/reference/tmpl/empty.sgml +++ /dev/null diff --git a/library/reference/tmpl/gnome-keyring-acl.sgml b/library/reference/tmpl/gnome-keyring-acl.sgml deleted file mode 100644 index aaafb890..00000000 --- a/library/reference/tmpl/gnome-keyring-acl.sgml +++ /dev/null @@ -1,164 +0,0 @@ -<!-- ##### SECTION Title ##### --> -gnome-keyring-acl - -<!-- ##### SECTION Short_Description ##### --> -Keyring Item ACLs - -<!-- ##### SECTION Long_Description ##### --> -<para>Each item has an access control list, which specifies the applications that -can read, write or delete an item. The read access applies only to reading the secret. -All applications can read other parts of the item. ACLs are accessed and changed -gnome_keyring_item_get_acl() and gnome_keyring_item_set_acl().</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### TYPEDEF GnomeKeyringAccessControl ##### --> -<para> - -</para> - - -<!-- ##### TYPEDEF GnomeKeyringApplicationRef ##### --> -<para> - -</para> - - -<!-- ##### ENUM GnomeKeyringAccessType ##### --> -<para> - -</para> - -@GNOME_KEYRING_ACCESS_READ: -@GNOME_KEYRING_ACCESS_WRITE: -@GNOME_KEYRING_ACCESS_REMOVE: - -<!-- ##### FUNCTION gnome_keyring_application_ref_new ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_application_ref_copy ##### --> -<para> - -</para> - -@app: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_application_ref_free ##### --> -<para> - -</para> - -@app: - - -<!-- ##### FUNCTION gnome_keyring_access_control_new ##### --> -<para> - -</para> - -@application: -@types_allowed: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_access_control_copy ##### --> -<para> - -</para> - -@ac: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_access_control_free ##### --> -<para> - -</para> - -@ac: - - -<!-- ##### FUNCTION gnome_keyring_acl_copy ##### --> -<para> - -</para> - -@list: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_acl_free ##### --> -<para> - -</para> - -@acl: - - -<!-- ##### FUNCTION gnome_keyring_item_ac_get_display_name ##### --> -<para> - -</para> - -@ac: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_ac_set_display_name ##### --> -<para> - -</para> - -@ac: -@value: - - -<!-- ##### FUNCTION gnome_keyring_item_ac_get_path_name ##### --> -<para> - -</para> - -@ac: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_ac_set_path_name ##### --> -<para> - -</para> - -@ac: -@value: - - -<!-- ##### FUNCTION gnome_keyring_item_ac_get_access_type ##### --> -<para> - -</para> - -@ac: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_ac_set_access_type ##### --> -<para> - -</para> - -@ac: -@value: - - diff --git a/library/reference/tmpl/gnome-keyring-attributes.sgml b/library/reference/tmpl/gnome-keyring-attributes.sgml deleted file mode 100644 index daff4631..00000000 --- a/library/reference/tmpl/gnome-keyring-attributes.sgml +++ /dev/null @@ -1,96 +0,0 @@ -<!-- ##### SECTION Title ##### --> -gnome-keyring-attributes - -<!-- ##### SECTION Short_Description ##### --> -Keyring Item Attributes - -<!-- ##### SECTION Long_Description ##### --> -<para>Attributes allow various other pieces of information to be associated with an item. -These can also be used to search for relevant items. Use gnome_keyring_item_get_attributes() -or gnome_keyring_item_set_attributes().</para> - -<para>Each attribute has either a string, or unsigned integer value.</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### ENUM GnomeKeyringAttributeType ##### --> -<para> - -</para> - -@GNOME_KEYRING_ATTRIBUTE_TYPE_STRING: -@GNOME_KEYRING_ATTRIBUTE_TYPE_UINT32: - -<!-- ##### TYPEDEF GnomeKeyringAttributeList ##### --> -<para> - -</para> - - -<!-- ##### STRUCT GnomeKeyringAttribute ##### --> -<para> - -</para> - -@name: -@type: - -<!-- ##### MACRO gnome_keyring_attribute_list_index ##### --> -<para> - -</para> - -@a: -@i: - - -<!-- ##### MACRO gnome_keyring_attribute_list_new ##### --> -<para> - -</para> - - - -<!-- ##### FUNCTION gnome_keyring_attribute_list_append_string ##### --> -<para> - -</para> - -@attributes: -@name: -@value: - - -<!-- ##### FUNCTION gnome_keyring_attribute_list_append_uint32 ##### --> -<para> - -</para> - -@attributes: -@name: -@value: - - -<!-- ##### FUNCTION gnome_keyring_attribute_list_free ##### --> -<para> - -</para> - -@attributes: - - -<!-- ##### FUNCTION gnome_keyring_attribute_list_copy ##### --> -<para> - -</para> - -@attributes: -@Returns: - - diff --git a/library/reference/tmpl/gnome-keyring-daemon.sgml b/library/reference/tmpl/gnome-keyring-daemon.sgml deleted file mode 100644 index 217b1d3f..00000000 --- a/library/reference/tmpl/gnome-keyring-daemon.sgml +++ /dev/null @@ -1,36 +0,0 @@ -<!-- ##### SECTION Title ##### --> -Daemon Management Functions - -<!-- ##### SECTION Short_Description ##### --> -Functions used by session managers to manage the Gnome Keyring Daemon. - -<!-- ##### SECTION Long_Description ##### --> -<para> -These functions are not used by most applications using Gnome Keyring. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### FUNCTION gnome_keyring_daemon_set_display_sync ##### --> -<para> - -</para> - -@display: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_daemon_prepare_environment_sync ##### --> -<para> - -</para> - -@Returns: - - diff --git a/library/reference/tmpl/gnome-keyring-find.sgml b/library/reference/tmpl/gnome-keyring-find.sgml deleted file mode 100644 index 86d2ef22..00000000 --- a/library/reference/tmpl/gnome-keyring-find.sgml +++ /dev/null @@ -1,95 +0,0 @@ -<!-- ##### SECTION Title ##### --> -gnome-keyring-find - -<!-- ##### SECTION Short_Description ##### --> -Find Keyring Items - -<!-- ##### SECTION Long_Description ##### --> -<para>A find operation searches through all keyrings for items that match the -attributes. The user may have been prompted to unlock necessary keyrings, and -user will have been prompted for access to the items if needed.</para> - -<para>A find operation may return multiple or zero results.</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### STRUCT GnomeKeyringFound ##### --> -<para> - -</para> - -@keyring: -@item_id: -@attributes: -@secret: - -<!-- ##### FUNCTION gnome_keyring_found_free ##### --> -<para> - -</para> - -@found: - - -<!-- ##### FUNCTION gnome_keyring_found_list_free ##### --> -<para> - -</para> - -@found_list: - - -<!-- ##### FUNCTION gnome_keyring_find_items ##### --> -<para> - -</para> - -@type: -@attributes: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_find_itemsv ##### --> -<para> - -</para> - -@type: -@callback: -@data: -@destroy_data: -@Varargs: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_find_items_sync ##### --> -<para> - -</para> - -@type: -@attributes: -@found: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_find_itemsv_sync ##### --> -<para> - -</para> - -@type: -@found: -@Varargs: -@Returns: - - diff --git a/library/reference/tmpl/gnome-keyring-generic-callbacks.sgml b/library/reference/tmpl/gnome-keyring-generic-callbacks.sgml deleted file mode 100644 index 0357915c..00000000 --- a/library/reference/tmpl/gnome-keyring-generic-callbacks.sgml +++ /dev/null @@ -1,58 +0,0 @@ -<!-- ##### SECTION Title ##### --> -gnome-keyring-generic-callbacks - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### USER_FUNCTION GnomeKeyringOperationDoneCallback ##### --> -<para> - -</para> - -@result: -@data: - - -<!-- ##### USER_FUNCTION GnomeKeyringOperationGetIntCallback ##### --> -<para> - -</para> - -@result: -@val: -@data: - - -<!-- ##### USER_FUNCTION GnomeKeyringOperationGetListCallback ##### --> -<para> - -</para> - -@result: -@list: -@data: - - -<!-- ##### USER_FUNCTION GnomeKeyringOperationGetStringCallback ##### --> -<para> - -</para> - -@result: -@string: -@data: - - diff --git a/library/reference/tmpl/gnome-keyring-item-info.sgml b/library/reference/tmpl/gnome-keyring-item-info.sgml deleted file mode 100644 index 7a265cf8..00000000 --- a/library/reference/tmpl/gnome-keyring-item-info.sgml +++ /dev/null @@ -1,134 +0,0 @@ -<!-- ##### SECTION Title ##### --> -gnome-keyring-item-info - -<!-- ##### SECTION Short_Description ##### --> -Keyring Item Info - -<!-- ##### SECTION Long_Description ##### --> -<para>#GnomeKeyringItemInfo represents the basic information about a keyring item. -Use gnome_keyring_item_get_info() or gnome_keyring_item_set_info().</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### ENUM GnomeKeyringItemType ##### --> -<para> - -</para> - -@GNOME_KEYRING_ITEM_GENERIC_SECRET: -@GNOME_KEYRING_ITEM_NETWORK_PASSWORD: -@GNOME_KEYRING_ITEM_NOTE: -@GNOME_KEYRING_ITEM_CHAINED_KEYRING_PASSWORD: -@GNOME_KEYRING_ITEM_ENCRYPTION_KEY_PASSWORD: -@GNOME_KEYRING_ITEM_PK_STORAGE: -@GNOME_KEYRING_ITEM_LAST_TYPE: - -<!-- ##### TYPEDEF GnomeKeyringItemInfo ##### --> -<para> - -</para> - - -<!-- ##### FUNCTION gnome_keyring_item_info_free ##### --> -<para> - -</para> - -@item_info: - - -<!-- ##### FUNCTION gnome_keyring_item_info_new ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_info_copy ##### --> -<para> - -</para> - -@item_info: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_info_get_type ##### --> -<para> - -</para> - -@item_info: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_info_set_type ##### --> -<para> - -</para> - -@item_info: -@type: - - -<!-- ##### FUNCTION gnome_keyring_item_info_get_secret ##### --> -<para> - -</para> - -@item_info: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_info_set_secret ##### --> -<para> - -</para> - -@item_info: -@value: - - -<!-- ##### FUNCTION gnome_keyring_item_info_get_display_name ##### --> -<para> - -</para> - -@item_info: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_info_set_display_name ##### --> -<para> - -</para> - -@item_info: -@value: - - -<!-- ##### FUNCTION gnome_keyring_item_info_get_mtime ##### --> -<para> - -</para> - -@item_info: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_info_get_ctime ##### --> -<para> - -</para> - -@item_info: -@Returns: - - diff --git a/library/reference/tmpl/gnome-keyring-items.sgml b/library/reference/tmpl/gnome-keyring-items.sgml deleted file mode 100644 index ae862300..00000000 --- a/library/reference/tmpl/gnome-keyring-items.sgml +++ /dev/null @@ -1,318 +0,0 @@ -<!-- ##### SECTION Title ##### --> -gnome-keyring-items - -<!-- ##### SECTION Short_Description ##### --> -Keyring Items - -<!-- ##### SECTION Long_Description ##### --> -<para>A keyring contains multiple items. Each item has a secret, attributes and access -information associated with it. </para> - -<para>An item is identified by an unsigned integer unique to the keyring in which it -exists. An item's name is for displaying to the user. Each item has a single secret, -which is a null-terminated string. This secret is stored in non-pageable memory, and -encrypted on disk. All of this information is exposed via #GnomeKeyringItemInfo -pointers</para> - -<para>Attributes allow various other pieces of information to be associated with an item. -These can also be used to search for relevant items. Attributes are accessed with -#GnomeKeyringAttribute structures and built into lists using #GnomeKeyringAttributeList.</para> - -<para>Each item has an access control list, which specifies the applications that -can read, write or delete an item. The read access applies only to reading the secret. -All applications can read other parts of the item. ACLs are accessed and changed -through #GnomeKeyringAccessControl pointers.</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### ENUM GnomeKeyringItemInfoFlags ##### --> -<para> - -</para> - -@GNOME_KEYRING_ITEM_INFO_BASICS: -@GNOME_KEYRING_ITEM_INFO_SECRET: - -<!-- ##### USER_FUNCTION GnomeKeyringOperationGetItemInfoCallback ##### --> -<para> - -</para> - -@result: -@info: -@data: - - -<!-- ##### USER_FUNCTION GnomeKeyringOperationGetAttributesCallback ##### --> -<para> - -</para> - -@result: -@attributes: -@data: - - -<!-- ##### FUNCTION gnome_keyring_item_create ##### --> -<para> - -</para> - -@keyring: -@type: -@display_name: -@attributes: -@secret: -@update_if_exists: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_create_sync ##### --> -<para> - -</para> - -@keyring: -@type: -@display_name: -@attributes: -@secret: -@update_if_exists: -@item_id: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_delete ##### --> -<para> - -</para> - -@keyring: -@id: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_delete_sync ##### --> -<para> - -</para> - -@keyring: -@id: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_get_info ##### --> -<para> - -</para> - -@keyring: -@id: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_get_info_full ##### --> -<para> - -</para> - -@keyring: -@id: -@flags: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_get_info_full_sync ##### --> -<para> - -</para> - -@keyring: -@id: -@flags: -@info: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_get_info_sync ##### --> -<para> - -</para> - -@keyring: -@id: -@info: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_set_info ##### --> -<para> - -</para> - -@keyring: -@id: -@info: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_set_info_sync ##### --> -<para> - -</para> - -@keyring: -@id: -@info: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_get_attributes ##### --> -<para> - -</para> - -@keyring: -@id: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_get_attributes_sync ##### --> -<para> - -</para> - -@keyring: -@id: -@attributes: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_set_attributes ##### --> -<para> - -</para> - -@keyring: -@id: -@attributes: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_set_attributes_sync ##### --> -<para> - -</para> - -@keyring: -@id: -@attributes: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_get_acl ##### --> -<para> - -</para> - -@keyring: -@id: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_get_acl_sync ##### --> -<para> - -</para> - -@keyring: -@id: -@acl: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_set_acl ##### --> -<para> - -</para> - -@keyring: -@id: -@acl: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_set_acl_sync ##### --> -<para> - -</para> - -@keyring: -@id: -@acl: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_grant_access_rights ##### --> -<para> - -</para> - -@keyring: -@display_name: -@full_path: -@id: -@rights: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_grant_access_rights_sync ##### --> -<para> - -</para> - -@keyring: -@display_name: -@full_path: -@id: -@rights: -@Returns: - - diff --git a/library/reference/tmpl/gnome-keyring-keyring-info.sgml b/library/reference/tmpl/gnome-keyring-keyring-info.sgml deleted file mode 100644 index 6280bf70..00000000 --- a/library/reference/tmpl/gnome-keyring-keyring-info.sgml +++ /dev/null @@ -1,104 +0,0 @@ -<!-- ##### SECTION Title ##### --> -gnome-keyring-keyring-info - -<!-- ##### SECTION Short_Description ##### --> -Keyring Information - -<!-- ##### SECTION Long_Description ##### --> -<para>Use gnome_keyring_get_info() or gnome_keyring_get_info_sync() to get a #GnomeKeyringInfo -pointer to use with these functions.</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### TYPEDEF GnomeKeyringInfo ##### --> -<para> - -</para> - - -<!-- ##### FUNCTION gnome_keyring_info_free ##### --> -<para> - -</para> - -@keyring_info: - - -<!-- ##### FUNCTION gnome_keyring_info_copy ##### --> -<para> - -</para> - -@keyring_info: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_info_set_lock_on_idle ##### --> -<para> - -</para> - -@keyring_info: -@value: - - -<!-- ##### FUNCTION gnome_keyring_info_get_lock_on_idle ##### --> -<para> - -</para> - -@keyring_info: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_info_set_lock_timeout ##### --> -<para> - -</para> - -@keyring_info: -@value: - - -<!-- ##### FUNCTION gnome_keyring_info_get_lock_timeout ##### --> -<para> - -</para> - -@keyring_info: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_info_get_mtime ##### --> -<para> - -</para> - -@keyring_info: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_info_get_ctime ##### --> -<para> - -</para> - -@keyring_info: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_info_get_is_locked ##### --> -<para> - -</para> - -@keyring_info: -@Returns: - - diff --git a/library/reference/tmpl/gnome-keyring-keyrings.sgml b/library/reference/tmpl/gnome-keyring-keyrings.sgml deleted file mode 100644 index 3b7e500d..00000000 --- a/library/reference/tmpl/gnome-keyring-keyrings.sgml +++ /dev/null @@ -1,291 +0,0 @@ -<!-- ##### SECTION Title ##### --> -gnome-keyring-keyrings - -<!-- ##### SECTION Short_Description ##### --> -Keyrings - -<!-- ##### SECTION Long_Description ##### --> -<para>%gnome-keyring-daemon manages multiple keyrings. Each keyring can store one or more items containing secrets.</para> - -<para>One of the keyrings is the default keyring, which can in many cases be used by specifying %NULL for a keyring name.</para> - -<para>Each keyring can be in a locked or unlocked state. A password must be specified, either by the user or the calling application, to unlock the keyring.</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### USER_FUNCTION GnomeKeyringOperationGetKeyringInfoCallback ##### --> -<para> - -</para> - -@result: -@info: -@data: - - -<!-- ##### FUNCTION gnome_keyring_set_default_keyring ##### --> -<para> - -</para> - -@keyring: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_set_default_keyring_sync ##### --> -<para> - -</para> - -@keyring: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_get_default_keyring ##### --> -<para> - -</para> - -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_get_default_keyring_sync ##### --> -<para> - -</para> - -@keyring: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_list_keyring_names ##### --> -<para> - -</para> - -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_list_keyring_names_sync ##### --> -<para> - -</para> - -@keyrings: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_lock_all ##### --> -<para> - -</para> - -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_lock_all_sync ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_create ##### --> -<para> - -</para> - -@keyring_name: -@password: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_create_sync ##### --> -<para> - -</para> - -@keyring_name: -@password: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_unlock ##### --> -<para> - -</para> - -@keyring: -@password: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_unlock_sync ##### --> -<para> - -</para> - -@keyring: -@password: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_lock ##### --> -<para> - -</para> - -@keyring: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_lock_sync ##### --> -<para> - -</para> - -@keyring: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_delete ##### --> -<para> - -</para> - -@keyring: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_delete_sync ##### --> -<para> - -</para> - -@keyring: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_get_info ##### --> -<para> - -</para> - -@keyring: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_get_info_sync ##### --> -<para> - -</para> - -@keyring: -@info: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_set_info ##### --> -<para> - -</para> - -@keyring: -@info: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_set_info_sync ##### --> -<para> - -</para> - -@keyring: -@info: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_change_password ##### --> -<para> - -</para> - -@keyring: -@original: -@password: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_change_password_sync ##### --> -<para> - -</para> - -@keyring: -@original: -@password: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_list_item_ids ##### --> -<para> - -</para> - -@keyring: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_list_item_ids_sync ##### --> -<para> - -</para> - -@keyring: -@ids: -@Returns: - - diff --git a/library/reference/tmpl/gnome-keyring-memory.sgml b/library/reference/tmpl/gnome-keyring-memory.sgml deleted file mode 100644 index e454b3e3..00000000 --- a/library/reference/tmpl/gnome-keyring-memory.sgml +++ /dev/null @@ -1,100 +0,0 @@ -<!-- ##### SECTION Title ##### --> -gnome-keyring-memory - -<!-- ##### SECTION Short_Description ##### --> -Secure Non-pageable Memory - -<!-- ##### SECTION Long_Description ##### --> -<para> -Normal allocated memory can be paged to disk at the whim of the operating system. -This is a serious problems for sensitive information like passwords, keys and secrets. -</para> - -<para>GNOME Keyring holds passwords in non-pageable, or locked memory. This happens -both in the daemon and in the library. This is only possible if the OS contains -support for it.</para> - -<para>These functions allow applications to use to hold passwords and other -sensitive information.</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### MACRO gnome_keyring_memory_new ##### --> -<para> - -</para> - -@type: -@n_objects: - - -<!-- ##### FUNCTION gnome_keyring_memory_alloc ##### --> -<para> - -</para> - -@sz: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_memory_try_alloc ##### --> -<para> - -</para> - -@sz: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_memory_realloc ##### --> -<para> - -</para> - -@p: -@sz: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_memory_try_realloc ##### --> -<para> - -</para> - -@p: -@sz: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_memory_free ##### --> -<para> - -</para> - -@p: - - -<!-- ##### FUNCTION gnome_keyring_memory_is_secure ##### --> -<para> - -</para> - -@p: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_memory_strdup ##### --> -<para> - -</para> - -@str: -@Returns: - - diff --git a/library/reference/tmpl/gnome-keyring-misc.sgml b/library/reference/tmpl/gnome-keyring-misc.sgml deleted file mode 100644 index 411efd16..00000000 --- a/library/reference/tmpl/gnome-keyring-misc.sgml +++ /dev/null @@ -1,43 +0,0 @@ -<!-- ##### SECTION Title ##### --> -gnome-keyring-misc - -<!-- ##### SECTION Short_Description ##### --> -Miscellaneous Functions - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### FUNCTION gnome_keyring_is_available ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_cancel_request ##### --> -<para> - -</para> - -@request: - - -<!-- ##### FUNCTION gnome_keyring_string_list_free ##### --> -<para> - -</para> - -@strings: - - diff --git a/library/reference/tmpl/gnome-keyring-network.sgml b/library/reference/tmpl/gnome-keyring-network.sgml deleted file mode 100644 index dee77e54..00000000 --- a/library/reference/tmpl/gnome-keyring-network.sgml +++ /dev/null @@ -1,122 +0,0 @@ -<!-- ##### SECTION Title ##### --> -gnome-keyring-network - -<!-- ##### SECTION Short_Description ##### --> -Network Passwords - -<!-- ##### SECTION Long_Description ##### --> -<para>Networks passwords are a simple way of saving passwords associated with a -certain user/server/protocol and other fields.</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### STRUCT GnomeKeyringNetworkPasswordData ##### --> -<para> - -</para> - -@keyring: -@item_id: -@protocol: -@server: -@object: -@authtype: -@port: -@user: -@domain: -@password: - -<!-- ##### FUNCTION gnome_keyring_network_password_free ##### --> -<para> - -</para> - -@data: - - -<!-- ##### FUNCTION gnome_keyring_network_password_list_free ##### --> -<para> - -</para> - -@list: - - -<!-- ##### FUNCTION gnome_keyring_find_network_password ##### --> -<para> - -</para> - -@user: -@domain: -@server: -@object: -@protocol: -@authtype: -@port: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_find_network_password_sync ##### --> -<para> - -</para> - -@user: -@domain: -@server: -@object: -@protocol: -@authtype: -@port: -@results: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_set_network_password ##### --> -<para> - -</para> - -@keyring: -@user: -@domain: -@server: -@object: -@protocol: -@authtype: -@port: -@password: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_set_network_password_sync ##### --> -<para> - -</para> - -@keyring: -@user: -@domain: -@server: -@object: -@protocol: -@authtype: -@port: -@password: -@item_id: -@Returns: - - diff --git a/library/reference/tmpl/gnome-keyring-password.sgml b/library/reference/tmpl/gnome-keyring-password.sgml deleted file mode 100644 index cba8b008..00000000 --- a/library/reference/tmpl/gnome-keyring-password.sgml +++ /dev/null @@ -1,173 +0,0 @@ -<!-- ##### SECTION Title ##### --> -Simple Password Storage - -<!-- ##### SECTION Short_Description ##### --> -Store and lookup passwords with a set of attributes. - -<!-- ##### SECTION Long_Description ##### --> -<para> -This is a simple API for storing passwords and retrieving passwords in the keyring. -</para> -<para> -Each password is associated with a set of attributes. Attribute values can be either -strings or unsigned integers. -The names and types of allowed attributes for a given password are defined with a -schema. Certain schemas are predefined such as %GNOME_KEYRING_NETWORK_PASSWORD. -Additional schemas can be defined via the %GnomeKeyringPasswordSchema structure. -</para> -<para> -Each function accepts a variable list of attributes names and their values. -Include a %NULL to terminate the list of attributes. -</para> -<example> -<title>Passing attributes to the functions</title> -<programlisting> - res = gnome_keyring_delete_password_sync (GNOME_KEYRING_NETWORK_PASSWORD, - "user", "me", /* A string attribute */ - "server, "example.gnome.org", - "port", "8080", /* An integer attribute */ - NULL); -</programlisting></example> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### STRUCT GnomeKeyringPasswordSchema ##### --> -<para> -Describes a password schema. Often you'll want to use a predefined schema such -as %GNOME_KEYRING_NETWORK_PASSWORD. -</para> - -<para> -The last attribute name in a schema must be %NULL. - -<programlisting> - GnomeKeyringPasswordSchema my_schema = { - GNOME_KEYRING_ITEM_GENERIC_SECRET, - { - { "string-attr", GNOME_KEYRING_ATTRIBUTE_TYPE_STRING }, - { "uint-attr", GNOME_KEYRING_ATTRIBUTE_TYPE_UINT32 }, - { NULL, 0 } - } - }; -</programlisting> -</para> - -@item_type: - -<!-- ##### VARIABLE GNOME_KEYRING_NETWORK_PASSWORD ##### --> -<para> -A predefined schema for network paswsords. It contains the following attributes: -</para> -<itemizedlist> -<listitem>user: A string for the user login.</listitem> -<listitem>server: The server being connected to.</listitem> -<listitem>protocol: The protocol used to access the server, such as 'http' or 'smb'</listitem> -<listitem>domain: A realm or domain, such as a Windows login domain.</listitem> -<listitem>port: The network port to used to connect to the server.</listitem> -</itemizedlist> - - -<!-- ##### MACRO GNOME_KEYRING_DEFAULT ##### --> -<para> -The default keyring. -</para> - - - -<!-- ##### MACRO GNOME_KEYRING_SESSION ##### --> -<para> -A keyring only stored in memory. -</para> - - - -<!-- ##### FUNCTION gnome_keyring_store_password ##### --> -<para> - -</para> - -@schema: -@keyring: -@display_name: -@password: -@callback: -@data: -@destroy_data: -@Varargs: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_store_password_sync ##### --> -<para> - -</para> - -@schema: -@keyring: -@display_name: -@password: -@Varargs: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_find_password ##### --> -<para> - -</para> - -@schema: -@callback: -@data: -@destroy_data: -@Varargs: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_find_password_sync ##### --> -<para> - -</para> - -@schema: -@password: -@Varargs: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_delete_password ##### --> -<para> - -</para> - -@schema: -@callback: -@data: -@destroy_data: -@Varargs: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_delete_password_sync ##### --> -<para> - -</para> - -@schema: -@Varargs: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_free_password ##### --> -<para> - -</para> - -@password: - - diff --git a/library/reference/tmpl/gnome-keyring-result.sgml b/library/reference/tmpl/gnome-keyring-result.sgml deleted file mode 100644 index 3ead2a66..00000000 --- a/library/reference/tmpl/gnome-keyring-result.sgml +++ /dev/null @@ -1,45 +0,0 @@ -<!-- ##### SECTION Title ##### --> -gnome-keyring-result - -<!-- ##### SECTION Short_Description ##### --> -Result Codes - -<!-- ##### SECTION Long_Description ##### --> -<para> -Result codes used through out GNOME Keyring. Additional result codes may be -added from time to time and these should be handled gracefully. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### FUNCTION gnome_keyring_result_to_message ##### --> -<para> - -</para> - -@res: -@Returns: - - -<!-- ##### ENUM GnomeKeyringResult ##### --> -<para> - -</para> - -@GNOME_KEYRING_RESULT_OK: -@GNOME_KEYRING_RESULT_DENIED: -@GNOME_KEYRING_RESULT_NO_KEYRING_DAEMON: -@GNOME_KEYRING_RESULT_ALREADY_UNLOCKED: -@GNOME_KEYRING_RESULT_NO_SUCH_KEYRING: -@GNOME_KEYRING_RESULT_BAD_ARGUMENTS: -@GNOME_KEYRING_RESULT_IO_ERROR: -@GNOME_KEYRING_RESULT_CANCELLED: -@GNOME_KEYRING_RESULT_KEYRING_ALREADY_EXISTS: -@GNOME_KEYRING_RESULT_NO_MATCH: - diff --git a/library/reference/tmpl/gnome-keyring-unused.sgml b/library/reference/tmpl/gnome-keyring-unused.sgml deleted file mode 100644 index e69de29b..00000000 --- a/library/reference/tmpl/gnome-keyring-unused.sgml +++ /dev/null |