diff options
Diffstat (limited to 'docs')
70 files changed, 13989 insertions, 0 deletions
diff --git a/docs/Makefile.am b/docs/Makefile.am new file mode 100644 index 0000000..dd8b8a5 --- /dev/null +++ b/docs/Makefile.am @@ -0,0 +1,121 @@ +## 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=gsignond + +# 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 + +# Directories containing the source code. +# gtk-doc will search all .c and .h files beneath these paths +# for inline comments documenting functions and macros. +# e.g. DOC_SOURCE_DIR=$(top_srcdir)/gtk $(top_srcdir)/gdk +DOC_SOURCE_DIR=$(top_srcdir)/include\ +$(top_srcdir)/src/common\ +$(top_srcdir)/src/plugins + +# 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=--xml-mode --output-format=xml +MKDB_OPTIONS=--xml-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= +CFILE_GLOB= + +# 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 or dirs to ignore when scanning. Use base file/dir names +# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h private_code +IGNORE_HFILES=\ +gsignond-disposable.h\ +gsignond-identity-info.h\ +gsignond-identity-info-internal.h\ +gsignond-pipe-stream.h\ +gsignond-plugin-enum-types.h\ +gsignond-plugin-loader.h\ +gsignond-db-defines.h\ +gsignond-db-error.h\ +gsignond-db-secret-database.h\ +gsignond-db-sql-database.h\ +gsignond-db-sql-database-private.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=building.xml + +# 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= + +GTKDOC_LIBS=\ + $(top_builddir)/src/common/libgsignond-common.la\ + $(top_builddir)/src/plugins/digest/libdigest.la\ + $(top_builddir)/src/plugins/password/libpassword.la\ + $(top_builddir)/src/plugins/ssotest/libssotest.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 'make check' to test you doc status +# and run some sanity checks +if ENABLE_GTK_DOC +TESTS_ENVIRONMENT = cd $(srcdir) && \ + DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \ + SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir) +TESTS = $(GTKDOC_CHECK) +endif diff --git a/docs/Makefile.in b/docs/Makefile.in new file mode 100644 index 0000000..0bb399e --- /dev/null +++ b/docs/Makefile.in @@ -0,0 +1,908 @@ +# Makefile.in generated by automake 1.11.6 from Makefile.am. +# @configure_input@ + +# Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, +# 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011 Free Software +# Foundation, Inc. +# This Makefile.in is free software; the Free Software Foundation +# gives unlimited permission to copy and/or distribute it, +# with or without modifications, as long as this notice is preserved. + +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY, to the extent permitted by law; without +# even the implied warranty of MERCHANTABILITY or FITNESS FOR A +# PARTICULAR PURPOSE. + +@SET_MAKE@ + +# -*- mode: makefile -*- + +#################################### +# Everything below here is generic # +#################################### +VPATH = @srcdir@ +am__make_dryrun = \ + { \ + am__dry=no; \ + case $$MAKEFLAGS in \ + *\\[\ \ ]*) \ + echo 'am--echo: ; @echo "AM" OK' | $(MAKE) -f - 2>/dev/null \ + | grep '^AM OK$$' >/dev/null || am__dry=yes;; \ + *) \ + for am__flg in $$MAKEFLAGS; do \ + case $$am__flg in \ + *=*|--*) ;; \ + *n*) am__dry=yes; break;; \ + esac; \ + done;; \ + esac; \ + test $$am__dry = yes; \ + } +pkgdatadir = $(datadir)/@PACKAGE@ +pkgincludedir = $(includedir)/@PACKAGE@ +pkglibdir = $(libdir)/@PACKAGE@ +pkglibexecdir = $(libexecdir)/@PACKAGE@ +am__cd = CDPATH="$${ZSH_VERSION+.}$(PATH_SEPARATOR)" && cd +install_sh_DATA = $(install_sh) -c -m 644 +install_sh_PROGRAM = $(install_sh) -c +install_sh_SCRIPT = $(install_sh) -c +INSTALL_HEADER = $(INSTALL_DATA) +transform = $(program_transform_name) +NORMAL_INSTALL = : +PRE_INSTALL = : +POST_INSTALL = : +NORMAL_UNINSTALL = : +PRE_UNINSTALL = : +POST_UNINSTALL = : +build_triplet = @build@ +host_triplet = @host@ +DIST_COMMON = $(srcdir)/Makefile.am $(srcdir)/Makefile.in \ + $(top_srcdir)/gtk-doc.make +subdir = docs +ACLOCAL_M4 = $(top_srcdir)/aclocal.m4 +am__aclocal_m4_deps = $(top_srcdir)/m4/ax_check_gnu_make.m4 \ + $(top_srcdir)/m4/gtk-doc.m4 $(top_srcdir)/m4/libtool.m4 \ + $(top_srcdir)/m4/ltoptions.m4 $(top_srcdir)/m4/ltsugar.m4 \ + $(top_srcdir)/m4/ltversion.m4 $(top_srcdir)/m4/lt~obsolete.m4 \ + $(top_srcdir)/configure.ac +am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \ + $(ACLOCAL_M4) +mkinstalldirs = $(install_sh) -d +CONFIG_HEADER = $(top_builddir)/config.h +CONFIG_CLEAN_FILES = +CONFIG_CLEAN_VPATH_FILES = +AM_V_GEN = $(am__v_GEN_@AM_V@) +am__v_GEN_ = $(am__v_GEN_@AM_DEFAULT_V@) +am__v_GEN_0 = @echo " GEN " $@; +AM_V_at = $(am__v_at_@AM_V@) +am__v_at_ = $(am__v_at_@AM_DEFAULT_V@) +am__v_at_0 = @ +SOURCES = +DIST_SOURCES = +am__can_run_installinfo = \ + case $$AM_UPDATE_INFO_DIR in \ + n|no|NO) false;; \ + *) (install-info --version) >/dev/null 2>&1;; \ + esac +am__tty_colors = \ +red=; grn=; lgn=; blu=; std= +DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) +ACLOCAL = @ACLOCAL@ +AMTAR = @AMTAR@ +AM_DEFAULT_VERBOSITY = @AM_DEFAULT_VERBOSITY@ +AR = @AR@ +AUTOCONF = @AUTOCONF@ +AUTOHEADER = @AUTOHEADER@ +AUTOMAKE = @AUTOMAKE@ +AWK = @AWK@ +CC = @CC@ +CCDEPMODE = @CCDEPMODE@ +CFLAGS = @CFLAGS@ +CHECK_CFLAGS = @CHECK_CFLAGS@ +CHECK_LIBS = @CHECK_LIBS@ +CPP = @CPP@ +CPPFLAGS = @CPPFLAGS@ +CYGPATH_W = @CYGPATH_W@ +DBUS_INTERFACES_DIR = @DBUS_INTERFACES_DIR@ +DBUS_SERVICES_DIR = @DBUS_SERVICES_DIR@ +DEFS = @DEFS@ +DEPDIR = @DEPDIR@ +DLLTOOL = @DLLTOOL@ +DSYMUTIL = @DSYMUTIL@ +DUMPBIN = @DUMPBIN@ +ECHO_C = @ECHO_C@ +ECHO_N = @ECHO_N@ +ECHO_T = @ECHO_T@ +EGREP = @EGREP@ +EXEEXT = @EXEEXT@ +FGREP = @FGREP@ +GLIB_MKENUMS = @GLIB_MKENUMS@ +GREP = @GREP@ +GSIGNOND_CFLAGS = @GSIGNOND_CFLAGS@ +GSIGNOND_LIBS = @GSIGNOND_LIBS@ +GTKDOC_CHECK = @GTKDOC_CHECK@ +GTKDOC_DEPS_CFLAGS = @GTKDOC_DEPS_CFLAGS@ +GTKDOC_DEPS_LIBS = @GTKDOC_DEPS_LIBS@ +GTKDOC_MKPDF = @GTKDOC_MKPDF@ +GTKDOC_REBASE = @GTKDOC_REBASE@ +GTestDBus_CFLAGS = @GTestDBus_CFLAGS@ +GTestDBus_LIBS = @GTestDBus_LIBS@ +HTML_DIR = @HTML_DIR@ +INSTALL = @INSTALL@ +INSTALL_DATA = @INSTALL_DATA@ +INSTALL_PROGRAM = @INSTALL_PROGRAM@ +INSTALL_SCRIPT = @INSTALL_SCRIPT@ +INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@ +LD = @LD@ +LDFLAGS = @LDFLAGS@ +LIBECRYPTFS_CFLAGS = @LIBECRYPTFS_CFLAGS@ +LIBECRYPTFS_LIBS = @LIBECRYPTFS_LIBS@ +LIBOBJS = @LIBOBJS@ +LIBS = @LIBS@ +LIBSMACK_CFLAGS = @LIBSMACK_CFLAGS@ +LIBSMACK_LIBS = @LIBSMACK_LIBS@ +LIBTOOL = @LIBTOOL@ +LIPO = @LIPO@ +LN_S = @LN_S@ +LTLIBOBJS = @LTLIBOBJS@ +MAKEINFO = @MAKEINFO@ +MANIFEST_TOOL = @MANIFEST_TOOL@ +MESSAGE_BUS_TYPE = @MESSAGE_BUS_TYPE@ +MKDIR_P = @MKDIR_P@ +NM = @NM@ +NMEDIT = @NMEDIT@ +OBJDUMP = @OBJDUMP@ +OBJEXT = @OBJEXT@ +OTOOL = @OTOOL@ +OTOOL64 = @OTOOL64@ +PACKAGE = @PACKAGE@ +PACKAGE_BUGREPORT = @PACKAGE_BUGREPORT@ +PACKAGE_NAME = @PACKAGE_NAME@ +PACKAGE_STRING = @PACKAGE_STRING@ +PACKAGE_TARNAME = @PACKAGE_TARNAME@ +PACKAGE_URL = @PACKAGE_URL@ +PACKAGE_VERSION = @PACKAGE_VERSION@ +PATH_SEPARATOR = @PATH_SEPARATOR@ +PKG_CONFIG = @PKG_CONFIG@ +PKG_CONFIG_LIBDIR = @PKG_CONFIG_LIBDIR@ +PKG_CONFIG_PATH = @PKG_CONFIG_PATH@ +RANLIB = @RANLIB@ +SED = @SED@ +SET_MAKE = @SET_MAKE@ +SHELL = @SHELL@ +STRIP = @STRIP@ +VERSION = @VERSION@ +abs_builddir = @abs_builddir@ +abs_srcdir = @abs_srcdir@ +abs_top_builddir = @abs_top_builddir@ +abs_top_srcdir = @abs_top_srcdir@ +ac_ct_AR = @ac_ct_AR@ +ac_ct_CC = @ac_ct_CC@ +ac_ct_DUMPBIN = @ac_ct_DUMPBIN@ +am__include = @am__include@ +am__leading_dot = @am__leading_dot@ +am__quote = @am__quote@ +am__tar = @am__tar@ +am__untar = @am__untar@ +bindir = @bindir@ +build = @build@ +build_alias = @build_alias@ +build_cpu = @build_cpu@ +build_os = @build_os@ +build_vendor = @build_vendor@ +builddir = @builddir@ +datadir = @datadir@ +datarootdir = @datarootdir@ +docdir = @docdir@ +dvidir = @dvidir@ +exec_prefix = @exec_prefix@ +host = @host@ +host_alias = @host_alias@ +host_cpu = @host_cpu@ +host_os = @host_os@ +host_vendor = @host_vendor@ +htmldir = @htmldir@ +ifGNUmake = @ifGNUmake@ +includedir = @includedir@ +infodir = @infodir@ +install_sh = @install_sh@ +libdir = @libdir@ +libexecdir = @libexecdir@ +localedir = @localedir@ +localstatedir = @localstatedir@ +mandir = @mandir@ +mkdir_p = @mkdir_p@ +oldincludedir = @oldincludedir@ +pdfdir = @pdfdir@ +prefix = @prefix@ +program_transform_name = @program_transform_name@ +psdir = @psdir@ +sbindir = @sbindir@ +sharedstatedir = @sharedstatedir@ +srcdir = @srcdir@ +sysconfdir = @sysconfdir@ +target_alias = @target_alias@ +top_build_prefix = @top_build_prefix@ +top_builddir = @top_builddir@ +top_srcdir = @top_srcdir@ + +# 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 = gsignond + +# 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 + +# Directories containing the source code. +# gtk-doc will search all .c and .h files beneath these paths +# for inline comments documenting functions and macros. +# e.g. DOC_SOURCE_DIR=$(top_srcdir)/gtk $(top_srcdir)/gdk +DOC_SOURCE_DIR = $(top_srcdir)/include\ +$(top_srcdir)/src/common\ +$(top_srcdir)/src/plugins + + +# 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=--xml-mode --output-format=xml +MKDB_OPTIONS = --xml-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 = +CFILE_GLOB = + +# 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 or dirs to ignore when scanning. Use base file/dir names +# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h private_code +IGNORE_HFILES = \ +gsignond-disposable.h\ +gsignond-identity-info.h\ +gsignond-identity-info-internal.h\ +gsignond-pipe-stream.h\ +gsignond-plugin-enum-types.h\ +gsignond-plugin-loader.h\ +gsignond-db-defines.h\ +gsignond-db-error.h\ +gsignond-db-secret-database.h\ +gsignond-db-sql-database.h\ +gsignond-db-sql-database-private.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 = building.xml + +# 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 = +GTKDOC_LIBS = \ + $(top_builddir)/src/common/libgsignond-common.la\ + $(top_builddir)/src/plugins/digest/libdigest.la\ + $(top_builddir)/src/plugins/password/libpassword.la\ + $(top_builddir)/src/plugins/ssotest/libssotest.la + +@GTK_DOC_USE_LIBTOOL_FALSE@GTKDOC_CC = $(CC) $(INCLUDES) $(GTKDOC_DEPS_CFLAGS) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS) +@GTK_DOC_USE_LIBTOOL_TRUE@GTKDOC_CC = $(LIBTOOL) --tag=CC --mode=compile $(CC) $(INCLUDES) $(GTKDOC_DEPS_CFLAGS) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS) +@GTK_DOC_USE_LIBTOOL_FALSE@GTKDOC_LD = $(CC) $(GTKDOC_DEPS_LIBS) $(AM_CFLAGS) $(CFLAGS) $(AM_LDFLAGS) $(LDFLAGS) +@GTK_DOC_USE_LIBTOOL_TRUE@GTKDOC_LD = $(LIBTOOL) --tag=CC --mode=link $(CC) $(GTKDOC_DEPS_LIBS) $(AM_CFLAGS) $(CFLAGS) $(AM_LDFLAGS) $(LDFLAGS) +@GTK_DOC_USE_LIBTOOL_FALSE@GTKDOC_RUN = +@GTK_DOC_USE_LIBTOOL_TRUE@GTKDOC_RUN = $(LIBTOOL) --mode=execute + +# We set GPATH here; this gives us semantics for GNU make +# which are more like other make's VPATH, when it comes to +# whether a source that is a target of one rule is then +# searched for in VPATH/GPATH. +# +GPATH = $(srcdir) +TARGET_DIR = $(HTML_DIR)/$(DOC_MODULE) +SETUP_FILES = \ + $(content_files) \ + $(DOC_MAIN_SGML_FILE) \ + $(DOC_MODULE)-sections.txt \ + $(DOC_MODULE)-overrides.txt + + +# This includes the standard gtk-doc make rules, copied by gtkdocize. + +# Other files to distribute +# e.g. EXTRA_DIST += version.xml.in +EXTRA_DIST = $(HTML_IMAGES) $(SETUP_FILES) +DOC_STAMPS = setup-build.stamp scan-build.stamp tmpl-build.stamp sgml-build.stamp \ + html-build.stamp pdf-build.stamp \ + tmpl.stamp sgml.stamp html.stamp pdf.stamp + +SCANOBJ_FILES = \ + $(DOC_MODULE).args \ + $(DOC_MODULE).hierarchy \ + $(DOC_MODULE).interfaces \ + $(DOC_MODULE).prerequisites \ + $(DOC_MODULE).signals + +REPORT_FILES = \ + $(DOC_MODULE)-undocumented.txt \ + $(DOC_MODULE)-undeclared.txt \ + $(DOC_MODULE)-unused.txt + +CLEANFILES = $(SCANOBJ_FILES) $(REPORT_FILES) $(DOC_STAMPS) +@ENABLE_GTK_DOC_TRUE@@GTK_DOC_BUILD_HTML_FALSE@HTML_BUILD_STAMP = +@ENABLE_GTK_DOC_TRUE@@GTK_DOC_BUILD_HTML_TRUE@HTML_BUILD_STAMP = html-build.stamp +@ENABLE_GTK_DOC_TRUE@@GTK_DOC_BUILD_PDF_FALSE@PDF_BUILD_STAMP = +@ENABLE_GTK_DOC_TRUE@@GTK_DOC_BUILD_PDF_TRUE@PDF_BUILD_STAMP = pdf-build.stamp + +#### setup #### +GTK_DOC_V_SETUP = $(GTK_DOC_V_SETUP_$(V)) +GTK_DOC_V_SETUP_ = $(GTK_DOC_V_SETUP_$(AM_DEFAULT_VERBOSITY)) +GTK_DOC_V_SETUP_0 = @echo " DOC Preparing build"; + +#### scan #### +GTK_DOC_V_SCAN = $(GTK_DOC_V_SCAN_$(V)) +GTK_DOC_V_SCAN_ = $(GTK_DOC_V_SCAN_$(AM_DEFAULT_VERBOSITY)) +GTK_DOC_V_SCAN_0 = @echo " DOC Scanning header files"; +GTK_DOC_V_INTROSPECT = $(GTK_DOC_V_INTROSPECT_$(V)) +GTK_DOC_V_INTROSPECT_ = $(GTK_DOC_V_INTROSPECT_$(AM_DEFAULT_VERBOSITY)) +GTK_DOC_V_INTROSPECT_0 = @echo " DOC Introspecting gobjects"; + +#### templates #### +GTK_DOC_V_TMPL = $(GTK_DOC_V_TMPL_$(V)) +GTK_DOC_V_TMPL_ = $(GTK_DOC_V_TMPL_$(AM_DEFAULT_VERBOSITY)) +GTK_DOC_V_TMPL_0 = @echo " DOC Rebuilding template files"; + +#### xml #### +GTK_DOC_V_XML = $(GTK_DOC_V_XML_$(V)) +GTK_DOC_V_XML_ = $(GTK_DOC_V_XML_$(AM_DEFAULT_VERBOSITY)) +GTK_DOC_V_XML_0 = @echo " DOC Building XML"; + +#### html #### +GTK_DOC_V_HTML = $(GTK_DOC_V_HTML_$(V)) +GTK_DOC_V_HTML_ = $(GTK_DOC_V_HTML_$(AM_DEFAULT_VERBOSITY)) +GTK_DOC_V_HTML_0 = @echo " DOC Building HTML"; +GTK_DOC_V_XREF = $(GTK_DOC_V_XREF_$(V)) +GTK_DOC_V_XREF_ = $(GTK_DOC_V_XREF_$(AM_DEFAULT_VERBOSITY)) +GTK_DOC_V_XREF_0 = @echo " DOC Fixing cross-references"; + +#### pdf #### +GTK_DOC_V_PDF = $(GTK_DOC_V_PDF_$(V)) +GTK_DOC_V_PDF_ = $(GTK_DOC_V_PDF_$(AM_DEFAULT_VERBOSITY)) +GTK_DOC_V_PDF_0 = @echo " DOC Building PDF"; + +# 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 'make check' to test you doc status +# and run some sanity checks +@ENABLE_GTK_DOC_TRUE@TESTS_ENVIRONMENT = cd $(srcdir) && \ +@ENABLE_GTK_DOC_TRUE@ DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \ +@ENABLE_GTK_DOC_TRUE@ SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir) + +@ENABLE_GTK_DOC_TRUE@TESTS = $(GTKDOC_CHECK) +all: all-am + +.SUFFIXES: +$(srcdir)/Makefile.in: $(srcdir)/Makefile.am $(top_srcdir)/gtk-doc.make $(am__configure_deps) + @for dep in $?; do \ + case '$(am__configure_deps)' in \ + *$$dep*) \ + ( cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh ) \ + && { if test -f $@; then exit 0; else break; fi; }; \ + exit 1;; \ + esac; \ + done; \ + echo ' cd $(top_srcdir) && $(AUTOMAKE) --gnu docs/Makefile'; \ + $(am__cd) $(top_srcdir) && \ + $(AUTOMAKE) --gnu docs/Makefile +.PRECIOUS: Makefile +Makefile: $(srcdir)/Makefile.in $(top_builddir)/config.status + @case '$?' in \ + *config.status*) \ + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh;; \ + *) \ + echo ' cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe)'; \ + cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe);; \ + esac; +$(top_srcdir)/gtk-doc.make: + +$(top_builddir)/config.status: $(top_srcdir)/configure $(CONFIG_STATUS_DEPENDENCIES) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh + +$(top_srcdir)/configure: $(am__configure_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh +$(ACLOCAL_M4): $(am__aclocal_m4_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh +$(am__aclocal_m4_deps): + +mostlyclean-libtool: + -rm -f *.lo + +clean-libtool: + -rm -rf .libs _libs +tags: TAGS +TAGS: + +ctags: CTAGS +CTAGS: + + +check-TESTS: $(TESTS) + @failed=0; all=0; xfail=0; xpass=0; skip=0; \ + srcdir=$(srcdir); export srcdir; \ + list=' $(TESTS) '; \ + $(am__tty_colors); \ + if test -n "$$list"; then \ + for tst in $$list; do \ + if test -f ./$$tst; then dir=./; \ + elif test -f $$tst; then dir=; \ + else dir="$(srcdir)/"; fi; \ + if $(TESTS_ENVIRONMENT) $${dir}$$tst; then \ + all=`expr $$all + 1`; \ + case " $(XFAIL_TESTS) " in \ + *[\ \ ]$$tst[\ \ ]*) \ + xpass=`expr $$xpass + 1`; \ + failed=`expr $$failed + 1`; \ + col=$$red; res=XPASS; \ + ;; \ + *) \ + col=$$grn; res=PASS; \ + ;; \ + esac; \ + elif test $$? -ne 77; then \ + all=`expr $$all + 1`; \ + case " $(XFAIL_TESTS) " in \ + *[\ \ ]$$tst[\ \ ]*) \ + xfail=`expr $$xfail + 1`; \ + col=$$lgn; res=XFAIL; \ + ;; \ + *) \ + failed=`expr $$failed + 1`; \ + col=$$red; res=FAIL; \ + ;; \ + esac; \ + else \ + skip=`expr $$skip + 1`; \ + col=$$blu; res=SKIP; \ + fi; \ + echo "$${col}$$res$${std}: $$tst"; \ + done; \ + if test "$$all" -eq 1; then \ + tests="test"; \ + All=""; \ + else \ + tests="tests"; \ + All="All "; \ + fi; \ + if test "$$failed" -eq 0; then \ + if test "$$xfail" -eq 0; then \ + banner="$$All$$all $$tests passed"; \ + else \ + if test "$$xfail" -eq 1; then failures=failure; else failures=failures; fi; \ + banner="$$All$$all $$tests behaved as expected ($$xfail expected $$failures)"; \ + fi; \ + else \ + if test "$$xpass" -eq 0; then \ + banner="$$failed of $$all $$tests failed"; \ + else \ + if test "$$xpass" -eq 1; then passes=pass; else passes=passes; fi; \ + banner="$$failed of $$all $$tests did not behave as expected ($$xpass unexpected $$passes)"; \ + fi; \ + fi; \ + dashes="$$banner"; \ + skipped=""; \ + if test "$$skip" -ne 0; then \ + if test "$$skip" -eq 1; then \ + skipped="($$skip test was not run)"; \ + else \ + skipped="($$skip tests were not run)"; \ + fi; \ + test `echo "$$skipped" | wc -c` -le `echo "$$banner" | wc -c` || \ + dashes="$$skipped"; \ + fi; \ + report=""; \ + if test "$$failed" -ne 0 && test -n "$(PACKAGE_BUGREPORT)"; then \ + report="Please report to $(PACKAGE_BUGREPORT)"; \ + test `echo "$$report" | wc -c` -le `echo "$$banner" | wc -c` || \ + dashes="$$report"; \ + fi; \ + dashes=`echo "$$dashes" | sed s/./=/g`; \ + if test "$$failed" -eq 0; then \ + col="$$grn"; \ + else \ + col="$$red"; \ + fi; \ + echo "$${col}$$dashes$${std}"; \ + echo "$${col}$$banner$${std}"; \ + test -z "$$skipped" || echo "$${col}$$skipped$${std}"; \ + test -z "$$report" || echo "$${col}$$report$${std}"; \ + echo "$${col}$$dashes$${std}"; \ + test "$$failed" -eq 0; \ + else :; fi + +distdir: $(DISTFILES) + @srcdirstrip=`echo "$(srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ + topsrcdirstrip=`echo "$(top_srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ + list='$(DISTFILES)'; \ + dist_files=`for file in $$list; do echo $$file; done | \ + sed -e "s|^$$srcdirstrip/||;t" \ + -e "s|^$$topsrcdirstrip/|$(top_builddir)/|;t"`; \ + case $$dist_files in \ + */*) $(MKDIR_P) `echo "$$dist_files" | \ + sed '/\//!d;s|^|$(distdir)/|;s,/[^/]*$$,,' | \ + sort -u` ;; \ + esac; \ + for file in $$dist_files; do \ + if test -f $$file || test -d $$file; then d=.; else d=$(srcdir); fi; \ + if test -d $$d/$$file; then \ + dir=`echo "/$$file" | sed -e 's,/[^/]*$$,,'`; \ + if test -d "$(distdir)/$$file"; then \ + find "$(distdir)/$$file" -type d ! -perm -700 -exec chmod u+rwx {} \;; \ + fi; \ + if test -d $(srcdir)/$$file && test $$d != $(srcdir); then \ + cp -fpR $(srcdir)/$$file "$(distdir)$$dir" || exit 1; \ + find "$(distdir)/$$file" -type d ! -perm -700 -exec chmod u+rwx {} \;; \ + fi; \ + cp -fpR $$d/$$file "$(distdir)$$dir" || exit 1; \ + else \ + test -f "$(distdir)/$$file" \ + || cp -p $$d/$$file "$(distdir)/$$file" \ + || exit 1; \ + fi; \ + done + $(MAKE) $(AM_MAKEFLAGS) \ + top_distdir="$(top_distdir)" distdir="$(distdir)" \ + dist-hook +check-am: all-am + $(MAKE) $(AM_MAKEFLAGS) check-TESTS +check: check-am +all-am: Makefile all-local +installdirs: +install: install-am +install-exec: install-exec-am +install-data: install-data-am +uninstall: uninstall-am + +install-am: all-am + @$(MAKE) $(AM_MAKEFLAGS) install-exec-am install-data-am + +installcheck: installcheck-am +install-strip: + if test -z '$(STRIP)'; then \ + $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ + install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ + install; \ + else \ + $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ + install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ + "INSTALL_PROGRAM_ENV=STRIPPROG='$(STRIP)'" install; \ + fi +mostlyclean-generic: + +clean-generic: + -test -z "$(CLEANFILES)" || rm -f $(CLEANFILES) + +distclean-generic: + -test -z "$(CONFIG_CLEAN_FILES)" || rm -f $(CONFIG_CLEAN_FILES) + -test . = "$(srcdir)" || test -z "$(CONFIG_CLEAN_VPATH_FILES)" || rm -f $(CONFIG_CLEAN_VPATH_FILES) + +maintainer-clean-generic: + @echo "This command is intended for maintainers to use" + @echo "it deletes files that may require special tools to rebuild." +clean: clean-am + +clean-am: clean-generic clean-libtool clean-local mostlyclean-am + +distclean: distclean-am + -rm -f Makefile +distclean-am: clean-am distclean-generic distclean-local + +dvi: dvi-am + +dvi-am: + +html: html-am + +html-am: + +info: info-am + +info-am: + +install-data-am: install-data-local + +install-dvi: install-dvi-am + +install-dvi-am: + +install-exec-am: + +install-html: install-html-am + +install-html-am: + +install-info: install-info-am + +install-info-am: + +install-man: + +install-pdf: install-pdf-am + +install-pdf-am: + +install-ps: install-ps-am + +install-ps-am: + +installcheck-am: + +maintainer-clean: maintainer-clean-am + -rm -f Makefile +maintainer-clean-am: distclean-am maintainer-clean-generic \ + maintainer-clean-local + +mostlyclean: mostlyclean-am + +mostlyclean-am: mostlyclean-generic mostlyclean-libtool + +pdf: pdf-am + +pdf-am: + +ps: ps-am + +ps-am: + +uninstall-am: uninstall-local + +.MAKE: check-am install-am install-strip + +.PHONY: all all-am all-local check check-TESTS check-am clean \ + clean-generic clean-libtool clean-local dist-hook distclean \ + distclean-generic distclean-libtool distclean-local distdir \ + dvi dvi-am html html-am info info-am install install-am \ + install-data install-data-am install-data-local install-dvi \ + install-dvi-am install-exec install-exec-am install-html \ + install-html-am install-info install-info-am install-man \ + install-pdf install-pdf-am install-ps install-ps-am \ + install-strip installcheck installcheck-am installdirs \ + maintainer-clean maintainer-clean-generic \ + maintainer-clean-local mostlyclean mostlyclean-generic \ + mostlyclean-libtool pdf pdf-am ps ps-am uninstall uninstall-am \ + uninstall-local + + +@ENABLE_GTK_DOC_TRUE@all-local: $(HTML_BUILD_STAMP) $(PDF_BUILD_STAMP) +@ENABLE_GTK_DOC_FALSE@all-local: + +docs: $(HTML_BUILD_STAMP) $(PDF_BUILD_STAMP) + +$(REPORT_FILES): sgml-build.stamp + +setup-build.stamp: + -$(GTK_DOC_V_SETUP)if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \ + files=`echo $(SETUP_FILES) $(expand_content_files) $(DOC_MODULE).types`; \ + if test "x$$files" != "x" ; then \ + for file in $$files ; do \ + test -f $(abs_srcdir)/$$file && \ + cp -pu $(abs_srcdir)/$$file $(abs_builddir)/$$file || true; \ + done; \ + fi; \ + test -d $(abs_srcdir)/tmpl && \ + { cp -rp $(abs_srcdir)/tmpl $(abs_builddir)/; \ + chmod -R u+w $(abs_builddir)/tmpl; } \ + fi + $(AM_V_at)touch setup-build.stamp + +scan-build.stamp: $(HFILE_GLOB) $(CFILE_GLOB) + $(GTK_DOC_V_SCAN)_source_dir='' ; \ + for i in $(DOC_SOURCE_DIR) ; do \ + _source_dir="$${_source_dir} --source-dir=$$i" ; \ + done ; \ + gtkdoc-scan --module=$(DOC_MODULE) --ignore-headers="$(IGNORE_HFILES)" $${_source_dir} $(SCAN_OPTIONS) $(EXTRA_HFILES) + $(GTK_DOC_V_INTROSPECT)if grep -l '^..*$$' $(DOC_MODULE).types > /dev/null 2>&1 ; then \ + scanobj_options=""; \ + gtkdoc-scangobj 2>&1 --help | grep >/dev/null "\-\-verbose"; \ + if test "$(?)" = "0"; then \ + if test "x$(V)" = "x1"; then \ + scanobj_options="--verbose"; \ + fi; \ + fi; \ + CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" RUN="$(GTKDOC_RUN)" CFLAGS="$(GTKDOC_CFLAGS) $(CFLAGS)" LDFLAGS="$(GTKDOC_LIBS) $(LDFLAGS)" \ + gtkdoc-scangobj $(SCANGOBJ_OPTIONS) $$scanobj_options --module=$(DOC_MODULE); \ + else \ + for i in $(SCANOBJ_FILES) ; do \ + test -f $$i || touch $$i ; \ + done \ + fi + $(AM_V_at)touch scan-build.stamp + +$(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt: scan-build.stamp + @true + +tmpl-build.stamp: setup-build.stamp $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt + $(GTK_DOC_V_TMPL)gtkdoc-mktmpl --module=$(DOC_MODULE) $(MKTMPL_OPTIONS) + $(AM_V_at)if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \ + if test -w $(abs_srcdir) ; then \ + cp -rp $(abs_builddir)/tmpl $(abs_srcdir)/; \ + fi \ + fi + $(AM_V_at)touch tmpl-build.stamp + +tmpl.stamp: tmpl-build.stamp + @true + +$(srcdir)/tmpl/*.sgml: + @true + +sgml-build.stamp: tmpl.stamp $(DOC_MODULE)-sections.txt $(srcdir)/tmpl/*.sgml $(expand_content_files) + -$(GTK_DOC_V_XML)chmod -R u+w $(srcdir) && _source_dir='' ; \ + for i in $(DOC_SOURCE_DIR) ; do \ + _source_dir="$${_source_dir} --source-dir=$$i" ; \ + done ; \ + gtkdoc-mkdb --module=$(DOC_MODULE) --output-format=xml --expand-content-files="$(expand_content_files)" --main-sgml-file=$(DOC_MAIN_SGML_FILE) $${_source_dir} $(MKDB_OPTIONS) + $(AM_V_at)touch sgml-build.stamp + +sgml.stamp: sgml-build.stamp + @true + +html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files) + $(GTK_DOC_V_HTML)rm -rf html && mkdir html && \ + mkhtml_options=""; \ + gtkdoc-mkhtml 2>&1 --help | grep >/dev/null "\-\-verbose"; \ + if test "$(?)" = "0"; then \ + if test "x$(V)" = "x1"; then \ + mkhtml_options="$$mkhtml_options --verbose"; \ + fi; \ + fi; \ + gtkdoc-mkhtml 2>&1 --help | grep >/dev/null "\-\-path"; \ + if test "$(?)" = "0"; then \ + mkhtml_options="$$mkhtml_options --path=\"$(abs_srcdir)\""; \ + fi; \ + cd html && gtkdoc-mkhtml $$mkhtml_options $(MKHTML_OPTIONS) $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE) + -@test "x$(HTML_IMAGES)" = "x" || \ + for file in $(HTML_IMAGES) ; do \ + if test -f $(abs_srcdir)/$$file ; then \ + cp $(abs_srcdir)/$$file $(abs_builddir)/html; \ + fi; \ + if test -f $(abs_builddir)/$$file ; then \ + cp $(abs_builddir)/$$file $(abs_builddir)/html; \ + fi; \ + done; + $(GTK_DOC_V_XREF)gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS) + $(AM_V_at)touch html-build.stamp + +pdf-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files) + $(GTK_DOC_V_PDF)rm -f $(DOC_MODULE).pdf && \ + mkpdf_options=""; \ + gtkdoc-mkpdf 2>&1 --help | grep >/dev/null "\-\-verbose"; \ + if test "$(?)" = "0"; then \ + if test "x$(V)" = "x1"; then \ + mkpdf_options="$$mkpdf_options --verbose"; \ + fi; \ + fi; \ + if test "x$(HTML_IMAGES)" != "x"; then \ + for img in $(HTML_IMAGES); do \ + part=`dirname $$img`; \ + echo $$mkpdf_options | grep >/dev/null "\-\-imgdir=$$part "; \ + if test $$? != 0; then \ + mkpdf_options="$$mkpdf_options --imgdir=$$part"; \ + fi; \ + done; \ + fi; \ + gtkdoc-mkpdf --path="$(abs_srcdir)" $$mkpdf_options $(DOC_MODULE) $(DOC_MAIN_SGML_FILE) $(MKPDF_OPTIONS) + $(AM_V_at)touch pdf-build.stamp + +############## + +clean-local: + @rm -f *~ *.bak + @rm -rf .libs + +distclean-local: + @rm -rf xml html $(REPORT_FILES) $(DOC_MODULE).pdf \ + $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt + @if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \ + rm -f $(SETUP_FILES) $(expand_content_files) $(DOC_MODULE).types; \ + rm -rf tmpl; \ + fi + +maintainer-clean-local: + @rm -rf xml html + +install-data-local: + @installfiles=`echo $(builddir)/html/*`; \ + if test "$$installfiles" = '$(builddir)/html/*'; \ + then echo 1>&2 'Nothing to install' ; \ + else \ + if test -n "$(DOC_MODULE_VERSION)"; then \ + installdir="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \ + else \ + installdir="$(DESTDIR)$(TARGET_DIR)"; \ + fi; \ + $(mkinstalldirs) $${installdir} ; \ + for i in $$installfiles; do \ + echo ' $(INSTALL_DATA) '$$i ; \ + $(INSTALL_DATA) $$i $${installdir}; \ + done; \ + if test -n "$(DOC_MODULE_VERSION)"; then \ + mv -f $${installdir}/$(DOC_MODULE).devhelp2 \ + $${installdir}/$(DOC_MODULE)-$(DOC_MODULE_VERSION).devhelp2; \ + fi; \ + $(GTKDOC_REBASE) --relative --dest-dir=$(DESTDIR) --html-dir=$${installdir}; \ + fi + +uninstall-local: + @if test -n "$(DOC_MODULE_VERSION)"; then \ + installdir="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \ + else \ + installdir="$(DESTDIR)$(TARGET_DIR)"; \ + fi; \ + rm -rf $${installdir} + +# +# Require gtk-doc when making dist +# +@ENABLE_GTK_DOC_TRUE@dist-check-gtkdoc: docs +@ENABLE_GTK_DOC_FALSE@dist-check-gtkdoc: +@ENABLE_GTK_DOC_FALSE@ @echo "*** gtk-doc must be installed and enabled in order to make dist" +@ENABLE_GTK_DOC_FALSE@ @false + +dist-hook: dist-check-gtkdoc dist-hook-local + @mkdir $(distdir)/tmpl + @mkdir $(distdir)/html + @-cp ./tmpl/*.sgml $(distdir)/tmpl + @cp ./html/* $(distdir)/html + @-cp ./$(DOC_MODULE).pdf $(distdir)/ + @-cp ./$(DOC_MODULE).types $(distdir)/ + @-cp ./$(DOC_MODULE)-sections.txt $(distdir)/ + @cd $(distdir) && rm -f $(DISTCLEANFILES) + @$(GTKDOC_REBASE) --online --relative --html-dir=$(distdir)/html + +.PHONY : dist-hook-local docs + +# Tell versions [3.59,3.63) of GNU make to not export all variables. +# Otherwise a system limit (for SysV at least) may be exceeded. +.NOEXPORT: diff --git a/docs/building.xml b/docs/building.xml new file mode 100644 index 0000000..66ea61e --- /dev/null +++ b/docs/building.xml @@ -0,0 +1,180 @@ +<?xml version="1.0"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<refentry id="gsignond-building"> + <refmeta> + <refentrytitle>Building and installing the gsignond daemon</refentrytitle> + <manvolnum>3</manvolnum> + <refmiscinfo>GSignond</refmiscinfo> + </refmeta> + + <refsect1 id="building"> + <title>Building gsignond</title> + <para> + GSignond uses the standard GNU build system, + using <application>autoconf</application> for package + configuration and resolving portability issues, + <application>automake</application> for building makefiles + that comply with the GNU Coding Standards, and + <application>libtool</application> for building shared + libraries on multiple platforms. The normal sequence for + compiling and installing gsignond from distribution tarballs is thus: + + <literallayout> + <userinput>./configure</userinput> + <userinput>make</userinput> + <userinput>make install</userinput> + </literallayout> + + If you have obtained the source code directly from git repository, + execute the <command>./autogen.sh</command> script + before the steps above. + </para> + + <para> + The standard options provided by <application>GNU + autoconf</application> may be passed to the + <command>configure</command> script. Please see the + <application>autoconf</application> documentation or run + <command>./configure --help</command> for information about + the standard options. + </para> + + </refsect1> + <refsect1 id="dependencies"> + <title>Dependencies</title> + <para> + Before you can compile GSignond, you need to have + various other tools and libraries installed on your + system. The two tools needed during the build process + are <command>pkg-config</command> and + <ulink url="http://www.gnu.org/software/make">GNU make</ulink>. + </para> + <itemizedlist> + <listitem> + <para> + <ulink url="http://www.freedesktop.org/software/pkgconfig/">pkg-config</ulink> + is a tool for tracking the compilation flags needed for + libraries that are used by the GSignond. (For each + library, a small <literal>.pc</literal> text file is + installed in a standard location that contains the compilation + flags needed for that library along with version number + information.) + </para> + </listitem> + </itemizedlist> + <para> + GSignond depends on a number of other libraries. + </para> + <itemizedlist> + <listitem> + <para> + The <ulink url="https://developer.gnome.org/glib/">GLib + library</ulink> is the development framework that GSignond is built on. + </para> + </listitem> + <listitem> + <para> + The <ulink url="http://www.sqlite.org/">SQLite library</ulink> + provides a database implementation that GSignond is using for + storing data. + </para> + </listitem> + <listitem> + <para> + The <ulink url="http://check.sourceforge.net/">check library</ulink> + provides a unit testing framework. It is needed only if you would + like to run unit tests with <command>make check</command>. + </para> + </listitem> + <listitem> + <para> + For building Tizen extension module that integrates gsignond into + the Tizen platform, the + <ulink url="http://schaufler-ca.com/">libsmack</ulink> and + <ulink url="http://ecryptfs.org/">ecryptfs</ulink> are required. + They are not needed otherwise. + </para> + </listitem> + </itemizedlist> + + </refsect1> + <refsect1 id="extra-configuration-options"> + <title>Extra Configuration Options</title> + + <para> + In addition to the normal options, the + <command>configure</command> script supports these additional arguments: + </para> + + <formalpara> + <title><systemitem>--enable-debug</systemitem></title> + + <para> + Turns on debugging support. This enables unit tests and allows setting + environment variables to influence the runtime behaviour of GSignond + (see <link linkend="GSignondConfig">GSignondConfig</link> and + <link linkend="GSignondAccessControlManager">GSignondAccessControlManager</link>). + Also, the daemon will exit in case of critical errors. + </para> + </formalpara> + + <formalpara> + <title><systemitem>--enable-sql-log</systemitem></title> + + <para> + Turns on SQL statement logging. For this, also + <systemitem>--enable-debug</systemitem> must be used. + </para> + </formalpara> + + <formalpara> + <title><systemitem>--enable-dbus-type=dbus-type</systemitem></title> + + <para> + Sets the way in which GSignond is using DBus to communicate with + the client library. <systemitem>dbus-type</systemitem> can be one of + <itemizedlist> + <listitem> + <para> + <systemitem>'p2p'</systemitem> which is the default and recommended + value. GSignond will use direct connection over a UNIX domain socket + with the client library without involving the DBus daemon. + </para> + </listitem> + <listitem> + <para> + <systemitem>'session'</systemitem> which will use the session bus. + This is not recommended to use because session bus isn't secure + against eavesdropping, but it can be used for debugging purposes, + as it allows the use of standard tools such as + <command>dbus-monitor</command>, <command>d-feet</command> and + so on. + </para> + </listitem> + <listitem> + <para> + <systemitem>'system'</systemitem> which will use the system bus. + Can be used on a single-user systems, but 'p2p' is preferred. + </para> + </listitem> + </itemizedlist> + </para> + </formalpara> + + </refsect1> + <refsect1 id="building-packages"> + <title>Building distribution packages</title> + + <para> + Instead of running <command>make install</command> to install gsignond + into a system location it is possible to build distribution-specific + packages. <filename>dists/</filename> directory in the source tree + contains a number of package confuguration files, and to use them also + a distribution tarball is needed. If you are building from a git tree, + use <command>make dist</command> to create such a tarball. + </para> + </refsect1> + +</refentry> diff --git a/docs/gsignond-docs.sgml b/docs/gsignond-docs.sgml new file mode 100644 index 0000000..abd68c2 --- /dev/null +++ b/docs/gsignond-docs.sgml @@ -0,0 +1,77 @@ +<?xml version="1.0"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" + "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" +[ + <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'"> +]> +<book id="index"> + <bookinfo> + <title>gsignond API Reference Manual</title> + <releaseinfo> + for gsignond daemon. + The latest version of this documentation can be found on-line at + <ulink role="online-location" url="http://gsignon-docs.accounts-sso.googlecode.com/git/gsignond/index.html"> + http://gsignon-docs.accounts-sso.googlecode.com/git/gsignond/index.html</ulink>. + </releaseinfo> + </bookinfo> + + <chapter> + <title>GSignond building and installation</title> + <xi:include href="building.xml"/> + </chapter> + + <chapter> + <title>GSignond configuration</title> + <xi:include href="xml/gsignond-config.xml"/> + <xi:include href="xml/gsignond-config-general.xml"/> + <xi:include href="xml/gsignond-config-db.xml"/> + <xi:include href="xml/gsignond-config-dbus.xml"/> + </chapter> + + <chapter> + <title>GSignond API for writing authentication plugins</title> + <xi:include href="xml/gsignond-plugin-interface.xml"/> + <xi:include href="xml/gsignond-dictionary.xml"/> + <xi:include href="xml/gsignond-session-data.xml"/> + <xi:include href="xml/gsignond-signonui-data.xml"/> + </chapter> + + <chapter> + <title>Standard in-tree authentication plugins</title> + <xi:include href="xml/gsignond-digest-plugin.xml"/> + <xi:include href="xml/gsignond-ssotest-plugin.xml"/> + <xi:include href="xml/gsignond-password-plugin.xml"/> + + </chapter> + + <chapter> + <title>GSignond API for writing platform adaptation extensions</title> + <xi:include href="xml/gsignond-extension-interface.xml"/> + <xi:include href="xml/gsignond-access-control-manager.xml"/> + <xi:include href="xml/gsignond-security-context.xml"/> + <xi:include href="xml/gsignond-storage-manager.xml"/> + <xi:include href="xml/gsignond-secret-storage.xml"/> + <xi:include href="xml/gsignond-credentials.xml"/> + </chapter> + <chapter> + <title>Miscellaneous</title> + <xi:include href="xml/gsignond-error.xml"/> + <xi:include href="xml/gsignond-log.xml"/> + <xi:include href="xml/gsignond-utils.xml"/> + </chapter> + + <chapter id="object-tree"> + <title>Object Hierarchy</title> + <xi:include href="xml/tree_index.sgml"/> + </chapter> + <index id="api-index-full"> + <title>API Index</title> + <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include> + </index> + <index id="deprecated-api-index" role="deprecated"> + <title>Index of deprecated API</title> + <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include> + </index> + + <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include> +</book> diff --git a/docs/gsignond-overrides.txt b/docs/gsignond-overrides.txt new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/docs/gsignond-overrides.txt diff --git a/docs/gsignond-sections.txt b/docs/gsignond-sections.txt new file mode 100644 index 0000000..d97978a --- /dev/null +++ b/docs/gsignond-sections.txt @@ -0,0 +1,391 @@ +<SECTION> +<FILE>gsignond-access-control-manager</FILE> +<TITLE>GSignondAccessControlManager</TITLE> +GSignondAccessControlManager +GSignondAccessControlManagerClass +gsignond_access_control_manager_acl_is_valid +gsignond_access_control_manager_peer_is_allowed_to_use_identity +gsignond_access_control_manager_peer_is_owner_of_identity +gsignond_access_control_manager_security_context_of_keychain +gsignond_access_control_manager_security_context_of_peer +<SUBSECTION Standard> +GSIGNOND_ACCESS_CONTROL_MANAGER +GSIGNOND_ACCESS_CONTROL_MANAGER_CLASS +GSIGNOND_ACCESS_CONTROL_MANAGER_GET_CLASS +GSIGNOND_IS_ACCESS_CONTROL_MANAGER +GSIGNOND_IS_ACCESS_CONTROL_MANAGER_CLASS +GSIGNOND_TYPE_ACCESS_CONTROL_MANAGER +gsignond_access_control_manager_get_type +</SECTION> + +<SECTION> +<FILE>gsignond-config</FILE> +<TITLE>GSignondConfig</TITLE> +GSignondConfig +GSignondConfigClass +gsignond_config_get_integer +gsignond_config_get_string +gsignond_config_new +gsignond_config_set_integer +gsignond_config_set_string +<SUBSECTION Standard> +GSIGNOND_CONFIG +GSIGNOND_CONFIG_CLASS +GSIGNOND_CONFIG_GET_CLASS +GSIGNOND_IS_CONFIG +GSIGNOND_IS_CONFIG_CLASS +GSIGNOND_TYPE_CONFIG +GSignondConfigPrivate +gsignond_config_get_type +</SECTION> + +<SECTION> +<FILE>gsignond-config-db</FILE> +GSIGNOND_CONFIG_DB_METADATA_DB_FILENAME +GSIGNOND_CONFIG_DB_SECRET_DB_FILENAME +GSIGNOND_CONFIG_DB_SSO +</SECTION> + +<SECTION> +<FILE>gsignond-config-dbus</FILE> +GSIGNOND_CONFIG_DBUS_AUTH_SESSION_TIMEOUT +GSIGNOND_CONFIG_DBUS_DAEMON_TIMEOUT +GSIGNOND_CONFIG_DBUS_IDENTITY_TIMEOUT +GSIGNOND_CONFIG_DBUS_TIMEOUTS +</SECTION> + +<SECTION> +<FILE>gsignond-config-general</FILE> +GSIGNOND_CONFIG_GENERAL +GSIGNOND_CONFIG_GENERAL_BIN_DIR +GSIGNOND_CONFIG_GENERAL_EXTENSION +GSIGNOND_CONFIG_GENERAL_EXTENSIONS_DIR +GSIGNOND_CONFIG_GENERAL_PLUGINS_DIR +GSIGNOND_CONFIG_GENERAL_SECURE_DIR +GSIGNOND_CONFIG_GENERAL_STORAGE_PATH +GSIGNOND_CONFIG_PLUGIN_TIMEOUT +</SECTION> + +<SECTION> +<FILE>gsignond-credentials</FILE> +<TITLE>GSignondCredentials</TITLE> +GSignondCredentials +GSignondCredentialsClass +gsignond_credentials_equal +gsignond_credentials_get_id +gsignond_credentials_get_password +gsignond_credentials_get_username +gsignond_credentials_new +gsignond_credentials_set_data +gsignond_credentials_set_id +gsignond_credentials_set_password +gsignond_credentials_set_username +<SUBSECTION Standard> +GSIGNOND_CREDENTIALS +GSIGNOND_CREDENTIALS_CLASS +GSIGNOND_CREDENTIALS_GET_CLASS +GSIGNOND_IS_CREDENTIALS +GSIGNOND_IS_CREDENTIALS_CLASS +GSIGNOND_TYPE_CREDENTIALS +GSignondCredentialsPrivate +gsignond_credentials_get_type +</SECTION> + +<SECTION> +<FILE>gsignond-dictionary</FILE> +GSignondDictionary +gsignond_dictionary_copy +gsignond_dictionary_get +gsignond_dictionary_get_boolean +gsignond_dictionary_get_int32 +gsignond_dictionary_get_int64 +gsignond_dictionary_get_string +gsignond_dictionary_get_uint32 +gsignond_dictionary_get_uint64 +gsignond_dictionary_new +gsignond_dictionary_new_from_variant +gsignond_dictionary_ref +gsignond_dictionary_remove +gsignond_dictionary_set +gsignond_dictionary_set_boolean +gsignond_dictionary_set_int32 +gsignond_dictionary_set_int64 +gsignond_dictionary_set_string +gsignond_dictionary_set_uint32 +gsignond_dictionary_set_uint64 +gsignond_dictionary_to_variant +gsignond_dictionary_unref +<SUBSECTION Standard> +GSIGNOND_DICTIONARY +GSIGNOND_IS_DICTIONARY +GSIGNOND_TYPE_DICTIONARY +</SECTION> + +<SECTION> +<FILE>gsignond-digest-plugin</FILE> +<TITLE>GSignondDigestPlugin</TITLE> +GSignondDigestPlugin +GSignondDigestPluginClass +<SUBSECTION Standard> +GSIGNOND_DIGEST_PLUGIN +GSIGNOND_DIGEST_PLUGIN_CLASS +GSIGNOND_DIGEST_PLUGIN_GET_CLASS +GSIGNOND_IS_DIGEST_PLUGIN +GSIGNOND_IS_DIGEST_PLUGIN_CLASS +GSIGNOND_TYPE_DIGEST_PLUGIN +GSignondDigestPluginPrivate +gsignond_digest_plugin_get_type +</SECTION> + +<SECTION> +<FILE>gsignond-error</FILE> +GSIGNOND_ERROR +GSignondError +gsignond_error_new_from_variant +gsignond_error_quark +gsignond_error_to_variant +gsignond_get_gerror_for_id +</SECTION> + +<SECTION> +<FILE>gsignond-extension-interface</FILE> +<TITLE>GSignondExtension</TITLE> +GSignondExtension +GSignondExtensionClass +gsignond_extension_get_access_control_manager +gsignond_extension_get_name +gsignond_extension_get_secret_storage +gsignond_extension_get_storage_manager +gsignond_extension_get_version +<SUBSECTION Standard> +GSIGNOND_EXTENSION +GSIGNOND_EXTENSION_CLASS +GSIGNOND_EXTENSION_GET_CLASS +GSIGNOND_IS_EXTENSION +GSIGNOND_IS_EXTENSION_CLASS +GSIGNOND_TYPE_EXTENSION +GSignondExtensionPrivate +gsignond_extension_get_type +</SECTION> + +<SECTION> +<FILE>gsignond-log</FILE> +DBG +ERR +INFO +TRACEBACK +WARN +</SECTION> + +<SECTION> +<FILE>gsignond-password-plugin</FILE> +<TITLE>GSignondPasswordPlugin</TITLE> +GSignondPasswordPlugin +GSignondPasswordPluginClass +<SUBSECTION Standard> +GSIGNOND_IS_PASSWORD_PLUGIN +GSIGNOND_IS_PASSWORD_PLUGIN_CLASS +GSIGNOND_PASSWORD_PLUGIN +GSIGNOND_PASSWORD_PLUGIN_CLASS +GSIGNOND_PASSWORD_PLUGIN_GET_CLASS +GSIGNOND_TYPE_PASSWORD_PLUGIN +gsignond_password_plugin_get_type +</SECTION> + +<SECTION> +<FILE>gsignond-plugin-interface</FILE> +<TITLE>GSignondPlugin</TITLE> +GSignondPluginInterface +GSignondPluginState +gsignond_plugin_cancel +gsignond_plugin_error +gsignond_plugin_refresh +gsignond_plugin_refreshed +gsignond_plugin_request +gsignond_plugin_request_initial +gsignond_plugin_response +gsignond_plugin_response_final +gsignond_plugin_status_changed +gsignond_plugin_store +gsignond_plugin_user_action_finished +gsignond_plugin_user_action_required +<SUBSECTION Standard> +GSIGNOND_IS_PLUGIN +GSIGNOND_PLUGIN +GSIGNOND_PLUGIN_GET_INTERFACE +GSIGNOND_TYPE_PLUGIN +gsignond_plugin_get_type +</SECTION> + +<SECTION> +<FILE>gsignond-secret-storage</FILE> +<TITLE>GSignondSecretStorage</TITLE> +GSignondSecretStorage +GSignondSecretStorageClass +gsignond_secret_storage_check_credentials +gsignond_secret_storage_clear_db +gsignond_secret_storage_close_db +gsignond_secret_storage_get_last_error +gsignond_secret_storage_is_open_db +gsignond_secret_storage_load_credentials +gsignond_secret_storage_load_data +gsignond_secret_storage_open_db +gsignond_secret_storage_remove_credentials +gsignond_secret_storage_remove_data +gsignond_secret_storage_update_credentials +gsignond_secret_storage_update_data +<SUBSECTION Standard> +GSIGNOND_IS_SECRET_STORAGE +GSIGNOND_IS_SECRET_STORAGE_CLASS +GSIGNOND_SECRET_STORAGE +GSIGNOND_SECRET_STORAGE_CLASS +GSIGNOND_SECRET_STORAGE_GET_CLASS +GSIGNOND_TYPE_SECRET_STORAGE +GSignondSecretStoragePrivate +gsignond_secret_storage_get_type +</SECTION> + +<SECTION> +<FILE>gsignond-security-context</FILE> +GSignondSecurityContext +GSignondSecurityContextList +gsignond_security_context_check +gsignond_security_context_compare +gsignond_security_context_copy +gsignond_security_context_free +gsignond_security_context_from_variant +gsignond_security_context_get_application_context +gsignond_security_context_get_system_context +gsignond_security_context_list_copy +gsignond_security_context_list_free +gsignond_security_context_list_from_variant +gsignond_security_context_list_to_variant +gsignond_security_context_match +gsignond_security_context_new +gsignond_security_context_new_from_values +gsignond_security_context_set_application_context +gsignond_security_context_set_system_context +gsignond_security_context_to_variant +</SECTION> + +<SECTION> +<FILE>gsignond-session-data</FILE> +GSignondSessionData +GSignondUiPolicy +gsignond_session_data_get_caption +gsignond_session_data_get_network_proxy +gsignond_session_data_get_network_timeout +gsignond_session_data_get_realm +gsignond_session_data_get_renew_token +gsignond_session_data_get_secret +gsignond_session_data_get_ui_policy +gsignond_session_data_get_username +gsignond_session_data_get_window_id +gsignond_session_data_set_caption +gsignond_session_data_set_network_proxy +gsignond_session_data_set_network_timeout +gsignond_session_data_set_realm +gsignond_session_data_set_renew_token +gsignond_session_data_set_secret +gsignond_session_data_set_ui_policy +gsignond_session_data_set_username +gsignond_session_data_set_window_id +<SUBSECTION Standard> +GSIGNOND_IS_SESSION_DATA +GSIGNOND_SESSION_DATA +GSIGNOND_TYPE_SESSION_DATA +</SECTION> + +<SECTION> +<FILE>gsignond-signonui-data</FILE> +GSignondSignonuiData +GSignondSignonuiError +gsignond_signonui_data_get_captcha_response +gsignond_signonui_data_get_captcha_url +gsignond_signonui_data_get_caption +gsignond_signonui_data_get_confirm +gsignond_signonui_data_get_final_url +gsignond_signonui_data_get_forgot_password +gsignond_signonui_data_get_forgot_password_url +gsignond_signonui_data_get_message +gsignond_signonui_data_get_open_url +gsignond_signonui_data_get_password +gsignond_signonui_data_get_query_error +gsignond_signonui_data_get_query_password +gsignond_signonui_data_get_query_username +gsignond_signonui_data_get_remember_password +gsignond_signonui_data_get_request_id +gsignond_signonui_data_get_test_reply +gsignond_signonui_data_get_title +gsignond_signonui_data_get_url_response +gsignond_signonui_data_get_username +gsignond_signonui_data_set_captcha_response +gsignond_signonui_data_set_captcha_url +gsignond_signonui_data_set_caption +gsignond_signonui_data_set_confirm +gsignond_signonui_data_set_final_url +gsignond_signonui_data_set_forgot_password +gsignond_signonui_data_set_forgot_password_url +gsignond_signonui_data_set_message +gsignond_signonui_data_set_open_url +gsignond_signonui_data_set_password +gsignond_signonui_data_set_query_error +gsignond_signonui_data_set_query_password +gsignond_signonui_data_set_query_username +gsignond_signonui_data_set_remember_password +gsignond_signonui_data_set_request_id +gsignond_signonui_data_set_test_reply +gsignond_signonui_data_set_title +gsignond_signonui_data_set_url_response +gsignond_signonui_data_set_username +<SUBSECTION Standard> +GSIGNOND_IS_SIGNONUI_DATA +GSIGNOND_SIGNONUI_DATA +GSIGNOND_TYPE_SIGNONUI_DATA +</SECTION> + +<SECTION> +<FILE>gsignond-ssotest-plugin</FILE> +<TITLE>GSignondSsoTestPlugin</TITLE> +GSignondSsoTestPlugin +GSignondSsoTestPluginClass +<SUBSECTION Standard> +GSIGNOND_IS_SSOTEST_PLUGIN +GSIGNOND_IS_SSOTEST_PLUGIN_CLASS +GSIGNOND_SSOTEST_PLUGIN +GSIGNOND_SSOTEST_PLUGIN_CLASS +GSIGNOND_SSOTEST_PLUGIN_GET_CLASS +GSIGNOND_TYPE_SSOTEST_PLUGIN +GSignondSsoTestPluginPrivate +gsignond_ssotest_plugin_get_type +</SECTION> + +<SECTION> +<FILE>gsignond-storage-manager</FILE> +<TITLE>GSignondStorageManager</TITLE> +GSignondStorageManager +GSignondStorageManagerClass +gsignond_storage_manager_delete_storage +gsignond_storage_manager_filesystem_is_mounted +gsignond_storage_manager_initialize_storage +gsignond_storage_manager_mount_filesystem +gsignond_storage_manager_storage_is_initialized +gsignond_storage_manager_unmount_filesystem +<SUBSECTION Standard> +GSIGNOND_IS_STORAGE_MANAGER +GSIGNOND_IS_STORAGE_MANAGER_CLASS +GSIGNOND_STORAGE_MANAGER +GSIGNOND_STORAGE_MANAGER_CLASS +GSIGNOND_STORAGE_MANAGER_GET_CLASS +GSIGNOND_TYPE_STORAGE_MANAGER +GSignondStorageManagerPrivate +gsignond_storage_manager_get_type +</SECTION> + +<SECTION> +<FILE>gsignond-utils</FILE> +gsignond_generate_nonce +gsignond_wipe_directory +gsignond_wipe_file +</SECTION> + diff --git a/docs/gsignond.types b/docs/gsignond.types new file mode 100644 index 0000000..fa429f9 --- /dev/null +++ b/docs/gsignond.types @@ -0,0 +1,10 @@ +gsignond_access_control_manager_get_type +gsignond_config_get_type +gsignond_credentials_get_type +gsignond_digest_plugin_get_type +gsignond_extension_get_type +gsignond_password_plugin_get_type +gsignond_plugin_get_type +gsignond_secret_storage_get_type +gsignond_ssotest_plugin_get_type +gsignond_storage_manager_get_type diff --git a/docs/html/GSignondAccessControlManager.html b/docs/html/GSignondAccessControlManager.html new file mode 100644 index 0000000..13c0117 --- /dev/null +++ b/docs/html/GSignondAccessControlManager.html @@ -0,0 +1,366 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GSignondAccessControlManager</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="gsignond API Reference Manual"> +<link rel="up" href="ch05.html" title="GSignond API for writing platform adaptation extensions"> +<link rel="prev" href="GSignondExtension.html" title="GSignondExtension"> +<link rel="next" href="gsignond-GSignondSecurityContext.html" title="GSignondSecurityContext"> +<meta name="generator" content="GTK-Doc V1.19.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle"> +<td width="100%" align="left"> +<a href="#" class="shortcut">Top</a> +  | + <a href="#GSignondAccessControlManager.description" class="shortcut">Description</a> +  | + <a href="#GSignondAccessControlManager.object-hierarchy" class="shortcut">Object Hierarchy</a> +  | + <a href="#GSignondAccessControlManager.properties" class="shortcut">Properties</a> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="ch05.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="GSignondExtension.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="gsignond-GSignondSecurityContext.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="GSignondAccessControlManager"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GSignondAccessControlManager.top_of_page"></a>GSignondAccessControlManager</span></h2> +<p>GSignondAccessControlManager — an object that performs access control checks</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="GSignondAccessControlManager.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis"> +#include <gsignond/gsignond-access-control-manager.h> + +struct <a class="link" href="GSignondAccessControlManager.html#GSignondAccessControlManager-struct" title="struct GSignondAccessControlManager">GSignondAccessControlManager</a>; +struct <a class="link" href="GSignondAccessControlManager.html#GSignondAccessControlManagerClass" title="struct GSignondAccessControlManagerClass">GSignondAccessControlManagerClass</a>; +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GSignondAccessControlManager.html#gsignond-access-control-manager-acl-is-valid" title="gsignond_access_control_manager_acl_is_valid ()">gsignond_access_control_manager_acl_is_valid</a> + (<em class="parameter"><code><a class="link" href="GSignondAccessControlManager.html" title="GSignondAccessControlManager"><span class="type">GSignondAccessControlManager</span></a> *self</code></em>, + <em class="parameter"><code>const <a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a> *peer_ctx</code></em>, + <em class="parameter"><code>const <a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContextList" title="GSignondSecurityContextList"><span class="type">GSignondSecurityContextList</span></a> *identity_acl</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GSignondAccessControlManager.html#gsignond-access-control-manager-peer-is-allowed-to-use-identity" title="gsignond_access_control_manager_peer_is_allowed_to_use_identity ()">gsignond_access_control_manager_peer_is_allowed_to_use_identity</a> + (<em class="parameter"><code><a class="link" href="GSignondAccessControlManager.html" title="GSignondAccessControlManager"><span class="type">GSignondAccessControlManager</span></a> *self</code></em>, + <em class="parameter"><code>const <a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a> *peer_ctx</code></em>, + <em class="parameter"><code>const <a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a> *owner_ctx</code></em>, + <em class="parameter"><code>const <a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContextList" title="GSignondSecurityContextList"><span class="type">GSignondSecurityContextList</span></a> *identity_acl</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GSignondAccessControlManager.html#gsignond-access-control-manager-peer-is-owner-of-identity" title="gsignond_access_control_manager_peer_is_owner_of_identity ()">gsignond_access_control_manager_peer_is_owner_of_identity</a> + (<em class="parameter"><code><a class="link" href="GSignondAccessControlManager.html" title="GSignondAccessControlManager"><span class="type">GSignondAccessControlManager</span></a> *self</code></em>, + <em class="parameter"><code>const <a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a> *peer_ctx</code></em>, + <em class="parameter"><code>const <a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a> *owner_ctx</code></em>); +<a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="returnvalue">GSignondSecurityContext</span></a> * <a class="link" href="GSignondAccessControlManager.html#gsignond-access-control-manager-security-context-of-keychain" title="gsignond_access_control_manager_security_context_of_keychain ()">gsignond_access_control_manager_security_context_of_keychain</a> + (<em class="parameter"><code><a class="link" href="GSignondAccessControlManager.html" title="GSignondAccessControlManager"><span class="type">GSignondAccessControlManager</span></a> *self</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GSignondAccessControlManager.html#gsignond-access-control-manager-security-context-of-peer" title="gsignond_access_control_manager_security_context_of_peer ()">gsignond_access_control_manager_security_context_of_peer</a> + (<em class="parameter"><code><a class="link" href="GSignondAccessControlManager.html" title="GSignondAccessControlManager"><span class="type">GSignondAccessControlManager</span></a> *self</code></em>, + <em class="parameter"><code><a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a> *peer_ctx</code></em>, + <em class="parameter"><code><span class="type">int</span> peer_fd</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *peer_service</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *peer_app_ctx</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="GSignondAccessControlManager.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> + +----GSignondAccessControlManager +</pre> +</div> +<div class="refsect1"> +<a name="GSignondAccessControlManager.properties"></a><h2>Properties</h2> +<pre class="synopsis"> + "<a class="link" href="GSignondAccessControlManager.html#GSignondAccessControlManager--config" title='The "config" property'>config</a>" <a class="link" href="GSignondConfig.html" title="GSignondConfig"><span class="type">GSignondConfig</span></a>* : Read / Write / Construct Only +</pre> +</div> +<div class="refsect1"> +<a name="GSignondAccessControlManager.description"></a><h2>Description</h2> +<p> +<a class="link" href="GSignondAccessControlManager.html" title="GSignondAccessControlManager"><span class="type">GSignondAccessControlManager</span></a> performs access control checks using +available system services. gSSO can be configured to use a custom extension +that provides a subclassed implementation of <a class="link" href="GSignondAccessControlManager.html" title="GSignondAccessControlManager"><span class="type">GSignondAccessControlManager</span></a> +(see <a class="link" href="GSignondExtension.html" title="GSignondExtension"><span class="type">GSignondExtension</span></a>), otherwise a default implementation is used. +</p> +</div> +<div class="refsect1"> +<a name="GSignondAccessControlManager.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GSignondAccessControlManager-struct"></a><h3>struct GSignondAccessControlManager</h3> +<pre class="programlisting">struct GSignondAccessControlManager;</pre> +<p> +Opaque <a class="link" href="GSignondAccessControlManager.html" title="GSignondAccessControlManager"><span class="type">GSignondAccessControlManager</span></a> data structure. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="GSignondAccessControlManagerClass"></a><h3>struct GSignondAccessControlManagerClass</h3> +<pre class="programlisting">struct GSignondAccessControlManagerClass { + GObjectClass parent_class; + + void (*security_context_of_peer) ( + GSignondAccessControlManager *self, + GSignondSecurityContext *peer_ctx, + int peer_fd, const gchar *peer_service, + const gchar *peer_app_ctx); + gboolean (*peer_is_allowed_to_use_identity) ( + GSignondAccessControlManager *self, + const GSignondSecurityContext *peer_ctx, + const GSignondSecurityContext *owner_ctx, + const GSignondSecurityContextList *identity_acl); + gboolean (*peer_is_owner_of_identity) ( + GSignondAccessControlManager *self, + const GSignondSecurityContext *peer_ctx, + const GSignondSecurityContext *owner_ctx); + gboolean (*acl_is_valid) ( + GSignondAccessControlManager *self, + const GSignondSecurityContext *peer_ctx, + const GSignondSecurityContextList *identity_acl); + GSignondSecurityContext * (*security_context_of_keychain) ( + GSignondAccessControlManager *self); +}; +</pre> +<p> +<a class="link" href="GSignondAccessControlManager.html#GSignondAccessControlManagerClass" title="struct GSignondAccessControlManagerClass"><span class="type">GSignondAccessControlManagerClass</span></a> class containing pointers to class methods. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a> <em class="structfield"><code><a name="GSignondAccessControlManagerClass.parent-class"></a>parent_class</code></em>;</span></p></td> +<td>parent class.</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="GSignondAccessControlManagerClass.security-context-of-peer"></a>security_context_of_peer</code></em> ()</span></p></td> +<td>an implementation of <a class="link" href="GSignondAccessControlManager.html#gsignond-access-control-manager-security-context-of-peer" title="gsignond_access_control_manager_security_context_of_peer ()"><code class="function">gsignond_access_control_manager_security_context_of_peer()</code></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="GSignondAccessControlManagerClass.peer-is-allowed-to-use-identity"></a>peer_is_allowed_to_use_identity</code></em> ()</span></p></td> +<td>an implementation of <a class="link" href="GSignondAccessControlManager.html#gsignond-access-control-manager-peer-is-allowed-to-use-identity" title="gsignond_access_control_manager_peer_is_allowed_to_use_identity ()"><code class="function">gsignond_access_control_manager_peer_is_allowed_to_use_identity()</code></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="GSignondAccessControlManagerClass.peer-is-owner-of-identity"></a>peer_is_owner_of_identity</code></em> ()</span></p></td> +<td>an implementation of <a class="link" href="GSignondAccessControlManager.html#gsignond-access-control-manager-peer-is-owner-of-identity" title="gsignond_access_control_manager_peer_is_owner_of_identity ()"><code class="function">gsignond_access_control_manager_peer_is_owner_of_identity()</code></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="GSignondAccessControlManagerClass.acl-is-valid"></a>acl_is_valid</code></em> ()</span></p></td> +<td>an implementation of <a class="link" href="GSignondAccessControlManager.html#gsignond-access-control-manager-acl-is-valid" title="gsignond_access_control_manager_acl_is_valid ()"><code class="function">gsignond_access_control_manager_acl_is_valid()</code></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="GSignondAccessControlManagerClass.security-context-of-keychain"></a>security_context_of_keychain</code></em> ()</span></p></td> +<td>an implementation of <a class="link" href="GSignondAccessControlManager.html#gsignond-access-control-manager-security-context-of-keychain" title="gsignond_access_control_manager_security_context_of_keychain ()"><code class="function">gsignond_access_control_manager_security_context_of_keychain()</code></a> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-access-control-manager-acl-is-valid"></a><h3>gsignond_access_control_manager_acl_is_valid ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gsignond_access_control_manager_acl_is_valid + (<em class="parameter"><code><a class="link" href="GSignondAccessControlManager.html" title="GSignondAccessControlManager"><span class="type">GSignondAccessControlManager</span></a> *self</code></em>, + <em class="parameter"><code>const <a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a> *peer_ctx</code></em>, + <em class="parameter"><code>const <a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContextList" title="GSignondSecurityContextList"><span class="type">GSignondSecurityContextList</span></a> *identity_acl</code></em>);</pre> +<p> +Checks if the specified peer is allowed to set the specified access +control list. <a class="link" href="GSignondAccessControlManager.html#gsignond-access-control-manager-peer-is-owner-of-identity" title="gsignond_access_control_manager_peer_is_owner_of_identity ()"><code class="function">gsignond_access_control_manager_peer_is_owner_of_identity()</code></a> +is used before calling this method to verify identity ownership. +</p> +<p> +The default implementation always returns TRUE. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>object instance.</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>peer_ctx</code></em> :</span></p></td> +<td>security context of the peer connection.</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>identity_acl</code></em> :</span></p></td> +<td>access control list for the identity.</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>access control list is OK?</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-access-control-manager-peer-is-allowed-to-use-identity"></a><h3>gsignond_access_control_manager_peer_is_allowed_to_use_identity ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gsignond_access_control_manager_peer_is_allowed_to_use_identity + (<em class="parameter"><code><a class="link" href="GSignondAccessControlManager.html" title="GSignondAccessControlManager"><span class="type">GSignondAccessControlManager</span></a> *self</code></em>, + <em class="parameter"><code>const <a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a> *peer_ctx</code></em>, + <em class="parameter"><code>const <a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a> *owner_ctx</code></em>, + <em class="parameter"><code>const <a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContextList" title="GSignondSecurityContextList"><span class="type">GSignondSecurityContextList</span></a> *identity_acl</code></em>);</pre> +<p> +Checks if specified peer is allowed to access the specified identity. +</p> +<p> +The default implementation goes over items in <em class="parameter"><code>identity_acl</code></em>, using +<a class="link" href="gsignond-GSignondSecurityContext.html#gsignond-security-context-check" title="gsignond_security_context_check ()"><code class="function">gsignond_security_context_check()</code></a> to check them against <em class="parameter"><code>peer_ctx</code></em>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>object instance.</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>peer_ctx</code></em> :</span></p></td> +<td>security context of the peer connection.</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>owner_ctx</code></em> :</span></p></td> +<td>security context of the identity owner.</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>identity_acl</code></em> :</span></p></td> +<td>access control list for the identity in question. Includes the <em class="parameter"><code>owner_ctx</code></em> as well.</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>access is allowed?</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-access-control-manager-peer-is-owner-of-identity"></a><h3>gsignond_access_control_manager_peer_is_owner_of_identity ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gsignond_access_control_manager_peer_is_owner_of_identity + (<em class="parameter"><code><a class="link" href="GSignondAccessControlManager.html" title="GSignondAccessControlManager"><span class="type">GSignondAccessControlManager</span></a> *self</code></em>, + <em class="parameter"><code>const <a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a> *peer_ctx</code></em>, + <em class="parameter"><code>const <a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a> *owner_ctx</code></em>);</pre> +<p> +Checks if the peer specified in <em class="parameter"><code>peer_ctx</code></em> is the owner of the identity. +</p> +<p> +The default implementation is using <a class="link" href="gsignond-GSignondSecurityContext.html#gsignond-security-context-check" title="gsignond_security_context_check ()"><code class="function">gsignond_security_context_check()</code></a> +to check <em class="parameter"><code>peer_ctx</code></em> against <em class="parameter"><code>owner_ctx</code></em> directly. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>object instance.</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>peer_ctx</code></em> :</span></p></td> +<td>security context of the peer connection.</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>owner_ctx</code></em> :</span></p></td> +<td>security context of the identity owner.</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>is owner?</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-access-control-manager-security-context-of-keychain"></a><h3>gsignond_access_control_manager_security_context_of_keychain ()</h3> +<pre class="programlisting"><a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="returnvalue">GSignondSecurityContext</span></a> * gsignond_access_control_manager_security_context_of_keychain + (<em class="parameter"><code><a class="link" href="GSignondAccessControlManager.html" title="GSignondAccessControlManager"><span class="type">GSignondAccessControlManager</span></a> *self</code></em>);</pre> +<p> +Retrieves security context of the keychain application. Keychain application +has a special management access to all stored identities and is able to +perform deletion of all identities from storage. +</p> +<p> +The default implementation returns an empty context. If gSSO was compiled +with --enable-debug and SSO_KEYCHAIN_SYSCTX environment variable is set, then +the value of that variable is used to set the returned system context instead. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>object instance.</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>security context of the keychain application.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-access-control-manager-security-context-of-peer"></a><h3>gsignond_access_control_manager_security_context_of_peer ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> gsignond_access_control_manager_security_context_of_peer + (<em class="parameter"><code><a class="link" href="GSignondAccessControlManager.html" title="GSignondAccessControlManager"><span class="type">GSignondAccessControlManager</span></a> *self</code></em>, + <em class="parameter"><code><a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a> *peer_ctx</code></em>, + <em class="parameter"><code><span class="type">int</span> peer_fd</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *peer_service</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *peer_app_ctx</code></em>);</pre> +<p> +Retrieves and sets <a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a> of the specified peer. +</p> +<p> +The default implementation sets the app context as it was passed, and sets +the system context to the binary path of the process that is determined from +<em class="parameter"><code>peer_fd</code></em> and <em class="parameter"><code>peer_service</code></em> parameters. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>object instance.</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>peer_ctx</code></em> :</span></p></td> +<td>instance of security context to be set.</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>peer_fd</code></em> :</span></p></td> +<td>file descriptor of the peer connection if using peer-to-peer dbus, -1 otherwise.</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>peer_service</code></em> :</span></p></td> +<td>g_dbus_method_invocation_get_sender() of the peer connection, if not using peer-to-peer dbus, NULL otherwise</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>peer_app_ctx</code></em> :</span></p></td> +<td>application context of the peer connection.</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<div class="refsect1"> +<a name="GSignondAccessControlManager.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="GSignondAccessControlManager--config"></a><h3>The <code class="literal">"config"</code> property</h3> +<pre class="programlisting"> "config" <a class="link" href="GSignondConfig.html" title="GSignondConfig"><span class="type">GSignondConfig</span></a>* : Read / Write / Construct Only</pre> +<p>Configuration object.</p> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.19.1</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/html/GSignondConfig.html b/docs/html/GSignondConfig.html new file mode 100644 index 0000000..dfe0222 --- /dev/null +++ b/docs/html/GSignondConfig.html @@ -0,0 +1,275 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GSignondConfig</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="gsignond API Reference Manual"> +<link rel="up" href="ch02.html" title="GSignond configuration"> +<link rel="prev" href="ch02.html" title="GSignond configuration"> +<link rel="next" href="gsignond-General-configuration.html" title="General configuration"> +<meta name="generator" content="GTK-Doc V1.19.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle"> +<td width="100%" align="left"> +<a href="#" class="shortcut">Top</a> +  | + <a href="#GSignondConfig.description" class="shortcut">Description</a> +  | + <a href="#GSignondConfig.object-hierarchy" class="shortcut">Object Hierarchy</a> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="ch02.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="gsignond-General-configuration.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="GSignondConfig"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GSignondConfig.top_of_page"></a>GSignondConfig</span></h2> +<p>GSignondConfig — gSSO configuration information</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="GSignondConfig.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis"> +#include <gsignond/gsignond-config.h> + +struct <a class="link" href="GSignondConfig.html#GSignondConfig-struct" title="struct GSignondConfig">GSignondConfig</a>; +struct <a class="link" href="GSignondConfig.html#GSignondConfigClass" title="struct GSignondConfigClass">GSignondConfigClass</a>; +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> <a class="link" href="GSignondConfig.html#gsignond-config-get-integer" title="gsignond_config_get_integer ()">gsignond_config_get_integer</a> (<em class="parameter"><code><a class="link" href="GSignondConfig.html" title="GSignondConfig"><span class="type">GSignondConfig</span></a> *self</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>); +const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="GSignondConfig.html#gsignond-config-get-string" title="gsignond_config_get_string ()">gsignond_config_get_string</a> (<em class="parameter"><code><a class="link" href="GSignondConfig.html" title="GSignondConfig"><span class="type">GSignondConfig</span></a> *self</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>); +<a class="link" href="GSignondConfig.html" title="GSignondConfig"><span class="returnvalue">GSignondConfig</span></a> * <a class="link" href="GSignondConfig.html#gsignond-config-new" title="gsignond_config_new ()">gsignond_config_new</a> (); +<span class="returnvalue">void</span> <a class="link" href="GSignondConfig.html#gsignond-config-set-integer" title="gsignond_config_set_integer ()">gsignond_config_set_integer</a> (<em class="parameter"><code><a class="link" href="GSignondConfig.html" title="GSignondConfig"><span class="type">GSignondConfig</span></a> *self</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> value</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GSignondConfig.html#gsignond-config-set-string" title="gsignond_config_set_string ()">gsignond_config_set_string</a> (<em class="parameter"><code><a class="link" href="GSignondConfig.html" title="GSignondConfig"><span class="type">GSignondConfig</span></a> *self</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *value</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="GSignondConfig.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> + +----GSignondConfig +</pre> +</div> +<div class="refsect1"> +<a name="GSignondConfig.description"></a><h2>Description</h2> +<p> +<a class="link" href="GSignondConfig.html" title="GSignondConfig"><span class="type">GSignondConfig</span></a> holds configuration information as a set of keys and values +(integer or strings). The key names are defined in +<a class="link" href="gsignond-General-configuration.html" title="General configuration">general config keys</a>, +<a class="link" href="gsignond-Database-configuration.html" title="Database configuration">database config keys</a>, and +<a class="link" href="gsignond-DBus-configuration.html" title="DBus configuration">DBus config keys</a>. +</p> +<p> +The configuration is discovered from these sources, in decreasing order of +priority: +</p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"><p>environment variables, if gSSO has been compiled with --enable-debug switch. +See the specific keys documentation for the variable names.</p></li> +<li class="listitem"><p>gSSO configuration file. See below for where the file is searched for.</p></li> +<li class="listitem"><p>default values. See the documentation for specific keys for those.</p></li> +</ul></div> +<p> +</p> +<p> +</p> +<div class="refsect1"> +<a name="idp10159744"></a><h2>Where the configuration file is searched for</h2> +</div> +<p> +</p> +<p> +If gSSO has been compiled with --enable-debug, then these locations are used, +in decreasing order of priority: +</p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"><p>GSIGNOND_CONFIG environment variable</p></li> +<li class="listitem"><p><a href="http://library.gnome.org/devel/glib/unstable/glib-Miscellaneous-Utility-Functions.html#g-get-user-config-dir"><code class="function">g_get_user_config_dir()</code></a> + "gsignond/gsignond.conf"</p></li> +<li class="listitem"><p>each of <a href="http://library.gnome.org/devel/glib/unstable/glib-Miscellaneous-Utility-Functions.html#g-get-system-config-dirs"><code class="function">g_get_system_config_dirs()</code></a> + "gsignond/gsignond.conf"</p></li> +</ul></div> +<p> +</p> +<p> +Otherwise, the config file location is determined at compilation time as +$(sysconfdir) + "gsignond/gsignond.conf" +</p> +<p> +</p> +<div class="refsect1"> +<a name="idp13808"></a><h2>Example configuration file</h2> +</div> +<p> +</p> +<p> +See example configuration file here: +<a class="ulink" href="http://code.google.com/p/accounts-sso/source/browse/gsignond.conf?repo=gsignond" target="_top"> +http://code.google.com/p/accounts-sso/source/browse/gsignond.conf?repo=gsignond</a> +</p> +</div> +<div class="refsect1"> +<a name="GSignondConfig.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GSignondConfig-struct"></a><h3>struct GSignondConfig</h3> +<pre class="programlisting">struct GSignondConfig;</pre> +<p> +Opaque structure for the object. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="GSignondConfigClass"></a><h3>struct GSignondConfigClass</h3> +<pre class="programlisting">struct GSignondConfigClass { +}; +</pre> +<p> +Opaque structure for the class. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-config-get-integer"></a><h3>gsignond_config_get_integer ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> gsignond_config_get_integer (<em class="parameter"><code><a class="link" href="GSignondConfig.html" title="GSignondConfig"><span class="type">GSignondConfig</span></a> *self</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>);</pre> +<p> +Get an integer configuration value. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>an instance of <a class="link" href="GSignondConfig.html" title="GSignondConfig"><span class="type">GSignondConfig</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td> +<td>the key name</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the value corresponding to the key as an integer. If the key does not +exist or cannot be converted to the integer, 0 is returned.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-config-get-string"></a><h3>gsignond_config_get_string ()</h3> +<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gsignond_config_get_string (<em class="parameter"><code><a class="link" href="GSignondConfig.html" title="GSignondConfig"><span class="type">GSignondConfig</span></a> *self</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>);</pre> +<p> +Get a string configuration value. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>an instance of <a class="link" href="GSignondConfig.html" title="GSignondConfig"><span class="type">GSignondConfig</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td> +<td>the key name</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the value corresponding to the key as string. If the key does not +exist, NULL is returned. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-config-new"></a><h3>gsignond_config_new ()</h3> +<pre class="programlisting"><a class="link" href="GSignondConfig.html" title="GSignondConfig"><span class="returnvalue">GSignondConfig</span></a> * gsignond_config_new ();</pre> +<p> +Create a <a class="link" href="GSignondConfig.html" title="GSignondConfig"><span class="type">GSignondConfig</span></a> object. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>an instance of <a class="link" href="GSignondConfig.html" title="GSignondConfig"><span class="type">GSignondConfig</span></a>. gSSO extensions should not use this +as they're already provided with a config object when they're created.</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-config-set-integer"></a><h3>gsignond_config_set_integer ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> gsignond_config_set_integer (<em class="parameter"><code><a class="link" href="GSignondConfig.html" title="GSignondConfig"><span class="type">GSignondConfig</span></a> *self</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> value</code></em>);</pre> +<p> +Sets the configuration value to the provided integer. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>an instance of <a class="link" href="GSignondConfig.html" title="GSignondConfig"><span class="type">GSignondConfig</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td> +<td>the key name</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td> +<td>the value</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-config-set-string"></a><h3>gsignond_config_set_string ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> gsignond_config_set_string (<em class="parameter"><code><a class="link" href="GSignondConfig.html" title="GSignondConfig"><span class="type">GSignondConfig</span></a> *self</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *value</code></em>);</pre> +<p> +Sets the configuration value to the provided string. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>an instance of <a class="link" href="GSignondConfig.html" title="GSignondConfig"><span class="type">GSignondConfig</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td> +<td>the key name</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td> +<td>the value. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> +</td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.19.1</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/html/GSignondCredentials.html b/docs/html/GSignondCredentials.html new file mode 100644 index 0000000..b986198 --- /dev/null +++ b/docs/html/GSignondCredentials.html @@ -0,0 +1,328 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GSignondCredentials</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="gsignond API Reference Manual"> +<link rel="up" href="ch05.html" title="GSignond API for writing platform adaptation extensions"> +<link rel="prev" href="GSignondSecretStorage.html" title="GSignondSecretStorage"> +<link rel="next" href="ch06.html" title="Miscellaneous"> +<meta name="generator" content="GTK-Doc V1.19.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle"> +<td width="100%" align="left"> +<a href="#" class="shortcut">Top</a> +  | + <a href="#GSignondCredentials.description" class="shortcut">Description</a> +  | + <a href="#GSignondCredentials.object-hierarchy" class="shortcut">Object Hierarchy</a> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="ch05.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="GSignondSecretStorage.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="ch06.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="GSignondCredentials"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GSignondCredentials.top_of_page"></a>GSignondCredentials</span></h2> +<p>GSignondCredentials — credentials (username, password) associated with an identity</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="GSignondCredentials.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis"> +#include <gsignond/gsignond-credentials.h> + + <a class="link" href="GSignondCredentials.html#GSignondCredentials-struct" title="GSignondCredentials">GSignondCredentials</a>; + <a class="link" href="GSignondCredentials.html#GSignondCredentialsClass" title="GSignondCredentialsClass">GSignondCredentialsClass</a>; +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GSignondCredentials.html#gsignond-credentials-equal" title="gsignond_credentials_equal ()">gsignond_credentials_equal</a> (<em class="parameter"><code><a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> *one</code></em>, + <em class="parameter"><code><a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> *two</code></em>); +<span class="returnvalue">guint32</span> <a class="link" href="GSignondCredentials.html#gsignond-credentials-get-id" title="gsignond_credentials_get_id ()">gsignond_credentials_get_id</a> (<em class="parameter"><code><a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> *self</code></em>); +const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="GSignondCredentials.html#gsignond-credentials-get-password" title="gsignond_credentials_get_password ()">gsignond_credentials_get_password</a> (<em class="parameter"><code><a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> *self</code></em>); +const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="GSignondCredentials.html#gsignond-credentials-get-username" title="gsignond_credentials_get_username ()">gsignond_credentials_get_username</a> (<em class="parameter"><code><a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> *self</code></em>); +<a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="returnvalue">GSignondCredentials</span></a> * <a class="link" href="GSignondCredentials.html#gsignond-credentials-new" title="gsignond_credentials_new ()">gsignond_credentials_new</a> (); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GSignondCredentials.html#gsignond-credentials-set-data" title="gsignond_credentials_set_data ()">gsignond_credentials_set_data</a> (<em class="parameter"><code><a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> *self</code></em>, + <em class="parameter"><code>const <span class="type">guint32</span> id</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *username</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *password</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GSignondCredentials.html#gsignond-credentials-set-id" title="gsignond_credentials_set_id ()">gsignond_credentials_set_id</a> (<em class="parameter"><code><a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> *self</code></em>, + <em class="parameter"><code>const <span class="type">guint32</span> id</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GSignondCredentials.html#gsignond-credentials-set-password" title="gsignond_credentials_set_password ()">gsignond_credentials_set_password</a> (<em class="parameter"><code><a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> *self</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *password</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GSignondCredentials.html#gsignond-credentials-set-username" title="gsignond_credentials_set_username ()">gsignond_credentials_set_username</a> (<em class="parameter"><code><a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> *self</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *username</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="GSignondCredentials.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> + +----GSignondCredentials +</pre> +</div> +<div class="refsect1"> +<a name="GSignondCredentials.description"></a><h2>Description</h2> +<p> +<a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> hold a username, password, and identity id, associated +with an identity. This information in stored in secret storage using +<a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a>. +</p> +</div> +<div class="refsect1"> +<a name="GSignondCredentials.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GSignondCredentials-struct"></a><h3>GSignondCredentials</h3> +<pre class="programlisting">typedef struct _GSignondCredentials GSignondCredentials;</pre> +<p> +Opaque <a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> data structure. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="GSignondCredentialsClass"></a><h3>GSignondCredentialsClass</h3> +<pre class="programlisting">typedef struct { +} GSignondCredentialsClass; +</pre> +<p> +Opaque <a class="link" href="GSignondCredentials.html#GSignondCredentialsClass" title="GSignondCredentialsClass"><span class="type">GSignondCredentialsClass</span></a> data structure. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-credentials-equal"></a><h3>gsignond_credentials_equal ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gsignond_credentials_equal (<em class="parameter"><code><a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> *one</code></em>, + <em class="parameter"><code><a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> *two</code></em>);</pre> +<p> +Compares elements of two GSignondCredentials object for equality. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>one</code></em> :</span></p></td> +<td>the first credential to be compared.</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>two</code></em> :</span></p></td> +<td>the second credential to be compared.</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>TRUE if id, username and password are same for both credential +objects, FALSE otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-credentials-get-id"></a><h3>gsignond_credentials_get_id ()</h3> +<pre class="programlisting"><span class="returnvalue">guint32</span> gsignond_credentials_get_id (<em class="parameter"><code><a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> *self</code></em>);</pre> +<p> +Gets the identity id +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>the object whose id is to be set.</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the id</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-credentials-get-password"></a><h3>gsignond_credentials_get_password ()</h3> +<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gsignond_credentials_get_password (<em class="parameter"><code><a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> *self</code></em>);</pre> +<p> +Gets the password from the <a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> object +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>the object whose password is to be set.</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the password if the object is valid, NULL otherwise. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-credentials-get-username"></a><h3>gsignond_credentials_get_username ()</h3> +<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gsignond_credentials_get_username (<em class="parameter"><code><a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> *self</code></em>);</pre> +<p> +Gets the username of the <a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> object +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>the object whose username is to be set.</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the username if the object is valid, NULL otherwise. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-credentials-new"></a><h3>gsignond_credentials_new ()</h3> +<pre class="programlisting"><a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="returnvalue">GSignondCredentials</span></a> * gsignond_credentials_new ();</pre> +<p> +Creates a new empty <a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> object +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the <a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> object. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span> +</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-credentials-set-data"></a><h3>gsignond_credentials_set_data ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gsignond_credentials_set_data (<em class="parameter"><code><a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> *self</code></em>, + <em class="parameter"><code>const <span class="type">guint32</span> id</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *username</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *password</code></em>);</pre> +<p> +Sets the data of the <a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>the object whose data is to be set.</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td> +<td>the identity id associated with the credentials.</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>username</code></em> :</span></p></td> +<td>the username. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>password</code></em> :</span></p></td> +<td>the password. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>TRUE if successful, FALSE otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-credentials-set-id"></a><h3>gsignond_credentials_set_id ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gsignond_credentials_set_id (<em class="parameter"><code><a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> *self</code></em>, + <em class="parameter"><code>const <span class="type">guint32</span> id</code></em>);</pre> +<p> +Sets the identity id of the <a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> object +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>the object whose id is to be set.</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td> +<td>the id.</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>TRUE if successful, FALSE otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-credentials-set-password"></a><h3>gsignond_credentials_set_password ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gsignond_credentials_set_password (<em class="parameter"><code><a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> *self</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *password</code></em>);</pre> +<p> +Sets the password of the GSignondCredentials object +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>the object whose password is to be set.</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>password</code></em> :</span></p></td> +<td>the password. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>TRUE if successful, FALSE otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-credentials-set-username"></a><h3>gsignond_credentials_set_username ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gsignond_credentials_set_username (<em class="parameter"><code><a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> *self</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *username</code></em>);</pre> +<p> +Sets the username of the GSignondCredentials object +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>the object whose username is to be set.</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>username</code></em> :</span></p></td> +<td>the username. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>TRUE if successful, FALSE otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.19.1</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/html/GSignondDigestPlugin.html b/docs/html/GSignondDigestPlugin.html new file mode 100644 index 0000000..a7b8b1c --- /dev/null +++ b/docs/html/GSignondDigestPlugin.html @@ -0,0 +1,128 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GSignondDigestPlugin</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="gsignond API Reference Manual"> +<link rel="up" href="ch04.html" title="Standard in-tree authentication plugins"> +<link rel="prev" href="ch04.html" title="Standard in-tree authentication plugins"> +<link rel="next" href="GSignondSsoTestPlugin.html" title="GSignondSsoTestPlugin"> +<meta name="generator" content="GTK-Doc V1.19.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle"> +<td width="100%" align="left"> +<a href="#" class="shortcut">Top</a> +  | + <a href="#GSignondDigestPlugin.description" class="shortcut">Description</a> +  | + <a href="#GSignondDigestPlugin.object-hierarchy" class="shortcut">Object Hierarchy</a> +  | + <a href="#GSignondDigestPlugin.implemented-interfaces" class="shortcut">Implemented Interfaces</a> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="ch04.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="ch04.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="GSignondSsoTestPlugin.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="GSignondDigestPlugin"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GSignondDigestPlugin.top_of_page"></a>GSignondDigestPlugin</span></h2> +<p>GSignondDigestPlugin — a plugin that performs HTTP Digest authentication</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="GSignondDigestPlugin.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis"> +#include <gsignond/gsignond-digest-plugin.h> + +struct <a class="link" href="GSignondDigestPlugin.html#GSignondDigestPlugin-struct" title="struct GSignondDigestPlugin">GSignondDigestPlugin</a>; +struct <a class="link" href="GSignondDigestPlugin.html#GSignondDigestPluginClass" title="struct GSignondDigestPluginClass">GSignondDigestPluginClass</a>; +</pre> +</div> +<div class="refsect1"> +<a name="GSignondDigestPlugin.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> + +----GSignondDigestPlugin +</pre> +</div> +<div class="refsect1"> +<a name="GSignondDigestPlugin.implemented-interfaces"></a><h2>Implemented Interfaces</h2> +<p> +GSignondDigestPlugin implements + GSignondPlugin.</p> +</div> +<div class="refsect1"> +<a name="GSignondDigestPlugin.description"></a><h2>Description</h2> +<p> +<a class="link" href="GSignondDigestPlugin.html" title="GSignondDigestPlugin"><span class="type">GSignondDigestPlugin</span></a> performs HTTP Digest authentication without exposing +the password to the application. Digest authentication is described in +<a class="ulink" href="http://tools.ietf.org/html/rfc2617" target="_top">RFC 2617</a>. +</p> +<p> +<a class="link" href="gsignond-GSignondPlugin.html#gsignond-plugin-request-initial" title="gsignond_plugin_request_initial ()"><code class="function">gsignond_plugin_request_initial()</code></a> <em class="parameter"><code>session_data</code></em> parameter should include +the following string items, whose meaning is described in the RFC: +</p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"><p>username and secret. If they are absent, they are requested from the user +via gSSO UI.</p></li> +<li class="listitem"><p>realm, "Algo", "Nonce", "Method", "DigestUri" - mandatory items.</p></li> +<li class="listitem"><p>"NonceCount", "Qop", "HEntity". "NonceCount" must be present if "Qop" is +present, "HEntity" must be present if "Qop" is present and set to "auth-int".</p></li> +</ul></div> +<p> +</p> +<p> +If the plugin has all the data to calculate the digest, it issues +<span class="type">"response-final"</span> signal. <em class="parameter"><code>session_data</code></em> in that signal contains +the username, "CNonce" item and the digest value under the "Response" key. +</p> +<p> +If some of the data is incorrect or not available, <span class="type">"error"</span> +signal is issued instead. +</p> +<p> +<span class="type">"type"</span> property is set to "digest", and <span class="type">"mechanisms"</span> +property contains a single entry "digest". +</p> +</div> +<div class="refsect1"> +<a name="GSignondDigestPlugin.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GSignondDigestPlugin-struct"></a><h3>struct GSignondDigestPlugin</h3> +<pre class="programlisting">struct GSignondDigestPlugin;</pre> +<p> +Opaque <a class="link" href="GSignondDigestPlugin.html" title="GSignondDigestPlugin"><span class="type">GSignondDigestPlugin</span></a> data structure. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="GSignondDigestPluginClass"></a><h3>struct GSignondDigestPluginClass</h3> +<pre class="programlisting">struct GSignondDigestPluginClass { + GObjectClass parent_class; +}; +</pre> +<p> +Opaque <a class="link" href="GSignondDigestPlugin.html#GSignondDigestPluginClass" title="struct GSignondDigestPluginClass"><span class="type">GSignondDigestPluginClass</span></a> data structure. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a> <em class="structfield"><code><a name="GSignondDigestPluginClass.parent-class"></a>parent_class</code></em>;</span></p></td> +<td>the parent class structure</td> +</tr></tbody> +</table></div> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.19.1</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/html/GSignondExtension.html b/docs/html/GSignondExtension.html new file mode 100644 index 0000000..55b6e8a --- /dev/null +++ b/docs/html/GSignondExtension.html @@ -0,0 +1,298 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GSignondExtension</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="gsignond API Reference Manual"> +<link rel="up" href="ch05.html" title="GSignond API for writing platform adaptation extensions"> +<link rel="prev" href="ch05.html" title="GSignond API for writing platform adaptation extensions"> +<link rel="next" href="GSignondAccessControlManager.html" title="GSignondAccessControlManager"> +<meta name="generator" content="GTK-Doc V1.19.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle"> +<td width="100%" align="left"> +<a href="#" class="shortcut">Top</a> +  | + <a href="#GSignondExtension.description" class="shortcut">Description</a> +  | + <a href="#GSignondExtension.object-hierarchy" class="shortcut">Object Hierarchy</a> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="ch05.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="ch05.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="GSignondAccessControlManager.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="GSignondExtension"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GSignondExtension.top_of_page"></a>GSignondExtension</span></h2> +<p>GSignondExtension — provides platform adaptation functionality</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="GSignondExtension.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis"> +#include <gsignond/gsignond-plugin-interface.h> + +struct <a class="link" href="GSignondExtension.html#GSignondExtension-struct" title="struct GSignondExtension">GSignondExtension</a>; +struct <a class="link" href="GSignondExtension.html#GSignondExtensionClass" title="struct GSignondExtensionClass">GSignondExtensionClass</a>; +<a class="link" href="GSignondAccessControlManager.html" title="GSignondAccessControlManager"><span class="returnvalue">GSignondAccessControlManager</span></a> * <a class="link" href="GSignondExtension.html#gsignond-extension-get-access-control-manager" title="gsignond_extension_get_access_control_manager ()">gsignond_extension_get_access_control_manager</a> + (<em class="parameter"><code><a class="link" href="GSignondExtension.html" title="GSignondExtension"><span class="type">GSignondExtension</span></a> *self</code></em>, + <em class="parameter"><code><a class="link" href="GSignondConfig.html" title="GSignondConfig"><span class="type">GSignondConfig</span></a> *config</code></em>); +const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="GSignondExtension.html#gsignond-extension-get-name" title="gsignond_extension_get_name ()">gsignond_extension_get_name</a> (<em class="parameter"><code><a class="link" href="GSignondExtension.html" title="GSignondExtension"><span class="type">GSignondExtension</span></a> *self</code></em>); +<a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="returnvalue">GSignondSecretStorage</span></a> * <a class="link" href="GSignondExtension.html#gsignond-extension-get-secret-storage" title="gsignond_extension_get_secret_storage ()">gsignond_extension_get_secret_storage</a> + (<em class="parameter"><code><a class="link" href="GSignondExtension.html" title="GSignondExtension"><span class="type">GSignondExtension</span></a> *self</code></em>, + <em class="parameter"><code><a class="link" href="GSignondConfig.html" title="GSignondConfig"><span class="type">GSignondConfig</span></a> *config</code></em>); +<a class="link" href="GSignondStorageManager.html" title="GSignondStorageManager"><span class="returnvalue">GSignondStorageManager</span></a> * <a class="link" href="GSignondExtension.html#gsignond-extension-get-storage-manager" title="gsignond_extension_get_storage_manager ()">gsignond_extension_get_storage_manager</a> + (<em class="parameter"><code><a class="link" href="GSignondExtension.html" title="GSignondExtension"><span class="type">GSignondExtension</span></a> *self</code></em>, + <em class="parameter"><code><a class="link" href="GSignondConfig.html" title="GSignondConfig"><span class="type">GSignondConfig</span></a> *config</code></em>); +<span class="returnvalue">guint32</span> <a class="link" href="GSignondExtension.html#gsignond-extension-get-version" title="gsignond_extension_get_version ()">gsignond_extension_get_version</a> (<em class="parameter"><code><a class="link" href="GSignondExtension.html" title="GSignondExtension"><span class="type">GSignondExtension</span></a> *self</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="GSignondExtension.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> + +----GSignondExtension +</pre> +</div> +<div class="refsect1"> +<a name="GSignondExtension.description"></a><h2>Description</h2> +<p> +<a class="link" href="GSignondExtension.html" title="GSignondExtension"><span class="type">GSignondExtension</span></a> provides access to platform adaptation functionality. It +contains getter methods for default implementations of <a class="link" href="GSignondAccessControlManager.html" title="GSignondAccessControlManager"><span class="type">GSignondAccessControlManager</span></a>, +<a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a> and <a class="link" href="GSignondStorageManager.html" title="GSignondStorageManager"><span class="type">GSignondStorageManager</span></a>. +</p> +<p> +gSSO can be adapted to a specific platform environment by implementing a +custom extension module. The following steps need to be taken: +</p> +<p> +a) subclass and re-implement some (or all) of the functionality of the above +three classes. +</p> +<p> +b) subclass <a class="link" href="GSignondExtension.html" title="GSignondExtension"><span class="type">GSignondExtension</span></a> and provide implementations of its getter methods for those +of the adaptation classes that have been changed. +</p> +<p> +d) provide a function <code class="function">GSignondExtension * extensionname_extension_init(void)</code> +that returns an instance of the <a class="link" href="GSignondExtension.html" title="GSignondExtension"><span class="type">GSignondExtension</span></a> subclass. +</p> +<p> +c) build and install these implementations as a gSSO extension module and +configure gSSO to use it. +</p> +<p> +Examples of custom extensions can be seen here: +<a class="ulink" href="https://code.google.com/p/accounts-sso/source/browse/?repo=gsignond#git%2Fsrc%2Fextensions" target="_top"> +https://code.google.com/p/accounts-sso/source/browse/?repo=gsignond#git%2Fsrc%2Fextensions</a> +and gSSO configuration is described in <a class="link" href="GSignondConfig.html" title="GSignondConfig"><span class="type">GSignondConfig</span></a>. +</p> +</div> +<div class="refsect1"> +<a name="GSignondExtension.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GSignondExtension-struct"></a><h3>struct GSignondExtension</h3> +<pre class="programlisting">struct GSignondExtension;</pre> +<p> +Opaque <a class="link" href="GSignondExtension.html" title="GSignondExtension"><span class="type">GSignondExtension</span></a> data structure. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="GSignondExtensionClass"></a><h3>struct GSignondExtensionClass</h3> +<pre class="programlisting">struct GSignondExtensionClass { + GObjectClass parent_class; + + const gchar * (*get_extension_name) (GSignondExtension *self); + + guint32 (*get_extension_version) (GSignondExtension *self); + + GSignondStorageManager * (*get_storage_manager) (GSignondExtension *self, + GSignondConfig *config); + + GSignondSecretStorage * (*get_secret_storage) (GSignondExtension *self, + GSignondConfig *config); + + GSignondAccessControlManager * (*get_access_control_manager) ( + GSignondExtension *self, + GSignondConfig *config); +}; +</pre> +<p> +<a class="link" href="GSignondExtension.html#GSignondExtensionClass" title="struct GSignondExtensionClass"><span class="type">GSignondExtensionClass</span></a> class containing pointers to class methods. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a> <em class="structfield"><code><a name="GSignondExtensionClass.parent-class"></a>parent_class</code></em>;</span></p></td> +<td>the parent class</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="GSignondExtensionClass.get-extension-name"></a>get_extension_name</code></em> ()</span></p></td> +<td>implementation of <a class="link" href="GSignondExtension.html#gsignond-extension-get-name" title="gsignond_extension_get_name ()"><code class="function">gsignond_extension_get_name()</code></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="GSignondExtensionClass.get-extension-version"></a>get_extension_version</code></em> ()</span></p></td> +<td>implementation of <a class="link" href="GSignondExtension.html#gsignond-extension-get-version" title="gsignond_extension_get_version ()"><code class="function">gsignond_extension_get_version()</code></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="GSignondExtensionClass.get-storage-manager"></a>get_storage_manager</code></em> ()</span></p></td> +<td>implementation of <a class="link" href="GSignondExtension.html#gsignond-extension-get-storage-manager" title="gsignond_extension_get_storage_manager ()"><code class="function">gsignond_extension_get_storage_manager()</code></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="GSignondExtensionClass.get-secret-storage"></a>get_secret_storage</code></em> ()</span></p></td> +<td>implementation of <a class="link" href="GSignondExtension.html#gsignond-extension-get-secret-storage" title="gsignond_extension_get_secret_storage ()"><code class="function">gsignond_extension_get_secret_storage()</code></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="GSignondExtensionClass.get-access-control-manager"></a>get_access_control_manager</code></em> ()</span></p></td> +<td>implementation of <a class="link" href="GSignondExtension.html#gsignond-extension-get-access-control-manager" title="gsignond_extension_get_access_control_manager ()"><code class="function">gsignond_extension_get_access_control_manager()</code></a> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-extension-get-access-control-manager"></a><h3>gsignond_extension_get_access_control_manager ()</h3> +<pre class="programlisting"><a class="link" href="GSignondAccessControlManager.html" title="GSignondAccessControlManager"><span class="returnvalue">GSignondAccessControlManager</span></a> * gsignond_extension_get_access_control_manager + (<em class="parameter"><code><a class="link" href="GSignondExtension.html" title="GSignondExtension"><span class="type">GSignondExtension</span></a> *self</code></em>, + <em class="parameter"><code><a class="link" href="GSignondConfig.html" title="GSignondConfig"><span class="type">GSignondConfig</span></a> *config</code></em>);</pre> +<p> +Factory method to get a singleton access control manager object. See +<a class="link" href="GSignondAccessControlManager.html" title="GSignondAccessControlManager"><span class="type">GSignondAccessControlManager</span></a> for the description of the default implementation. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>object instance.</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td> +<td>configuration object instance.</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>access control manager object instance. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-extension-get-name"></a><h3>gsignond_extension_get_name ()</h3> +<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gsignond_extension_get_name (<em class="parameter"><code><a class="link" href="GSignondExtension.html" title="GSignondExtension"><span class="type">GSignondExtension</span></a> *self</code></em>);</pre> +<p> +Get a human readable name of the extension. Default implementation +returns "default". +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>object instance.</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>name of the extension. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-extension-get-secret-storage"></a><h3>gsignond_extension_get_secret_storage ()</h3> +<pre class="programlisting"><a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="returnvalue">GSignondSecretStorage</span></a> * gsignond_extension_get_secret_storage + (<em class="parameter"><code><a class="link" href="GSignondExtension.html" title="GSignondExtension"><span class="type">GSignondExtension</span></a> *self</code></em>, + <em class="parameter"><code><a class="link" href="GSignondConfig.html" title="GSignondConfig"><span class="type">GSignondConfig</span></a> *config</code></em>);</pre> +<p> +Factory method to get a singleton secret storage object. See +<a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a> for the description of the default implementation. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>object instance.</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td> +<td>configuration object instance.</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>secret storage object instance. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-extension-get-storage-manager"></a><h3>gsignond_extension_get_storage_manager ()</h3> +<pre class="programlisting"><a class="link" href="GSignondStorageManager.html" title="GSignondStorageManager"><span class="returnvalue">GSignondStorageManager</span></a> * gsignond_extension_get_storage_manager + (<em class="parameter"><code><a class="link" href="GSignondExtension.html" title="GSignondExtension"><span class="type">GSignondExtension</span></a> *self</code></em>, + <em class="parameter"><code><a class="link" href="GSignondConfig.html" title="GSignondConfig"><span class="type">GSignondConfig</span></a> *config</code></em>);</pre> +<p> +Factory method to get a singleton storage manager object. See +<a class="link" href="GSignondStorageManager.html" title="GSignondStorageManager"><span class="type">GSignondStorageManager</span></a> for the description of the default implementation. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>object instance.</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td> +<td>configuration object instance.</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>storage manager object instance. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-extension-get-version"></a><h3>gsignond_extension_get_version ()</h3> +<pre class="programlisting"><span class="returnvalue">guint32</span> gsignond_extension_get_version (<em class="parameter"><code><a class="link" href="GSignondExtension.html" title="GSignondExtension"><span class="type">GSignondExtension</span></a> *self</code></em>);</pre> +<p> +Get version of the extension, split into four bytes in order from MSB to LSB; +major, minor, patchlevel, build. Default implementation returns 0. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>object instance.</td> +</tr></tbody> +</table></div> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.19.1</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/html/GSignondPasswordPlugin.html b/docs/html/GSignondPasswordPlugin.html new file mode 100644 index 0000000..cd135a5 --- /dev/null +++ b/docs/html/GSignondPasswordPlugin.html @@ -0,0 +1,113 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GSignondPasswordPlugin</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="gsignond API Reference Manual"> +<link rel="up" href="ch04.html" title="Standard in-tree authentication plugins"> +<link rel="prev" href="GSignondSsoTestPlugin.html" title="GSignondSsoTestPlugin"> +<link rel="next" href="ch05.html" title="GSignond API for writing platform adaptation extensions"> +<meta name="generator" content="GTK-Doc V1.19.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle"> +<td width="100%" align="left"> +<a href="#" class="shortcut">Top</a> +  | + <a href="#GSignondPasswordPlugin.description" class="shortcut">Description</a> +  | + <a href="#GSignondPasswordPlugin.object-hierarchy" class="shortcut">Object Hierarchy</a> +  | + <a href="#GSignondPasswordPlugin.implemented-interfaces" class="shortcut">Implemented Interfaces</a> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="ch04.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="GSignondSsoTestPlugin.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="ch05.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="GSignondPasswordPlugin"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GSignondPasswordPlugin.top_of_page"></a>GSignondPasswordPlugin</span></h2> +<p>GSignondPasswordPlugin — a plugin for retrieving the username/password</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="GSignondPasswordPlugin.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis"> +#include <gsignond/gsignond-password-plugin.h> + +struct <a class="link" href="GSignondPasswordPlugin.html#GSignondPasswordPlugin-struct" title="struct GSignondPasswordPlugin">GSignondPasswordPlugin</a>; +struct <a class="link" href="GSignondPasswordPlugin.html#GSignondPasswordPluginClass" title="struct GSignondPasswordPluginClass">GSignondPasswordPluginClass</a>; +</pre> +</div> +<div class="refsect1"> +<a name="GSignondPasswordPlugin.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> + +----GSignondPasswordPlugin +</pre> +</div> +<div class="refsect1"> +<a name="GSignondPasswordPlugin.implemented-interfaces"></a><h2>Implemented Interfaces</h2> +<p> +GSignondPasswordPlugin implements + GSignondPlugin.</p> +</div> +<div class="refsect1"> +<a name="GSignondPasswordPlugin.description"></a><h2>Description</h2> +<p> +<a class="link" href="GSignondPasswordPlugin.html" title="GSignondPasswordPlugin"><span class="type">GSignondPasswordPlugin</span></a> is used in login/password based authentication protocols. +It returns to the applications the username and password associated with an +identity. The plugin first checks if the daemon has placed them in +<a class="link" href="gsignond-GSignondPlugin.html#gsignond-plugin-request-initial" title="gsignond_plugin_request_initial ()"><code class="function">gsignond_plugin_request_initial()</code></a> <em class="parameter"><code>session_data</code></em> parameter +(that means they're already stored in gSSO secure database), and if not, +the user is asked for the username and password via gSSO UI. +</p> +<p> +The plugin returns the username and password via <span class="type">"response-final"</span> +if it was able to obtain them, and issues <span class="type">"error"</span> otherwise. +</p> +<p> +<span class="type">"type"</span> property is set to "password", and <span class="type">"mechanisms"</span> +property contains a single entry "password". +</p> +</div> +<div class="refsect1"> +<a name="GSignondPasswordPlugin.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GSignondPasswordPlugin-struct"></a><h3>struct GSignondPasswordPlugin</h3> +<pre class="programlisting">struct GSignondPasswordPlugin;</pre> +<p> +Opaque <a class="link" href="GSignondPasswordPlugin.html" title="GSignondPasswordPlugin"><span class="type">GSignondPasswordPlugin</span></a> data structure. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="GSignondPasswordPluginClass"></a><h3>struct GSignondPasswordPluginClass</h3> +<pre class="programlisting">struct GSignondPasswordPluginClass { + GObjectClass parent_class; +}; +</pre> +<p> +Opaque <a class="link" href="GSignondPasswordPlugin.html#GSignondPasswordPluginClass" title="struct GSignondPasswordPluginClass"><span class="type">GSignondPasswordPluginClass</span></a> data structure. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a> <em class="structfield"><code><a name="GSignondPasswordPluginClass.parent-class"></a>parent_class</code></em>;</span></p></td> +<td>the parent class structure</td> +</tr></tbody> +</table></div> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.19.1</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/html/GSignondSecretStorage.html b/docs/html/GSignondSecretStorage.html new file mode 100644 index 0000000..4b26461 --- /dev/null +++ b/docs/html/GSignondSecretStorage.html @@ -0,0 +1,598 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GSignondSecretStorage</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="gsignond API Reference Manual"> +<link rel="up" href="ch05.html" title="GSignond API for writing platform adaptation extensions"> +<link rel="prev" href="GSignondStorageManager.html" title="GSignondStorageManager"> +<link rel="next" href="GSignondCredentials.html" title="GSignondCredentials"> +<meta name="generator" content="GTK-Doc V1.19.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle"> +<td width="100%" align="left"> +<a href="#" class="shortcut">Top</a> +  | + <a href="#GSignondSecretStorage.description" class="shortcut">Description</a> +  | + <a href="#GSignondSecretStorage.object-hierarchy" class="shortcut">Object Hierarchy</a> +  | + <a href="#GSignondSecretStorage.properties" class="shortcut">Properties</a> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="ch05.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="GSignondStorageManager.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="GSignondCredentials.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="GSignondSecretStorage"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GSignondSecretStorage.top_of_page"></a>GSignondSecretStorage</span></h2> +<p>GSignondSecretStorage — provides access to the database that stores user credentials and identity/method cache</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="GSignondSecretStorage.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis"> +#include <gsignond/gsignond-secret-storage.h> + + <a class="link" href="GSignondSecretStorage.html#GSignondSecretStorage-struct" title="GSignondSecretStorage">GSignondSecretStorage</a>; + <a class="link" href="GSignondSecretStorage.html#GSignondSecretStorageClass" title="GSignondSecretStorageClass">GSignondSecretStorageClass</a>; +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GSignondSecretStorage.html#gsignond-secret-storage-check-credentials" title="gsignond_secret_storage_check_credentials ()">gsignond_secret_storage_check_credentials</a> + (<em class="parameter"><code><a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a> *self</code></em>, + <em class="parameter"><code><a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> *creds</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GSignondSecretStorage.html#gsignond-secret-storage-clear-db" title="gsignond_secret_storage_clear_db ()">gsignond_secret_storage_clear_db</a> (<em class="parameter"><code><a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a> *self</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GSignondSecretStorage.html#gsignond-secret-storage-close-db" title="gsignond_secret_storage_close_db ()">gsignond_secret_storage_close_db</a> (<em class="parameter"><code><a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a> *self</code></em>); +const <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="returnvalue">GError</span></a> * <a class="link" href="GSignondSecretStorage.html#gsignond-secret-storage-get-last-error" title="gsignond_secret_storage_get_last_error ()">gsignond_secret_storage_get_last_error</a> + (<em class="parameter"><code><a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a> *self</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GSignondSecretStorage.html#gsignond-secret-storage-is-open-db" title="gsignond_secret_storage_is_open_db ()">gsignond_secret_storage_is_open_db</a> (<em class="parameter"><code><a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a> *self</code></em>); +<a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="returnvalue">GSignondCredentials</span></a> * <a class="link" href="GSignondSecretStorage.html#gsignond-secret-storage-load-credentials" title="gsignond_secret_storage_load_credentials ()">gsignond_secret_storage_load_credentials</a> + (<em class="parameter"><code><a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a> *self</code></em>, + <em class="parameter"><code>const <span class="type">guint32</span> id</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="returnvalue">GHashTable</span></a> * <a class="link" href="GSignondSecretStorage.html#gsignond-secret-storage-load-data" title="gsignond_secret_storage_load_data ()">gsignond_secret_storage_load_data</a> (<em class="parameter"><code><a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a> *self</code></em>, + <em class="parameter"><code>const <span class="type">guint32</span> id</code></em>, + <em class="parameter"><code>const <span class="type">guint32</span> method</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GSignondSecretStorage.html#gsignond-secret-storage-open-db" title="gsignond_secret_storage_open_db ()">gsignond_secret_storage_open_db</a> (<em class="parameter"><code><a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a> *self</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GSignondSecretStorage.html#gsignond-secret-storage-remove-credentials" title="gsignond_secret_storage_remove_credentials ()">gsignond_secret_storage_remove_credentials</a> + (<em class="parameter"><code><a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a> *self</code></em>, + <em class="parameter"><code>const <span class="type">guint32</span> id</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GSignondSecretStorage.html#gsignond-secret-storage-remove-data" title="gsignond_secret_storage_remove_data ()">gsignond_secret_storage_remove_data</a> (<em class="parameter"><code><a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a> *self</code></em>, + <em class="parameter"><code>const <span class="type">guint32</span> id</code></em>, + <em class="parameter"><code>const <span class="type">guint32</span> method</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GSignondSecretStorage.html#gsignond-secret-storage-update-credentials" title="gsignond_secret_storage_update_credentials ()">gsignond_secret_storage_update_credentials</a> + (<em class="parameter"><code><a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a> *self</code></em>, + <em class="parameter"><code><a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> *creds</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GSignondSecretStorage.html#gsignond-secret-storage-update-data" title="gsignond_secret_storage_update_data ()">gsignond_secret_storage_update_data</a> (<em class="parameter"><code><a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a> *self</code></em>, + <em class="parameter"><code>const <span class="type">guint32</span> id</code></em>, + <em class="parameter"><code>const <span class="type">guint32</span> method</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> *data</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="GSignondSecretStorage.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> + +----GSignondSecretStorage +</pre> +</div> +<div class="refsect1"> +<a name="GSignondSecretStorage.properties"></a><h2>Properties</h2> +<pre class="synopsis"> + "<a class="link" href="GSignondSecretStorage.html#GSignondSecretStorage--config" title='The "config" property'>config</a>" <a class="link" href="GSignondConfig.html" title="GSignondConfig"><span class="type">GSignondConfig</span></a>* : Read / Write / Construct Only +</pre> +</div> +<div class="refsect1"> +<a name="GSignondSecretStorage.description"></a><h2>Description</h2> +<p> +<a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a> provides access to the database where sensitive identity +data (<a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a>) and identity/method cache are stored. It's preferred +that this database is protected against access by processes other than gSSO. +</p> +<p> +gSSO can be configured to use a custom extension +that provides a subclassed implementation of <a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a> +(see <a class="link" href="GSignondExtension.html" title="GSignondExtension"><span class="type">GSignondExtension</span></a>), otherwise a default implementation is used. +</p> +</div> +<div class="refsect1"> +<a name="GSignondSecretStorage.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GSignondSecretStorage-struct"></a><h3>GSignondSecretStorage</h3> +<pre class="programlisting">typedef struct _GSignondSecretStorage GSignondSecretStorage;</pre> +<p> +Opaque <a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a> data structure. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="GSignondSecretStorageClass"></a><h3>GSignondSecretStorageClass</h3> +<pre class="programlisting">typedef struct { + GObjectClass parent_class; + + gboolean + (*open_db) (GSignondSecretStorage *self); + + gboolean + (*close_db) (GSignondSecretStorage *self); + + gboolean + (*clear_db) (GSignondSecretStorage *self); + + gboolean + (*is_open_db) (GSignondSecretStorage *self); + + GSignondCredentials* + (*load_credentials) ( + GSignondSecretStorage *self, + const guint32 id); + + gboolean + (*update_credentials) ( + GSignondSecretStorage *self, + GSignondCredentials* creds); + + gboolean + (*remove_credentials) ( + GSignondSecretStorage *self, + const guint32 id); + + gboolean + (*check_credentials) ( + GSignondSecretStorage *self, + GSignondCredentials* creds); + + GSignondDictionary* + (*load_data) ( + GSignondSecretStorage *self, + const guint32 id, + const guint32 method); + + gboolean + (*update_data) ( + GSignondSecretStorage *self, + const guint32 id, + const guint32 method, + GSignondDictionary *data); + + gboolean + (*remove_data) ( + GSignondSecretStorage *self, + const guint32 id, + const guint32 method); + + const GError* + (*get_last_error) (GSignondSecretStorage *self); +} GSignondSecretStorageClass; +</pre> +<p> +<a class="link" href="GSignondSecretStorage.html#GSignondSecretStorageClass" title="GSignondSecretStorageClass"><span class="type">GSignondSecretStorageClass</span></a> class containing pointers to class methods. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a> <em class="structfield"><code><a name="GSignondSecretStorageClass.parent-class"></a>parent_class</code></em>;</span></p></td> +<td>parent class.</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="GSignondSecretStorageClass.open-db"></a>open_db</code></em> ()</span></p></td> +<td>an implementation of <a class="link" href="GSignondSecretStorage.html#gsignond-secret-storage-open-db" title="gsignond_secret_storage_open_db ()"><code class="function">gsignond_secret_storage_open_db()</code></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="GSignondSecretStorageClass.close-db"></a>close_db</code></em> ()</span></p></td> +<td>an implementation of <a class="link" href="GSignondSecretStorage.html#gsignond-secret-storage-close-db" title="gsignond_secret_storage_close_db ()"><code class="function">gsignond_secret_storage_close_db()</code></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="GSignondSecretStorageClass.clear-db"></a>clear_db</code></em> ()</span></p></td> +<td>an implementation of <a class="link" href="GSignondSecretStorage.html#gsignond-secret-storage-clear-db" title="gsignond_secret_storage_clear_db ()"><code class="function">gsignond_secret_storage_clear_db()</code></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="GSignondSecretStorageClass.is-open-db"></a>is_open_db</code></em> ()</span></p></td> +<td>an implementation of <a class="link" href="GSignondSecretStorage.html#gsignond-secret-storage-is-open-db" title="gsignond_secret_storage_is_open_db ()"><code class="function">gsignond_secret_storage_is_open_db()</code></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="GSignondSecretStorageClass.load-credentials"></a>load_credentials</code></em> ()</span></p></td> +<td>an implementation of <a class="link" href="GSignondSecretStorage.html#gsignond-secret-storage-load-credentials" title="gsignond_secret_storage_load_credentials ()"><code class="function">gsignond_secret_storage_load_credentials()</code></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="GSignondSecretStorageClass.update-credentials"></a>update_credentials</code></em> ()</span></p></td> +<td>an implementation of <a class="link" href="GSignondSecretStorage.html#gsignond-secret-storage-update-credentials" title="gsignond_secret_storage_update_credentials ()"><code class="function">gsignond_secret_storage_update_credentials()</code></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="GSignondSecretStorageClass.remove-credentials"></a>remove_credentials</code></em> ()</span></p></td> +<td>an implementation of <a class="link" href="GSignondSecretStorage.html#gsignond-secret-storage-remove-credentials" title="gsignond_secret_storage_remove_credentials ()"><code class="function">gsignond_secret_storage_remove_credentials()</code></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="GSignondSecretStorageClass.check-credentials"></a>check_credentials</code></em> ()</span></p></td> +<td>an implementation of <a class="link" href="GSignondSecretStorage.html#gsignond-secret-storage-check-credentials" title="gsignond_secret_storage_check_credentials ()"><code class="function">gsignond_secret_storage_check_credentials()</code></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="GSignondSecretStorageClass.load-data"></a>load_data</code></em> ()</span></p></td> +<td>an implementation of <a class="link" href="GSignondSecretStorage.html#gsignond-secret-storage-load-data" title="gsignond_secret_storage_load_data ()"><code class="function">gsignond_secret_storage_load_data()</code></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="GSignondSecretStorageClass.update-data"></a>update_data</code></em> ()</span></p></td> +<td>an implementation of <a class="link" href="GSignondSecretStorage.html#gsignond-secret-storage-update-data" title="gsignond_secret_storage_update_data ()"><code class="function">gsignond_secret_storage_update_data()</code></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="GSignondSecretStorageClass.remove-data"></a>remove_data</code></em> ()</span></p></td> +<td>an implementation of <a class="link" href="GSignondSecretStorage.html#gsignond-secret-storage-remove-data" title="gsignond_secret_storage_remove_data ()"><code class="function">gsignond_secret_storage_remove_data()</code></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="GSignondSecretStorageClass.get-last-error"></a>get_last_error</code></em> ()</span></p></td> +<td>an implementation of <a class="link" href="GSignondSecretStorage.html#gsignond-secret-storage-get-last-error" title="gsignond_secret_storage_get_last_error ()"><code class="function">gsignond_secret_storage_get_last_error()</code></a> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-secret-storage-check-credentials"></a><h3>gsignond_secret_storage_check_credentials ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gsignond_secret_storage_check_credentials + (<em class="parameter"><code><a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a> *self</code></em>, + <em class="parameter"><code><a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> *creds</code></em>);</pre> +<p> +Checks whether the given credentials match what is stored in the database. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>instance of <a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>creds</code></em> :</span></p></td> +<td>the credentials that are being checked. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>TRUE if successful, FALSE otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-secret-storage-clear-db"></a><h3>gsignond_secret_storage_clear_db ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gsignond_secret_storage_clear_db (<em class="parameter"><code><a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a> *self</code></em>);</pre> +<p> +Removes all stored secrets from the database. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>instance of <a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>TRUE if successful, FALSE otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-secret-storage-close-db"></a><h3>gsignond_secret_storage_close_db ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gsignond_secret_storage_close_db (<em class="parameter"><code><a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a> *self</code></em>);</pre> +<p> +Closes the database. To reopen it, call <a class="link" href="GSignondSecretStorage.html#gsignond-secret-storage-open-db" title="gsignond_secret_storage_open_db ()"><code class="function">gsignond_secret_storage_open_db()</code></a>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>instance of <a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>TRUE if successful, FALSE otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-secret-storage-get-last-error"></a><h3>gsignond_secret_storage_get_last_error ()</h3> +<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="returnvalue">GError</span></a> * gsignond_secret_storage_get_last_error + (<em class="parameter"><code><a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a> *self</code></em>);</pre> +<p> +Retrieves the last occurred error that has occured +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>instance of <a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>last occurred <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-secret-storage-is-open-db"></a><h3>gsignond_secret_storage_is_open_db ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gsignond_secret_storage_is_open_db (<em class="parameter"><code><a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a> *self</code></em>);</pre> +<p> +Checks if the database is open or not. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>instance of <a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>TRUE if successful, FALSE otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-secret-storage-load-credentials"></a><h3>gsignond_secret_storage_load_credentials ()</h3> +<pre class="programlisting"><a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="returnvalue">GSignondCredentials</span></a> * gsignond_secret_storage_load_credentials + (<em class="parameter"><code><a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a> *self</code></em>, + <em class="parameter"><code>const <span class="type">guint32</span> id</code></em>);</pre> +<p> +Loads the credentials from the database. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>instance of <a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td> +<td>the identity id whose credentials are being loaded.</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> if successful, +NULL otherwise. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-secret-storage-load-data"></a><h3>gsignond_secret_storage_load_data ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="returnvalue">GHashTable</span></a> * gsignond_secret_storage_load_data (<em class="parameter"><code><a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a> *self</code></em>, + <em class="parameter"><code>const <span class="type">guint32</span> id</code></em>, + <em class="parameter"><code>const <span class="type">guint32</span> method</code></em>);</pre> +<p> +Loads the secret data associated with a given identity and method. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>instance of <a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td> +<td>the identity id whose data are fetched</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>method</code></em> :</span></p></td> +<td>the authentication method the data is used for.</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the secret data. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-secret-storage-open-db"></a><h3>gsignond_secret_storage_open_db ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gsignond_secret_storage_open_db (<em class="parameter"><code><a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a> *self</code></em>);</pre> +<p> +Opens (and initializes) the database. The implementation should take +care of creating the DB, if it doesn't exist, and it should use +<a class="link" href="gsignond-General-configuration.html#GSIGNOND-CONFIG-GENERAL-SECURE-DIR:CAPS" title="GSIGNOND_CONFIG_GENERAL_SECURE_DIR"><span class="type">GSIGNOND_CONFIG_GENERAL_SECURE_DIR</span></a> and <a class="link" href="gsignond-Database-configuration.html#GSIGNOND-CONFIG-DB-SECRET-DB-FILENAME:CAPS" title="GSIGNOND_CONFIG_DB_SECRET_DB_FILENAME"><span class="type">GSIGNOND_CONFIG_DB_SECRET_DB_FILENAME</span></a> +to determine database location in the filesystem. +</p> +<p> +The default implementation is using SQLite for the storage. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>instance of <a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>TRUE if successful, FALSE otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-secret-storage-remove-credentials"></a><h3>gsignond_secret_storage_remove_credentials ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gsignond_secret_storage_remove_credentials + (<em class="parameter"><code><a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a> *self</code></em>, + <em class="parameter"><code>const <span class="type">guint32</span> id</code></em>);</pre> +<p> +Remove the credentials for the given identity. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>instance of <a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td> +<td>the identity whose credentials are being updated.</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>TRUE if successful, FALSE otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-secret-storage-remove-data"></a><h3>gsignond_secret_storage_remove_data ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gsignond_secret_storage_remove_data (<em class="parameter"><code><a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a> *self</code></em>, + <em class="parameter"><code>const <span class="type">guint32</span> id</code></em>, + <em class="parameter"><code>const <span class="type">guint32</span> method</code></em>);</pre> +<p> +Removes secret data associated with a given id/method. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>instance of <a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td> +<td>the identity whose data are fetched.</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>method</code></em> :</span></p></td> +<td>the authentication method the data is used for.</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>TRUE if successful, FALSE otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-secret-storage-update-credentials"></a><h3>gsignond_secret_storage_update_credentials ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gsignond_secret_storage_update_credentials + (<em class="parameter"><code><a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a> *self</code></em>, + <em class="parameter"><code><a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> *creds</code></em>);</pre> +<p> +Stores/updates the credentials for the given identity. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>instance of <a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>creds</code></em> :</span></p></td> +<td>the credentials that are being updated. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>TRUE if successful, FALSE otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-secret-storage-update-data"></a><h3>gsignond_secret_storage_update_data ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gsignond_secret_storage_update_data (<em class="parameter"><code><a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a> *self</code></em>, + <em class="parameter"><code>const <span class="type">guint32</span> id</code></em>, + <em class="parameter"><code>const <span class="type">guint32</span> method</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> *data</code></em>);</pre> +<p> +Calling this method updates the secret data +associated with the given id/method. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>instance of <a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td> +<td>the identity whose data are fetched.</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>method</code></em> :</span></p></td> +<td>the authentication method the data is used for.</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> +<td>the data to update. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>TRUE if successful, FALSE otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<div class="refsect1"> +<a name="GSignondSecretStorage.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="GSignondSecretStorage--config"></a><h3>The <code class="literal">"config"</code> property</h3> +<pre class="programlisting"> "config" <a class="link" href="GSignondConfig.html" title="GSignondConfig"><span class="type">GSignondConfig</span></a>* : Read / Write / Construct Only</pre> +<p>Configuration object.</p> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.19.1</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/html/GSignondSsoTestPlugin.html b/docs/html/GSignondSsoTestPlugin.html new file mode 100644 index 0000000..ba18da5 --- /dev/null +++ b/docs/html/GSignondSsoTestPlugin.html @@ -0,0 +1,101 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GSignondSsoTestPlugin</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="gsignond API Reference Manual"> +<link rel="up" href="ch04.html" title="Standard in-tree authentication plugins"> +<link rel="prev" href="GSignondDigestPlugin.html" title="GSignondDigestPlugin"> +<link rel="next" href="GSignondPasswordPlugin.html" title="GSignondPasswordPlugin"> +<meta name="generator" content="GTK-Doc V1.19.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle"> +<td width="100%" align="left"> +<a href="#" class="shortcut">Top</a> +  | + <a href="#GSignondSsoTestPlugin.description" class="shortcut">Description</a> +  | + <a href="#GSignondSsoTestPlugin.object-hierarchy" class="shortcut">Object Hierarchy</a> +  | + <a href="#GSignondSsoTestPlugin.implemented-interfaces" class="shortcut">Implemented Interfaces</a> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="ch04.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="GSignondDigestPlugin.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="GSignondPasswordPlugin.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="GSignondSsoTestPlugin"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GSignondSsoTestPlugin.top_of_page"></a>GSignondSsoTestPlugin</span></h2> +<p>GSignondSsoTestPlugin — a plugin that is used internally in gsignond unit test</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="GSignondSsoTestPlugin.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis"> +#include <gsignond/gsignond-ssotest-plugin.h> + +struct <a class="link" href="GSignondSsoTestPlugin.html#GSignondSsoTestPlugin-struct" title="struct GSignondSsoTestPlugin">GSignondSsoTestPlugin</a>; +struct <a class="link" href="GSignondSsoTestPlugin.html#GSignondSsoTestPluginClass" title="struct GSignondSsoTestPluginClass">GSignondSsoTestPluginClass</a>; +</pre> +</div> +<div class="refsect1"> +<a name="GSignondSsoTestPlugin.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> + +----GSignondSsoTestPlugin +</pre> +</div> +<div class="refsect1"> +<a name="GSignondSsoTestPlugin.implemented-interfaces"></a><h2>Implemented Interfaces</h2> +<p> +GSignondSsoTestPlugin implements + GSignondPlugin.</p> +</div> +<div class="refsect1"> +<a name="GSignondSsoTestPlugin.description"></a><h2>Description</h2> +<p> +<a class="link" href="GSignondSsoTestPlugin.html" title="GSignondSsoTestPlugin"><span class="type">GSignondSsoTestPlugin</span></a> is used by gsignond unit tests. It should not be used +by applications. +</p> +</div> +<div class="refsect1"> +<a name="GSignondSsoTestPlugin.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GSignondSsoTestPlugin-struct"></a><h3>struct GSignondSsoTestPlugin</h3> +<pre class="programlisting">struct GSignondSsoTestPlugin;</pre> +<p> +Opaque <a class="link" href="GSignondSsoTestPlugin.html" title="GSignondSsoTestPlugin"><span class="type">GSignondSsoTestPlugin</span></a> data structure. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="GSignondSsoTestPluginClass"></a><h3>struct GSignondSsoTestPluginClass</h3> +<pre class="programlisting">struct GSignondSsoTestPluginClass { + GObjectClass parent_class; +}; +</pre> +<p> +Opaque <a class="link" href="GSignondSsoTestPlugin.html#GSignondSsoTestPluginClass" title="struct GSignondSsoTestPluginClass"><span class="type">GSignondSsoTestPluginClass</span></a> data structure. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a> <em class="structfield"><code><a name="GSignondSsoTestPluginClass.parent-class"></a>parent_class</code></em>;</span></p></td> +<td>the parent class structure</td> +</tr></tbody> +</table></div> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.19.1</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/html/GSignondStorageManager.html b/docs/html/GSignondStorageManager.html new file mode 100644 index 0000000..09eb1fb --- /dev/null +++ b/docs/html/GSignondStorageManager.html @@ -0,0 +1,305 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GSignondStorageManager</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="gsignond API Reference Manual"> +<link rel="up" href="ch05.html" title="GSignond API for writing platform adaptation extensions"> +<link rel="prev" href="gsignond-GSignondSecurityContext.html" title="GSignondSecurityContext"> +<link rel="next" href="GSignondSecretStorage.html" title="GSignondSecretStorage"> +<meta name="generator" content="GTK-Doc V1.19.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle"> +<td width="100%" align="left"> +<a href="#" class="shortcut">Top</a> +  | + <a href="#GSignondStorageManager.description" class="shortcut">Description</a> +  | + <a href="#GSignondStorageManager.object-hierarchy" class="shortcut">Object Hierarchy</a> +  | + <a href="#GSignondStorageManager.properties" class="shortcut">Properties</a> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="ch05.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="gsignond-GSignondSecurityContext.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="GSignondSecretStorage.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="GSignondStorageManager"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GSignondStorageManager.top_of_page"></a>GSignondStorageManager</span></h2> +<p>GSignondStorageManager — manages encrypted disk storage for storing the secret database</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="GSignondStorageManager.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis"> +#include <gsignond/gsignond-plugin-interface.h> + +struct <a class="link" href="GSignondStorageManager.html#GSignondStorageManager-struct" title="struct GSignondStorageManager">GSignondStorageManager</a>; +struct <a class="link" href="GSignondStorageManager.html#GSignondStorageManagerClass" title="struct GSignondStorageManagerClass">GSignondStorageManagerClass</a>; +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GSignondStorageManager.html#gsignond-storage-manager-delete-storage" title="gsignond_storage_manager_delete_storage ()">gsignond_storage_manager_delete_storage</a> + (<em class="parameter"><code><a class="link" href="GSignondStorageManager.html" title="GSignondStorageManager"><span class="type">GSignondStorageManager</span></a> *self</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GSignondStorageManager.html#gsignond-storage-manager-filesystem-is-mounted" title="gsignond_storage_manager_filesystem_is_mounted ()">gsignond_storage_manager_filesystem_is_mounted</a> + (<em class="parameter"><code><a class="link" href="GSignondStorageManager.html" title="GSignondStorageManager"><span class="type">GSignondStorageManager</span></a> *self</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GSignondStorageManager.html#gsignond-storage-manager-initialize-storage" title="gsignond_storage_manager_initialize_storage ()">gsignond_storage_manager_initialize_storage</a> + (<em class="parameter"><code><a class="link" href="GSignondStorageManager.html" title="GSignondStorageManager"><span class="type">GSignondStorageManager</span></a> *self</code></em>); +const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="GSignondStorageManager.html#gsignond-storage-manager-mount-filesystem" title="gsignond_storage_manager_mount_filesystem ()">gsignond_storage_manager_mount_filesystem</a> + (<em class="parameter"><code><a class="link" href="GSignondStorageManager.html" title="GSignondStorageManager"><span class="type">GSignondStorageManager</span></a> *self</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GSignondStorageManager.html#gsignond-storage-manager-storage-is-initialized" title="gsignond_storage_manager_storage_is_initialized ()">gsignond_storage_manager_storage_is_initialized</a> + (<em class="parameter"><code><a class="link" href="GSignondStorageManager.html" title="GSignondStorageManager"><span class="type">GSignondStorageManager</span></a> *self</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GSignondStorageManager.html#gsignond-storage-manager-unmount-filesystem" title="gsignond_storage_manager_unmount_filesystem ()">gsignond_storage_manager_unmount_filesystem</a> + (<em class="parameter"><code><a class="link" href="GSignondStorageManager.html" title="GSignondStorageManager"><span class="type">GSignondStorageManager</span></a> *self</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="GSignondStorageManager.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> + +----GSignondStorageManager +</pre> +</div> +<div class="refsect1"> +<a name="GSignondStorageManager.properties"></a><h2>Properties</h2> +<pre class="synopsis"> + "<a class="link" href="GSignondStorageManager.html#GSignondStorageManager--config" title='The "config" property'>config</a>" <a class="link" href="GSignondConfig.html" title="GSignondConfig"><span class="type">GSignondConfig</span></a>* : Read / Write / Construct Only +</pre> +</div> +<div class="refsect1"> +<a name="GSignondStorageManager.description"></a><h2>Description</h2> +<p> +<a class="link" href="GSignondStorageManager.html" title="GSignondStorageManager"><span class="type">GSignondStorageManager</span></a> manages encrypted disk storage for storing the +databases. The default implementation maintains a simple per-user +directory accessible only to root and gsignond group, but gSSO can be +configured to use a custom extension that provides a subclassed +implementation of <a class="link" href="GSignondStorageManager.html" title="GSignondStorageManager"><span class="type">GSignondStorageManager</span></a> +(see <a class="link" href="GSignondExtension.html" title="GSignondExtension"><span class="type">GSignondExtension</span></a> for instructions and pointers to examples). +</p> +</div> +<div class="refsect1"> +<a name="GSignondStorageManager.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GSignondStorageManager-struct"></a><h3>struct GSignondStorageManager</h3> +<pre class="programlisting">struct GSignondStorageManager;</pre> +<p> +Opaque <a class="link" href="GSignondStorageManager.html" title="GSignondStorageManager"><span class="type">GSignondStorageManager</span></a> data structure. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="GSignondStorageManagerClass"></a><h3>struct GSignondStorageManagerClass</h3> +<pre class="programlisting">struct GSignondStorageManagerClass { + GObjectClass parent_class; + + gboolean (*initialize_storage) (GSignondStorageManager *self); + gboolean (*delete_storage) (GSignondStorageManager *self); + gboolean (*storage_is_initialized) (GSignondStorageManager *self); + const gchar * (*mount_filesystem) (GSignondStorageManager *self); + gboolean (*unmount_filesystem) (GSignondStorageManager *self); + gboolean (*filesystem_is_mounted) (GSignondStorageManager *self); +}; +</pre> +<p> +<a class="link" href="GSignondStorageManager.html#GSignondStorageManagerClass" title="struct GSignondStorageManagerClass"><span class="type">GSignondStorageManagerClass</span></a> class containing pointers to class methods. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a> <em class="structfield"><code><a name="GSignondStorageManagerClass.parent-class"></a>parent_class</code></em>;</span></p></td> +<td>parent class.</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="GSignondStorageManagerClass.initialize-storage"></a>initialize_storage</code></em> ()</span></p></td> +<td>an implementation of <a class="link" href="GSignondStorageManager.html#gsignond-storage-manager-initialize-storage" title="gsignond_storage_manager_initialize_storage ()"><code class="function">gsignond_storage_manager_initialize_storage()</code></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="GSignondStorageManagerClass.delete-storage"></a>delete_storage</code></em> ()</span></p></td> +<td>an implementation of <a class="link" href="GSignondStorageManager.html#gsignond-storage-manager-delete-storage" title="gsignond_storage_manager_delete_storage ()"><code class="function">gsignond_storage_manager_delete_storage()</code></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="GSignondStorageManagerClass.storage-is-initialized"></a>storage_is_initialized</code></em> ()</span></p></td> +<td>an implementation of <a class="link" href="GSignondStorageManager.html#gsignond-storage-manager-storage-is-initialized" title="gsignond_storage_manager_storage_is_initialized ()"><code class="function">gsignond_storage_manager_storage_is_initialized()</code></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="GSignondStorageManagerClass.mount-filesystem"></a>mount_filesystem</code></em> ()</span></p></td> +<td>an implementation of <a class="link" href="GSignondStorageManager.html#gsignond-storage-manager-mount-filesystem" title="gsignond_storage_manager_mount_filesystem ()"><code class="function">gsignond_storage_manager_mount_filesystem()</code></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="GSignondStorageManagerClass.unmount-filesystem"></a>unmount_filesystem</code></em> ()</span></p></td> +<td>an implementation of <a class="link" href="GSignondStorageManager.html#gsignond-storage-manager-unmount-filesystem" title="gsignond_storage_manager_unmount_filesystem ()"><code class="function">gsignond_storage_manager_unmount_filesystem()</code></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="GSignondStorageManagerClass.filesystem-is-mounted"></a>filesystem_is_mounted</code></em> ()</span></p></td> +<td>an implementation of <a class="link" href="GSignondStorageManager.html#gsignond-storage-manager-filesystem-is-mounted" title="gsignond_storage_manager_filesystem_is_mounted ()"><code class="function">gsignond_storage_manager_filesystem_is_mounted()</code></a> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-storage-manager-delete-storage"></a><h3>gsignond_storage_manager_delete_storage ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gsignond_storage_manager_delete_storage + (<em class="parameter"><code><a class="link" href="GSignondStorageManager.html" title="GSignondStorageManager"><span class="type">GSignondStorageManager</span></a> *self</code></em>);</pre> +<p> +Destroys all the encryption keys and wipes the storage. <a class="link" href="gsignond-Utility-functions.html#gsignond-wipe-directory" title="gsignond_wipe_directory ()"><code class="function">gsignond_wipe_directory()</code></a> +is typically used for the latter. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>object instance.</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>success?</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-storage-manager-filesystem-is-mounted"></a><h3>gsignond_storage_manager_filesystem_is_mounted ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gsignond_storage_manager_filesystem_is_mounted + (<em class="parameter"><code><a class="link" href="GSignondStorageManager.html" title="GSignondStorageManager"><span class="type">GSignondStorageManager</span></a> *self</code></em>);</pre> +<p> +Checks if the encrypted storage filesystem is currently mounted. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>object instance.</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>filesystem is currently mounted?</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-storage-manager-initialize-storage"></a><h3>gsignond_storage_manager_initialize_storage ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gsignond_storage_manager_initialize_storage + (<em class="parameter"><code><a class="link" href="GSignondStorageManager.html" title="GSignondStorageManager"><span class="type">GSignondStorageManager</span></a> *self</code></em>);</pre> +<p> +Initialize encryption storage. This means making sure that the +necessary directories exist and are accessible. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>object instance.</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>success?</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-storage-manager-mount-filesystem"></a><h3>gsignond_storage_manager_mount_filesystem ()</h3> +<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gsignond_storage_manager_mount_filesystem + (<em class="parameter"><code><a class="link" href="GSignondStorageManager.html" title="GSignondStorageManager"><span class="type">GSignondStorageManager</span></a> *self</code></em>);</pre> +<p> +Mounts an encrypted storage and returns the filesystem path of the storage +mount point. This path will be used to access the secret database via +<a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a>. +</p> +<p> +The default implemenation does nothing, and immediately returns the path for the +secret database. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>object instance.</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>path of the storage mount point. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-storage-manager-storage-is-initialized"></a><h3>gsignond_storage_manager_storage_is_initialized ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gsignond_storage_manager_storage_is_initialized + (<em class="parameter"><code><a class="link" href="GSignondStorageManager.html" title="GSignondStorageManager"><span class="type">GSignondStorageManager</span></a> *self</code></em>);</pre> +<p> +Checks if the storage has been initialized. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>object instance.</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>storage has been initialized?</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-storage-manager-unmount-filesystem"></a><h3>gsignond_storage_manager_unmount_filesystem ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gsignond_storage_manager_unmount_filesystem + (<em class="parameter"><code><a class="link" href="GSignondStorageManager.html" title="GSignondStorageManager"><span class="type">GSignondStorageManager</span></a> *self</code></em>);</pre> +<p> +Unmounts a previously mounted encrypted storage filesystem. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>object instance.</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>success?</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<div class="refsect1"> +<a name="GSignondStorageManager.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="GSignondStorageManager--config"></a><h3>The <code class="literal">"config"</code> property</h3> +<pre class="programlisting"> "config" <a class="link" href="GSignondConfig.html" title="GSignondConfig"><span class="type">GSignondConfig</span></a>* : Read / Write / Construct Only</pre> +<p>Configuration object.</p> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.19.1</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/html/annotation-glossary.html b/docs/html/annotation-glossary.html new file mode 100644 index 0000000..f4b18b3 --- /dev/null +++ b/docs/html/annotation-glossary.html @@ -0,0 +1,36 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Annotation Glossary</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="gsignond API Reference Manual"> +<link rel="up" href="index.html" title="gsignond API Reference Manual"> +<link rel="prev" href="deprecated-api-index.html" title="Index of deprecated API"> +<meta name="generator" content="GTK-Doc V1.19.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle"> +<td width="100%" align="left"><a class="shortcut" href="#glsT">T</a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><img src="up-insensitive.png" width="16" height="16" border="0"></td> +<td><a accesskey="p" href="deprecated-api-index.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><img src="right-insensitive.png" width="16" height="16" border="0"></td> +</tr></table> +<div class="glossary"> +<div class="titlepage"><div><div><h2 class="title"> +<a name="annotation-glossary"></a>Annotation Glossary</h2></div></div></div> +<a name="glsT"></a><h3 class="title">T</h3> +<dt> +<a name="annotation-glossterm-transfer%20full"></a>transfer full</dt> +<dd><p>Free data after the code is done.</p></dd> +<dt> +<a name="annotation-glossterm-transfer%20none"></a>transfer none</dt> +<dd><p>Don't free data after the code is done.</p></dd> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.19.1</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/html/api-index-full.html b/docs/html/api-index-full.html new file mode 100644 index 0000000..226ebd4 --- /dev/null +++ b/docs/html/api-index-full.html @@ -0,0 +1,891 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>API Index</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="gsignond API Reference Manual"> +<link rel="up" href="index.html" title="gsignond API Reference Manual"> +<link rel="prev" href="object-tree.html" title="Object Hierarchy"> +<link rel="next" href="deprecated-api-index.html" title="Index of deprecated API"> +<meta name="generator" content="GTK-Doc V1.19.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle"> +<td width="100%" align="left"> +<a class="shortcut" href="#idxA">A</a> + Â |Â + <a class="shortcut" href="#idxC">C</a> + Â |Â + <a class="shortcut" href="#idxD">D</a> + Â |Â + <a class="shortcut" href="#idxE">E</a> + Â |Â + <a class="shortcut" href="#idxG">G</a> + Â |Â + <a class="shortcut" href="#idxI">I</a> + Â |Â + <a class="shortcut" href="#idxP">P</a> + Â |Â + <a class="shortcut" href="#idxS">S</a> + Â |Â + <a class="shortcut" href="#idxT">T</a> + Â |Â + <a class="shortcut" href="#idxU">U</a> + Â |Â + <a class="shortcut" href="#idxW">W</a> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><img src="up-insensitive.png" width="16" height="16" border="0"></td> +<td><a accesskey="p" href="object-tree.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="deprecated-api-index.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="index"> +<div class="titlepage"><div><div><h2 class="title"> +<a name="api-index-full"></a>API Index</h2></div></div></div> +<a name="idx"></a><a name="idxA"></a><h3 class="title">A</h3> +<dt> +<a class="link" href="GSignondAccessControlManager.html#GSignondAccessControlManager-struct" title="struct GSignondAccessControlManager">GSignondAccessControlManager</a>, struct in <a class="link" href="GSignondAccessControlManager.html" title="GSignondAccessControlManager">GSignondAccessControlManager</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GSignondAccessControlManager.html#GSignondAccessControlManager--config" title='The "config" property'>GSignondAccessControlManager:config</a>, object property in <a class="link" href="GSignondAccessControlManager.html" title="GSignondAccessControlManager">GSignondAccessControlManager</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GSignondAccessControlManager.html#GSignondAccessControlManagerClass" title="struct GSignondAccessControlManagerClass">GSignondAccessControlManagerClass</a>, struct in <a class="link" href="GSignondAccessControlManager.html" title="GSignondAccessControlManager">GSignondAccessControlManager</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GSignondAccessControlManager.html#gsignond-access-control-manager-acl-is-valid" title="gsignond_access_control_manager_acl_is_valid ()">gsignond_access_control_manager_acl_is_valid</a>, function in <a class="link" href="GSignondAccessControlManager.html" title="GSignondAccessControlManager">GSignondAccessControlManager</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GSignondAccessControlManager.html#gsignond-access-control-manager-peer-is-allowed-to-use-identity" title="gsignond_access_control_manager_peer_is_allowed_to_use_identity ()">gsignond_access_control_manager_peer_is_allowed_to_use_identity</a>, function in <a class="link" href="GSignondAccessControlManager.html" title="GSignondAccessControlManager">GSignondAccessControlManager</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GSignondAccessControlManager.html#gsignond-access-control-manager-peer-is-owner-of-identity" title="gsignond_access_control_manager_peer_is_owner_of_identity ()">gsignond_access_control_manager_peer_is_owner_of_identity</a>, function in <a class="link" href="GSignondAccessControlManager.html" title="GSignondAccessControlManager">GSignondAccessControlManager</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GSignondAccessControlManager.html#gsignond-access-control-manager-security-context-of-keychain" title="gsignond_access_control_manager_security_context_of_keychain ()">gsignond_access_control_manager_security_context_of_keychain</a>, function in <a class="link" href="GSignondAccessControlManager.html" title="GSignondAccessControlManager">GSignondAccessControlManager</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GSignondAccessControlManager.html#gsignond-access-control-manager-security-context-of-peer" title="gsignond_access_control_manager_security_context_of_peer ()">gsignond_access_control_manager_security_context_of_peer</a>, function in <a class="link" href="GSignondAccessControlManager.html" title="GSignondAccessControlManager">GSignondAccessControlManager</a> +</dt> +<dd></dd> +<a name="idxC"></a><h3 class="title">C</h3> +<dt> +<a class="link" href="GSignondConfig.html#GSignondConfig-struct" title="struct GSignondConfig">GSignondConfig</a>, struct in <a class="link" href="GSignondConfig.html" title="GSignondConfig">GSignondConfig</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GSignondConfig.html#GSignondConfigClass" title="struct GSignondConfigClass">GSignondConfigClass</a>, struct in <a class="link" href="GSignondConfig.html" title="GSignondConfig">GSignondConfig</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-DBus-configuration.html#GSIGNOND-CONFIG-DBUS-AUTH-SESSION-TIMEOUT:CAPS" title="GSIGNOND_CONFIG_DBUS_AUTH_SESSION_TIMEOUT">GSIGNOND_CONFIG_DBUS_AUTH_SESSION_TIMEOUT</a>, macro in <a class="link" href="gsignond-DBus-configuration.html" title="DBus configuration">DBus configuration</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-DBus-configuration.html#GSIGNOND-CONFIG-DBUS-DAEMON-TIMEOUT:CAPS" title="GSIGNOND_CONFIG_DBUS_DAEMON_TIMEOUT">GSIGNOND_CONFIG_DBUS_DAEMON_TIMEOUT</a>, macro in <a class="link" href="gsignond-DBus-configuration.html" title="DBus configuration">DBus configuration</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-DBus-configuration.html#GSIGNOND-CONFIG-DBUS-IDENTITY-TIMEOUT:CAPS" title="GSIGNOND_CONFIG_DBUS_IDENTITY_TIMEOUT">GSIGNOND_CONFIG_DBUS_IDENTITY_TIMEOUT</a>, macro in <a class="link" href="gsignond-DBus-configuration.html" title="DBus configuration">DBus configuration</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-DBus-configuration.html#GSIGNOND-CONFIG-DBUS-TIMEOUTS:CAPS" title="GSIGNOND_CONFIG_DBUS_TIMEOUTS">GSIGNOND_CONFIG_DBUS_TIMEOUTS</a>, macro in <a class="link" href="gsignond-DBus-configuration.html" title="DBus configuration">DBus configuration</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-Database-configuration.html#GSIGNOND-CONFIG-DB-METADATA-DB-FILENAME:CAPS" title="GSIGNOND_CONFIG_DB_METADATA_DB_FILENAME">GSIGNOND_CONFIG_DB_METADATA_DB_FILENAME</a>, macro in <a class="link" href="gsignond-Database-configuration.html" title="Database configuration">Database configuration</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-Database-configuration.html#GSIGNOND-CONFIG-DB-SECRET-DB-FILENAME:CAPS" title="GSIGNOND_CONFIG_DB_SECRET_DB_FILENAME">GSIGNOND_CONFIG_DB_SECRET_DB_FILENAME</a>, macro in <a class="link" href="gsignond-Database-configuration.html" title="Database configuration">Database configuration</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-Database-configuration.html#GSIGNOND-CONFIG-DB-SSO:CAPS" title="GSIGNOND_CONFIG_DB_SSO">GSIGNOND_CONFIG_DB_SSO</a>, macro in <a class="link" href="gsignond-Database-configuration.html" title="Database configuration">Database configuration</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-General-configuration.html#GSIGNOND-CONFIG-GENERAL:CAPS" title="GSIGNOND_CONFIG_GENERAL">GSIGNOND_CONFIG_GENERAL</a>, macro in <a class="link" href="gsignond-General-configuration.html" title="General configuration">General configuration</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-General-configuration.html#GSIGNOND-CONFIG-GENERAL-BIN-DIR:CAPS" title="GSIGNOND_CONFIG_GENERAL_BIN_DIR">GSIGNOND_CONFIG_GENERAL_BIN_DIR</a>, macro in <a class="link" href="gsignond-General-configuration.html" title="General configuration">General configuration</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-General-configuration.html#GSIGNOND-CONFIG-GENERAL-EXTENSION:CAPS" title="GSIGNOND_CONFIG_GENERAL_EXTENSION">GSIGNOND_CONFIG_GENERAL_EXTENSION</a>, macro in <a class="link" href="gsignond-General-configuration.html" title="General configuration">General configuration</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-General-configuration.html#GSIGNOND-CONFIG-GENERAL-EXTENSIONS-DIR:CAPS" title="GSIGNOND_CONFIG_GENERAL_EXTENSIONS_DIR">GSIGNOND_CONFIG_GENERAL_EXTENSIONS_DIR</a>, macro in <a class="link" href="gsignond-General-configuration.html" title="General configuration">General configuration</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-General-configuration.html#GSIGNOND-CONFIG-GENERAL-PLUGINS-DIR:CAPS" title="GSIGNOND_CONFIG_GENERAL_PLUGINS_DIR">GSIGNOND_CONFIG_GENERAL_PLUGINS_DIR</a>, macro in <a class="link" href="gsignond-General-configuration.html" title="General configuration">General configuration</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-General-configuration.html#GSIGNOND-CONFIG-GENERAL-SECURE-DIR:CAPS" title="GSIGNOND_CONFIG_GENERAL_SECURE_DIR">GSIGNOND_CONFIG_GENERAL_SECURE_DIR</a>, macro in <a class="link" href="gsignond-General-configuration.html" title="General configuration">General configuration</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-General-configuration.html#GSIGNOND-CONFIG-GENERAL-STORAGE-PATH:CAPS" title="GSIGNOND_CONFIG_GENERAL_STORAGE_PATH">GSIGNOND_CONFIG_GENERAL_STORAGE_PATH</a>, macro in <a class="link" href="gsignond-General-configuration.html" title="General configuration">General configuration</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GSignondConfig.html#gsignond-config-get-integer" title="gsignond_config_get_integer ()">gsignond_config_get_integer</a>, function in <a class="link" href="GSignondConfig.html" title="GSignondConfig">GSignondConfig</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GSignondConfig.html#gsignond-config-get-string" title="gsignond_config_get_string ()">gsignond_config_get_string</a>, function in <a class="link" href="GSignondConfig.html" title="GSignondConfig">GSignondConfig</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GSignondConfig.html#gsignond-config-new" title="gsignond_config_new ()">gsignond_config_new</a>, function in <a class="link" href="GSignondConfig.html" title="GSignondConfig">GSignondConfig</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-General-configuration.html#GSIGNOND-CONFIG-PLUGIN-TIMEOUT:CAPS" title="GSIGNOND_CONFIG_PLUGIN_TIMEOUT">GSIGNOND_CONFIG_PLUGIN_TIMEOUT</a>, macro in <a class="link" href="gsignond-General-configuration.html" title="General configuration">General configuration</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GSignondConfig.html#gsignond-config-set-integer" title="gsignond_config_set_integer ()">gsignond_config_set_integer</a>, function in <a class="link" href="GSignondConfig.html" title="GSignondConfig">GSignondConfig</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GSignondConfig.html#gsignond-config-set-string" title="gsignond_config_set_string ()">gsignond_config_set_string</a>, function in <a class="link" href="GSignondConfig.html" title="GSignondConfig">GSignondConfig</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GSignondCredentials.html#GSignondCredentials-struct" title="GSignondCredentials">GSignondCredentials</a>, struct in <a class="link" href="GSignondCredentials.html" title="GSignondCredentials">GSignondCredentials</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GSignondCredentials.html#GSignondCredentialsClass" title="GSignondCredentialsClass">GSignondCredentialsClass</a>, struct in <a class="link" href="GSignondCredentials.html" title="GSignondCredentials">GSignondCredentials</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GSignondCredentials.html#gsignond-credentials-equal" title="gsignond_credentials_equal ()">gsignond_credentials_equal</a>, function in <a class="link" href="GSignondCredentials.html" title="GSignondCredentials">GSignondCredentials</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GSignondCredentials.html#gsignond-credentials-get-id" title="gsignond_credentials_get_id ()">gsignond_credentials_get_id</a>, function in <a class="link" href="GSignondCredentials.html" title="GSignondCredentials">GSignondCredentials</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GSignondCredentials.html#gsignond-credentials-get-password" title="gsignond_credentials_get_password ()">gsignond_credentials_get_password</a>, function in <a class="link" href="GSignondCredentials.html" title="GSignondCredentials">GSignondCredentials</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GSignondCredentials.html#gsignond-credentials-get-username" title="gsignond_credentials_get_username ()">gsignond_credentials_get_username</a>, function in <a class="link" href="GSignondCredentials.html" title="GSignondCredentials">GSignondCredentials</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GSignondCredentials.html#gsignond-credentials-new" title="gsignond_credentials_new ()">gsignond_credentials_new</a>, function in <a class="link" href="GSignondCredentials.html" title="GSignondCredentials">GSignondCredentials</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GSignondCredentials.html#gsignond-credentials-set-data" title="gsignond_credentials_set_data ()">gsignond_credentials_set_data</a>, function in <a class="link" href="GSignondCredentials.html" title="GSignondCredentials">GSignondCredentials</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GSignondCredentials.html#gsignond-credentials-set-id" title="gsignond_credentials_set_id ()">gsignond_credentials_set_id</a>, function in <a class="link" href="GSignondCredentials.html" title="GSignondCredentials">GSignondCredentials</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GSignondCredentials.html#gsignond-credentials-set-password" title="gsignond_credentials_set_password ()">gsignond_credentials_set_password</a>, function in <a class="link" href="GSignondCredentials.html" title="GSignondCredentials">GSignondCredentials</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GSignondCredentials.html#gsignond-credentials-set-username" title="gsignond_credentials_set_username ()">gsignond_credentials_set_username</a>, function in <a class="link" href="GSignondCredentials.html" title="GSignondCredentials">GSignondCredentials</a> +</dt> +<dd></dd> +<a name="idxD"></a><h3 class="title">D</h3> +<dt> +<a class="link" href="gsignond-Logging.html#DBG:CAPS" title="DBG()">DBG</a>, macro in <a class="link" href="gsignond-Logging.html" title="Logging">Logging</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary">GSignondDictionary</a>, typedef in <a class="link" href="gsignond-GSignondDictionary.html" title="GSignondDictionary">GSignondDictionary</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-copy" title="gsignond_dictionary_copy ()">gsignond_dictionary_copy</a>, function in <a class="link" href="gsignond-GSignondDictionary.html" title="GSignondDictionary">GSignondDictionary</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-get" title="gsignond_dictionary_get ()">gsignond_dictionary_get</a>, function in <a class="link" href="gsignond-GSignondDictionary.html" title="GSignondDictionary">GSignondDictionary</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-get-boolean" title="gsignond_dictionary_get_boolean ()">gsignond_dictionary_get_boolean</a>, function in <a class="link" href="gsignond-GSignondDictionary.html" title="GSignondDictionary">GSignondDictionary</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-get-int32" title="gsignond_dictionary_get_int32 ()">gsignond_dictionary_get_int32</a>, function in <a class="link" href="gsignond-GSignondDictionary.html" title="GSignondDictionary">GSignondDictionary</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-get-int64" title="gsignond_dictionary_get_int64 ()">gsignond_dictionary_get_int64</a>, function in <a class="link" href="gsignond-GSignondDictionary.html" title="GSignondDictionary">GSignondDictionary</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-get-string" title="gsignond_dictionary_get_string ()">gsignond_dictionary_get_string</a>, function in <a class="link" href="gsignond-GSignondDictionary.html" title="GSignondDictionary">GSignondDictionary</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-get-uint32" title="gsignond_dictionary_get_uint32 ()">gsignond_dictionary_get_uint32</a>, function in <a class="link" href="gsignond-GSignondDictionary.html" title="GSignondDictionary">GSignondDictionary</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-get-uint64" title="gsignond_dictionary_get_uint64 ()">gsignond_dictionary_get_uint64</a>, function in <a class="link" href="gsignond-GSignondDictionary.html" title="GSignondDictionary">GSignondDictionary</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-new" title="gsignond_dictionary_new ()">gsignond_dictionary_new</a>, function in <a class="link" href="gsignond-GSignondDictionary.html" title="GSignondDictionary">GSignondDictionary</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-new-from-variant" title="gsignond_dictionary_new_from_variant ()">gsignond_dictionary_new_from_variant</a>, function in <a class="link" href="gsignond-GSignondDictionary.html" title="GSignondDictionary">GSignondDictionary</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-ref" title="gsignond_dictionary_ref ()">gsignond_dictionary_ref</a>, function in <a class="link" href="gsignond-GSignondDictionary.html" title="GSignondDictionary">GSignondDictionary</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-remove" title="gsignond_dictionary_remove ()">gsignond_dictionary_remove</a>, function in <a class="link" href="gsignond-GSignondDictionary.html" title="GSignondDictionary">GSignondDictionary</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-set" title="gsignond_dictionary_set ()">gsignond_dictionary_set</a>, function in <a class="link" href="gsignond-GSignondDictionary.html" title="GSignondDictionary">GSignondDictionary</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-set-boolean" title="gsignond_dictionary_set_boolean ()">gsignond_dictionary_set_boolean</a>, function in <a class="link" href="gsignond-GSignondDictionary.html" title="GSignondDictionary">GSignondDictionary</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-set-int32" title="gsignond_dictionary_set_int32 ()">gsignond_dictionary_set_int32</a>, function in <a class="link" href="gsignond-GSignondDictionary.html" title="GSignondDictionary">GSignondDictionary</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-set-int64" title="gsignond_dictionary_set_int64 ()">gsignond_dictionary_set_int64</a>, function in <a class="link" href="gsignond-GSignondDictionary.html" title="GSignondDictionary">GSignondDictionary</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-set-string" title="gsignond_dictionary_set_string ()">gsignond_dictionary_set_string</a>, function in <a class="link" href="gsignond-GSignondDictionary.html" title="GSignondDictionary">GSignondDictionary</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-set-uint32" title="gsignond_dictionary_set_uint32 ()">gsignond_dictionary_set_uint32</a>, function in <a class="link" href="gsignond-GSignondDictionary.html" title="GSignondDictionary">GSignondDictionary</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-set-uint64" title="gsignond_dictionary_set_uint64 ()">gsignond_dictionary_set_uint64</a>, function in <a class="link" href="gsignond-GSignondDictionary.html" title="GSignondDictionary">GSignondDictionary</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-to-variant" title="gsignond_dictionary_to_variant ()">gsignond_dictionary_to_variant</a>, function in <a class="link" href="gsignond-GSignondDictionary.html" title="GSignondDictionary">GSignondDictionary</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-unref" title="gsignond_dictionary_unref ()">gsignond_dictionary_unref</a>, function in <a class="link" href="gsignond-GSignondDictionary.html" title="GSignondDictionary">GSignondDictionary</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GSignondDigestPlugin.html#GSignondDigestPlugin-struct" title="struct GSignondDigestPlugin">GSignondDigestPlugin</a>, struct in <a class="link" href="GSignondDigestPlugin.html" title="GSignondDigestPlugin">GSignondDigestPlugin</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GSignondDigestPlugin.html#GSignondDigestPluginClass" title="struct GSignondDigestPluginClass">GSignondDigestPluginClass</a>, struct in <a class="link" href="GSignondDigestPlugin.html" title="GSignondDigestPlugin">GSignondDigestPlugin</a> +</dt> +<dd></dd> +<a name="idxE"></a><h3 class="title">E</h3> +<dt> +<a class="link" href="gsignond-Logging.html#ERR:CAPS" title="ERR()">ERR</a>, macro in <a class="link" href="gsignond-Logging.html" title="Logging">Logging</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-Errors.html#GSignondError" title="enum GSignondError">GSignondError</a>, enum in <a class="link" href="gsignond-Errors.html" title="Errors">Errors</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-Errors.html#GSIGNOND-ERROR:CAPS" title="GSIGNOND_ERROR">GSIGNOND_ERROR</a>, macro in <a class="link" href="gsignond-Errors.html" title="Errors">Errors</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-Errors.html#gsignond-error-new-from-variant" title="gsignond_error_new_from_variant ()">gsignond_error_new_from_variant</a>, function in <a class="link" href="gsignond-Errors.html" title="Errors">Errors</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-Errors.html#gsignond-error-quark" title="gsignond_error_quark ()">gsignond_error_quark</a>, function in <a class="link" href="gsignond-Errors.html" title="Errors">Errors</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-Errors.html#gsignond-error-to-variant" title="gsignond_error_to_variant ()">gsignond_error_to_variant</a>, function in <a class="link" href="gsignond-Errors.html" title="Errors">Errors</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GSignondExtension.html#GSignondExtension-struct" title="struct GSignondExtension">GSignondExtension</a>, struct in <a class="link" href="GSignondExtension.html" title="GSignondExtension">GSignondExtension</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GSignondExtension.html#GSignondExtensionClass" title="struct GSignondExtensionClass">GSignondExtensionClass</a>, struct in <a class="link" href="GSignondExtension.html" title="GSignondExtension">GSignondExtension</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GSignondExtension.html#gsignond-extension-get-access-control-manager" title="gsignond_extension_get_access_control_manager ()">gsignond_extension_get_access_control_manager</a>, function in <a class="link" href="GSignondExtension.html" title="GSignondExtension">GSignondExtension</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GSignondExtension.html#gsignond-extension-get-name" title="gsignond_extension_get_name ()">gsignond_extension_get_name</a>, function in <a class="link" href="GSignondExtension.html" title="GSignondExtension">GSignondExtension</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GSignondExtension.html#gsignond-extension-get-secret-storage" title="gsignond_extension_get_secret_storage ()">gsignond_extension_get_secret_storage</a>, function in <a class="link" href="GSignondExtension.html" title="GSignondExtension">GSignondExtension</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GSignondExtension.html#gsignond-extension-get-storage-manager" title="gsignond_extension_get_storage_manager ()">gsignond_extension_get_storage_manager</a>, function in <a class="link" href="GSignondExtension.html" title="GSignondExtension">GSignondExtension</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GSignondExtension.html#gsignond-extension-get-version" title="gsignond_extension_get_version ()">gsignond_extension_get_version</a>, function in <a class="link" href="GSignondExtension.html" title="GSignondExtension">GSignondExtension</a> +</dt> +<dd></dd> +<a name="idxG"></a><h3 class="title">G</h3> +<dt> +<a class="link" href="gsignond-Utility-functions.html#gsignond-generate-nonce" title="gsignond_generate_nonce ()">gsignond_generate_nonce</a>, function in <a class="link" href="gsignond-Utility-functions.html" title="Utility functions">Utility functions</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-Errors.html#gsignond-get-gerror-for-id" title="gsignond_get_gerror_for_id()">gsignond_get_gerror_for_id</a>, macro in <a class="link" href="gsignond-Errors.html" title="Errors">Errors</a> +</dt> +<dd></dd> +<a name="idxI"></a><h3 class="title">I</h3> +<dt> +<a class="link" href="gsignond-Logging.html#INFO:CAPS" title="INFO()">INFO</a>, macro in <a class="link" href="gsignond-Logging.html" title="Logging">Logging</a> +</dt> +<dd></dd> +<a name="idxP"></a><h3 class="title">P</h3> +<dt> +<a class="link" href="GSignondPasswordPlugin.html#GSignondPasswordPlugin-struct" title="struct GSignondPasswordPlugin">GSignondPasswordPlugin</a>, struct in <a class="link" href="GSignondPasswordPlugin.html" title="GSignondPasswordPlugin">GSignondPasswordPlugin</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GSignondPasswordPlugin.html#GSignondPasswordPluginClass" title="struct GSignondPasswordPluginClass">GSignondPasswordPluginClass</a>, struct in <a class="link" href="GSignondPasswordPlugin.html" title="GSignondPasswordPlugin">GSignondPasswordPlugin</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondPlugin.html#GSignondPluginInterface" title="struct GSignondPluginInterface">GSignondPluginInterface</a>, struct in <a class="link" href="gsignond-GSignondPlugin.html" title="GSignondPlugin">GSignondPlugin</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondPlugin.html#GSignondPluginState" title="enum GSignondPluginState">GSignondPluginState</a>, enum in <a class="link" href="gsignond-GSignondPlugin.html" title="GSignondPlugin">GSignondPlugin</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondPlugin.html#gsignond-plugin-cancel" title="gsignond_plugin_cancel ()">gsignond_plugin_cancel</a>, function in <a class="link" href="gsignond-GSignondPlugin.html" title="GSignondPlugin">GSignondPlugin</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondPlugin.html#gsignond-plugin-error" title="gsignond_plugin_error ()">gsignond_plugin_error</a>, function in <a class="link" href="gsignond-GSignondPlugin.html" title="GSignondPlugin">GSignondPlugin</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondPlugin.html#gsignond-plugin-refresh" title="gsignond_plugin_refresh ()">gsignond_plugin_refresh</a>, function in <a class="link" href="gsignond-GSignondPlugin.html" title="GSignondPlugin">GSignondPlugin</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondPlugin.html#gsignond-plugin-refreshed" title="gsignond_plugin_refreshed ()">gsignond_plugin_refreshed</a>, function in <a class="link" href="gsignond-GSignondPlugin.html" title="GSignondPlugin">GSignondPlugin</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondPlugin.html#gsignond-plugin-request" title="gsignond_plugin_request ()">gsignond_plugin_request</a>, function in <a class="link" href="gsignond-GSignondPlugin.html" title="GSignondPlugin">GSignondPlugin</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondPlugin.html#gsignond-plugin-request-initial" title="gsignond_plugin_request_initial ()">gsignond_plugin_request_initial</a>, function in <a class="link" href="gsignond-GSignondPlugin.html" title="GSignondPlugin">GSignondPlugin</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondPlugin.html#gsignond-plugin-response" title="gsignond_plugin_response ()">gsignond_plugin_response</a>, function in <a class="link" href="gsignond-GSignondPlugin.html" title="GSignondPlugin">GSignondPlugin</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondPlugin.html#gsignond-plugin-response-final" title="gsignond_plugin_response_final ()">gsignond_plugin_response_final</a>, function in <a class="link" href="gsignond-GSignondPlugin.html" title="GSignondPlugin">GSignondPlugin</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondPlugin.html#gsignond-plugin-status-changed" title="gsignond_plugin_status_changed ()">gsignond_plugin_status_changed</a>, function in <a class="link" href="gsignond-GSignondPlugin.html" title="GSignondPlugin">GSignondPlugin</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondPlugin.html#gsignond-plugin-store" title="gsignond_plugin_store ()">gsignond_plugin_store</a>, function in <a class="link" href="gsignond-GSignondPlugin.html" title="GSignondPlugin">GSignondPlugin</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondPlugin.html#gsignond-plugin-user-action-finished" title="gsignond_plugin_user_action_finished ()">gsignond_plugin_user_action_finished</a>, function in <a class="link" href="gsignond-GSignondPlugin.html" title="GSignondPlugin">GSignondPlugin</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondPlugin.html#gsignond-plugin-user-action-required" title="gsignond_plugin_user_action_required ()">gsignond_plugin_user_action_required</a>, function in <a class="link" href="gsignond-GSignondPlugin.html" title="GSignondPlugin">GSignondPlugin</a> +</dt> +<dd></dd> +<a name="idxS"></a><h3 class="title">S</h3> +<dt> +<a class="link" href="GSignondSecretStorage.html#GSignondSecretStorage-struct" title="GSignondSecretStorage">GSignondSecretStorage</a>, struct in <a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage">GSignondSecretStorage</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GSignondSecretStorage.html#GSignondSecretStorage--config" title='The "config" property'>GSignondSecretStorage:config</a>, object property in <a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage">GSignondSecretStorage</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GSignondSecretStorage.html#GSignondSecretStorageClass" title="GSignondSecretStorageClass">GSignondSecretStorageClass</a>, struct in <a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage">GSignondSecretStorage</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GSignondSecretStorage.html#gsignond-secret-storage-check-credentials" title="gsignond_secret_storage_check_credentials ()">gsignond_secret_storage_check_credentials</a>, function in <a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage">GSignondSecretStorage</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GSignondSecretStorage.html#gsignond-secret-storage-clear-db" title="gsignond_secret_storage_clear_db ()">gsignond_secret_storage_clear_db</a>, function in <a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage">GSignondSecretStorage</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GSignondSecretStorage.html#gsignond-secret-storage-close-db" title="gsignond_secret_storage_close_db ()">gsignond_secret_storage_close_db</a>, function in <a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage">GSignondSecretStorage</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GSignondSecretStorage.html#gsignond-secret-storage-get-last-error" title="gsignond_secret_storage_get_last_error ()">gsignond_secret_storage_get_last_error</a>, function in <a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage">GSignondSecretStorage</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GSignondSecretStorage.html#gsignond-secret-storage-is-open-db" title="gsignond_secret_storage_is_open_db ()">gsignond_secret_storage_is_open_db</a>, function in <a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage">GSignondSecretStorage</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GSignondSecretStorage.html#gsignond-secret-storage-load-credentials" title="gsignond_secret_storage_load_credentials ()">gsignond_secret_storage_load_credentials</a>, function in <a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage">GSignondSecretStorage</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GSignondSecretStorage.html#gsignond-secret-storage-load-data" title="gsignond_secret_storage_load_data ()">gsignond_secret_storage_load_data</a>, function in <a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage">GSignondSecretStorage</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GSignondSecretStorage.html#gsignond-secret-storage-open-db" title="gsignond_secret_storage_open_db ()">gsignond_secret_storage_open_db</a>, function in <a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage">GSignondSecretStorage</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GSignondSecretStorage.html#gsignond-secret-storage-remove-credentials" title="gsignond_secret_storage_remove_credentials ()">gsignond_secret_storage_remove_credentials</a>, function in <a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage">GSignondSecretStorage</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GSignondSecretStorage.html#gsignond-secret-storage-remove-data" title="gsignond_secret_storage_remove_data ()">gsignond_secret_storage_remove_data</a>, function in <a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage">GSignondSecretStorage</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GSignondSecretStorage.html#gsignond-secret-storage-update-credentials" title="gsignond_secret_storage_update_credentials ()">gsignond_secret_storage_update_credentials</a>, function in <a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage">GSignondSecretStorage</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GSignondSecretStorage.html#gsignond-secret-storage-update-data" title="gsignond_secret_storage_update_data ()">gsignond_secret_storage_update_data</a>, function in <a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage">GSignondSecretStorage</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext">GSignondSecurityContext</a>, struct in <a class="link" href="gsignond-GSignondSecurityContext.html" title="GSignondSecurityContext">GSignondSecurityContext</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContextList" title="GSignondSecurityContextList">GSignondSecurityContextList</a>, typedef in <a class="link" href="gsignond-GSignondSecurityContext.html" title="GSignondSecurityContext">GSignondSecurityContext</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSecurityContext.html#gsignond-security-context-check" title="gsignond_security_context_check ()">gsignond_security_context_check</a>, function in <a class="link" href="gsignond-GSignondSecurityContext.html" title="GSignondSecurityContext">GSignondSecurityContext</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSecurityContext.html#gsignond-security-context-compare" title="gsignond_security_context_compare ()">gsignond_security_context_compare</a>, function in <a class="link" href="gsignond-GSignondSecurityContext.html" title="GSignondSecurityContext">GSignondSecurityContext</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSecurityContext.html#gsignond-security-context-copy" title="gsignond_security_context_copy ()">gsignond_security_context_copy</a>, function in <a class="link" href="gsignond-GSignondSecurityContext.html" title="GSignondSecurityContext">GSignondSecurityContext</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSecurityContext.html#gsignond-security-context-free" title="gsignond_security_context_free ()">gsignond_security_context_free</a>, function in <a class="link" href="gsignond-GSignondSecurityContext.html" title="GSignondSecurityContext">GSignondSecurityContext</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSecurityContext.html#gsignond-security-context-from-variant" title="gsignond_security_context_from_variant ()">gsignond_security_context_from_variant</a>, function in <a class="link" href="gsignond-GSignondSecurityContext.html" title="GSignondSecurityContext">GSignondSecurityContext</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSecurityContext.html#gsignond-security-context-get-application-context" title="gsignond_security_context_get_application_context ()">gsignond_security_context_get_application_context</a>, function in <a class="link" href="gsignond-GSignondSecurityContext.html" title="GSignondSecurityContext">GSignondSecurityContext</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSecurityContext.html#gsignond-security-context-get-system-context" title="gsignond_security_context_get_system_context ()">gsignond_security_context_get_system_context</a>, function in <a class="link" href="gsignond-GSignondSecurityContext.html" title="GSignondSecurityContext">GSignondSecurityContext</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSecurityContext.html#gsignond-security-context-list-copy" title="gsignond_security_context_list_copy ()">gsignond_security_context_list_copy</a>, function in <a class="link" href="gsignond-GSignondSecurityContext.html" title="GSignondSecurityContext">GSignondSecurityContext</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSecurityContext.html#gsignond-security-context-list-free" title="gsignond_security_context_list_free ()">gsignond_security_context_list_free</a>, function in <a class="link" href="gsignond-GSignondSecurityContext.html" title="GSignondSecurityContext">GSignondSecurityContext</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSecurityContext.html#gsignond-security-context-list-from-variant" title="gsignond_security_context_list_from_variant ()">gsignond_security_context_list_from_variant</a>, function in <a class="link" href="gsignond-GSignondSecurityContext.html" title="GSignondSecurityContext">GSignondSecurityContext</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSecurityContext.html#gsignond-security-context-list-to-variant" title="gsignond_security_context_list_to_variant ()">gsignond_security_context_list_to_variant</a>, function in <a class="link" href="gsignond-GSignondSecurityContext.html" title="GSignondSecurityContext">GSignondSecurityContext</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSecurityContext.html#gsignond-security-context-match" title="gsignond_security_context_match ()">gsignond_security_context_match</a>, function in <a class="link" href="gsignond-GSignondSecurityContext.html" title="GSignondSecurityContext">GSignondSecurityContext</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSecurityContext.html#gsignond-security-context-new" title="gsignond_security_context_new ()">gsignond_security_context_new</a>, function in <a class="link" href="gsignond-GSignondSecurityContext.html" title="GSignondSecurityContext">GSignondSecurityContext</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSecurityContext.html#gsignond-security-context-new-from-values" title="gsignond_security_context_new_from_values ()">gsignond_security_context_new_from_values</a>, function in <a class="link" href="gsignond-GSignondSecurityContext.html" title="GSignondSecurityContext">GSignondSecurityContext</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSecurityContext.html#gsignond-security-context-set-application-context" title="gsignond_security_context_set_application_context ()">gsignond_security_context_set_application_context</a>, function in <a class="link" href="gsignond-GSignondSecurityContext.html" title="GSignondSecurityContext">GSignondSecurityContext</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSecurityContext.html#gsignond-security-context-set-system-context" title="gsignond_security_context_set_system_context ()">gsignond_security_context_set_system_context</a>, function in <a class="link" href="gsignond-GSignondSecurityContext.html" title="GSignondSecurityContext">GSignondSecurityContext</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSecurityContext.html#gsignond-security-context-to-variant" title="gsignond_security_context_to_variant ()">gsignond_security_context_to_variant</a>, function in <a class="link" href="gsignond-GSignondSecurityContext.html" title="GSignondSecurityContext">GSignondSecurityContext</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData">GSignondSessionData</a>, typedef in <a class="link" href="gsignond-GSignondSessionData.html" title="GSignondSessionData">GSignondSessionData</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-get-caption" title="gsignond_session_data_get_caption ()">gsignond_session_data_get_caption</a>, function in <a class="link" href="gsignond-GSignondSessionData.html" title="GSignondSessionData">GSignondSessionData</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-get-network-proxy" title="gsignond_session_data_get_network_proxy ()">gsignond_session_data_get_network_proxy</a>, function in <a class="link" href="gsignond-GSignondSessionData.html" title="GSignondSessionData">GSignondSessionData</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-get-network-timeout" title="gsignond_session_data_get_network_timeout ()">gsignond_session_data_get_network_timeout</a>, function in <a class="link" href="gsignond-GSignondSessionData.html" title="GSignondSessionData">GSignondSessionData</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-get-realm" title="gsignond_session_data_get_realm ()">gsignond_session_data_get_realm</a>, function in <a class="link" href="gsignond-GSignondSessionData.html" title="GSignondSessionData">GSignondSessionData</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-get-renew-token" title="gsignond_session_data_get_renew_token ()">gsignond_session_data_get_renew_token</a>, function in <a class="link" href="gsignond-GSignondSessionData.html" title="GSignondSessionData">GSignondSessionData</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-get-secret" title="gsignond_session_data_get_secret ()">gsignond_session_data_get_secret</a>, function in <a class="link" href="gsignond-GSignondSessionData.html" title="GSignondSessionData">GSignondSessionData</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-get-ui-policy" title="gsignond_session_data_get_ui_policy ()">gsignond_session_data_get_ui_policy</a>, function in <a class="link" href="gsignond-GSignondSessionData.html" title="GSignondSessionData">GSignondSessionData</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-get-username" title="gsignond_session_data_get_username ()">gsignond_session_data_get_username</a>, function in <a class="link" href="gsignond-GSignondSessionData.html" title="GSignondSessionData">GSignondSessionData</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-get-window-id" title="gsignond_session_data_get_window_id ()">gsignond_session_data_get_window_id</a>, function in <a class="link" href="gsignond-GSignondSessionData.html" title="GSignondSessionData">GSignondSessionData</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-set-caption" title="gsignond_session_data_set_caption ()">gsignond_session_data_set_caption</a>, function in <a class="link" href="gsignond-GSignondSessionData.html" title="GSignondSessionData">GSignondSessionData</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-set-network-proxy" title="gsignond_session_data_set_network_proxy ()">gsignond_session_data_set_network_proxy</a>, function in <a class="link" href="gsignond-GSignondSessionData.html" title="GSignondSessionData">GSignondSessionData</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-set-network-timeout" title="gsignond_session_data_set_network_timeout ()">gsignond_session_data_set_network_timeout</a>, function in <a class="link" href="gsignond-GSignondSessionData.html" title="GSignondSessionData">GSignondSessionData</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-set-realm" title="gsignond_session_data_set_realm ()">gsignond_session_data_set_realm</a>, function in <a class="link" href="gsignond-GSignondSessionData.html" title="GSignondSessionData">GSignondSessionData</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-set-renew-token" title="gsignond_session_data_set_renew_token ()">gsignond_session_data_set_renew_token</a>, function in <a class="link" href="gsignond-GSignondSessionData.html" title="GSignondSessionData">GSignondSessionData</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-set-secret" title="gsignond_session_data_set_secret ()">gsignond_session_data_set_secret</a>, function in <a class="link" href="gsignond-GSignondSessionData.html" title="GSignondSessionData">GSignondSessionData</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-set-ui-policy" title="gsignond_session_data_set_ui_policy ()">gsignond_session_data_set_ui_policy</a>, function in <a class="link" href="gsignond-GSignondSessionData.html" title="GSignondSessionData">GSignondSessionData</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-set-username" title="gsignond_session_data_set_username ()">gsignond_session_data_set_username</a>, function in <a class="link" href="gsignond-GSignondSessionData.html" title="GSignondSessionData">GSignondSessionData</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-set-window-id" title="gsignond_session_data_set_window_id ()">gsignond_session_data_set_window_id</a>, function in <a class="link" href="gsignond-GSignondSessionData.html" title="GSignondSessionData">GSignondSessionData</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData">GSignondSignonuiData</a>, typedef in <a class="link" href="gsignond-GSignondSignonuiData.html" title="GSignondSignonuiData">GSignondSignonuiData</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiError" title="enum GSignondSignonuiError">GSignondSignonuiError</a>, enum in <a class="link" href="gsignond-GSignondSignonuiData.html" title="GSignondSignonuiData">GSignondSignonuiData</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-captcha-response" title="gsignond_signonui_data_get_captcha_response ()">gsignond_signonui_data_get_captcha_response</a>, function in <a class="link" href="gsignond-GSignondSignonuiData.html" title="GSignondSignonuiData">GSignondSignonuiData</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-captcha-url" title="gsignond_signonui_data_get_captcha_url ()">gsignond_signonui_data_get_captcha_url</a>, function in <a class="link" href="gsignond-GSignondSignonuiData.html" title="GSignondSignonuiData">GSignondSignonuiData</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-caption" title="gsignond_signonui_data_get_caption ()">gsignond_signonui_data_get_caption</a>, function in <a class="link" href="gsignond-GSignondSignonuiData.html" title="GSignondSignonuiData">GSignondSignonuiData</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-confirm" title="gsignond_signonui_data_get_confirm ()">gsignond_signonui_data_get_confirm</a>, function in <a class="link" href="gsignond-GSignondSignonuiData.html" title="GSignondSignonuiData">GSignondSignonuiData</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-final-url" title="gsignond_signonui_data_get_final_url ()">gsignond_signonui_data_get_final_url</a>, function in <a class="link" href="gsignond-GSignondSignonuiData.html" title="GSignondSignonuiData">GSignondSignonuiData</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-forgot-password" title="gsignond_signonui_data_get_forgot_password ()">gsignond_signonui_data_get_forgot_password</a>, function in <a class="link" href="gsignond-GSignondSignonuiData.html" title="GSignondSignonuiData">GSignondSignonuiData</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-forgot-password-url" title="gsignond_signonui_data_get_forgot_password_url ()">gsignond_signonui_data_get_forgot_password_url</a>, function in <a class="link" href="gsignond-GSignondSignonuiData.html" title="GSignondSignonuiData">GSignondSignonuiData</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-message" title="gsignond_signonui_data_get_message ()">gsignond_signonui_data_get_message</a>, function in <a class="link" href="gsignond-GSignondSignonuiData.html" title="GSignondSignonuiData">GSignondSignonuiData</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-open-url" title="gsignond_signonui_data_get_open_url ()">gsignond_signonui_data_get_open_url</a>, function in <a class="link" href="gsignond-GSignondSignonuiData.html" title="GSignondSignonuiData">GSignondSignonuiData</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-password" title="gsignond_signonui_data_get_password ()">gsignond_signonui_data_get_password</a>, function in <a class="link" href="gsignond-GSignondSignonuiData.html" title="GSignondSignonuiData">GSignondSignonuiData</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-query-error" title="gsignond_signonui_data_get_query_error ()">gsignond_signonui_data_get_query_error</a>, function in <a class="link" href="gsignond-GSignondSignonuiData.html" title="GSignondSignonuiData">GSignondSignonuiData</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-query-password" title="gsignond_signonui_data_get_query_password ()">gsignond_signonui_data_get_query_password</a>, function in <a class="link" href="gsignond-GSignondSignonuiData.html" title="GSignondSignonuiData">GSignondSignonuiData</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-query-username" title="gsignond_signonui_data_get_query_username ()">gsignond_signonui_data_get_query_username</a>, function in <a class="link" href="gsignond-GSignondSignonuiData.html" title="GSignondSignonuiData">GSignondSignonuiData</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-remember-password" title="gsignond_signonui_data_get_remember_password ()">gsignond_signonui_data_get_remember_password</a>, function in <a class="link" href="gsignond-GSignondSignonuiData.html" title="GSignondSignonuiData">GSignondSignonuiData</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-request-id" title="gsignond_signonui_data_get_request_id ()">gsignond_signonui_data_get_request_id</a>, function in <a class="link" href="gsignond-GSignondSignonuiData.html" title="GSignondSignonuiData">GSignondSignonuiData</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-test-reply" title="gsignond_signonui_data_get_test_reply ()">gsignond_signonui_data_get_test_reply</a>, function in <a class="link" href="gsignond-GSignondSignonuiData.html" title="GSignondSignonuiData">GSignondSignonuiData</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-title" title="gsignond_signonui_data_get_title ()">gsignond_signonui_data_get_title</a>, function in <a class="link" href="gsignond-GSignondSignonuiData.html" title="GSignondSignonuiData">GSignondSignonuiData</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-url-response" title="gsignond_signonui_data_get_url_response ()">gsignond_signonui_data_get_url_response</a>, function in <a class="link" href="gsignond-GSignondSignonuiData.html" title="GSignondSignonuiData">GSignondSignonuiData</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-username" title="gsignond_signonui_data_get_username ()">gsignond_signonui_data_get_username</a>, function in <a class="link" href="gsignond-GSignondSignonuiData.html" title="GSignondSignonuiData">GSignondSignonuiData</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-captcha-response" title="gsignond_signonui_data_set_captcha_response ()">gsignond_signonui_data_set_captcha_response</a>, function in <a class="link" href="gsignond-GSignondSignonuiData.html" title="GSignondSignonuiData">GSignondSignonuiData</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-captcha-url" title="gsignond_signonui_data_set_captcha_url ()">gsignond_signonui_data_set_captcha_url</a>, function in <a class="link" href="gsignond-GSignondSignonuiData.html" title="GSignondSignonuiData">GSignondSignonuiData</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-caption" title="gsignond_signonui_data_set_caption ()">gsignond_signonui_data_set_caption</a>, function in <a class="link" href="gsignond-GSignondSignonuiData.html" title="GSignondSignonuiData">GSignondSignonuiData</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-confirm" title="gsignond_signonui_data_set_confirm ()">gsignond_signonui_data_set_confirm</a>, function in <a class="link" href="gsignond-GSignondSignonuiData.html" title="GSignondSignonuiData">GSignondSignonuiData</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-final-url" title="gsignond_signonui_data_set_final_url ()">gsignond_signonui_data_set_final_url</a>, function in <a class="link" href="gsignond-GSignondSignonuiData.html" title="GSignondSignonuiData">GSignondSignonuiData</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-forgot-password" title="gsignond_signonui_data_set_forgot_password ()">gsignond_signonui_data_set_forgot_password</a>, function in <a class="link" href="gsignond-GSignondSignonuiData.html" title="GSignondSignonuiData">GSignondSignonuiData</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-forgot-password-url" title="gsignond_signonui_data_set_forgot_password_url ()">gsignond_signonui_data_set_forgot_password_url</a>, function in <a class="link" href="gsignond-GSignondSignonuiData.html" title="GSignondSignonuiData">GSignondSignonuiData</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-message" title="gsignond_signonui_data_set_message ()">gsignond_signonui_data_set_message</a>, function in <a class="link" href="gsignond-GSignondSignonuiData.html" title="GSignondSignonuiData">GSignondSignonuiData</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-open-url" title="gsignond_signonui_data_set_open_url ()">gsignond_signonui_data_set_open_url</a>, function in <a class="link" href="gsignond-GSignondSignonuiData.html" title="GSignondSignonuiData">GSignondSignonuiData</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-password" title="gsignond_signonui_data_set_password ()">gsignond_signonui_data_set_password</a>, function in <a class="link" href="gsignond-GSignondSignonuiData.html" title="GSignondSignonuiData">GSignondSignonuiData</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-query-error" title="gsignond_signonui_data_set_query_error ()">gsignond_signonui_data_set_query_error</a>, function in <a class="link" href="gsignond-GSignondSignonuiData.html" title="GSignondSignonuiData">GSignondSignonuiData</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-query-password" title="gsignond_signonui_data_set_query_password ()">gsignond_signonui_data_set_query_password</a>, function in <a class="link" href="gsignond-GSignondSignonuiData.html" title="GSignondSignonuiData">GSignondSignonuiData</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-query-username" title="gsignond_signonui_data_set_query_username ()">gsignond_signonui_data_set_query_username</a>, function in <a class="link" href="gsignond-GSignondSignonuiData.html" title="GSignondSignonuiData">GSignondSignonuiData</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-remember-password" title="gsignond_signonui_data_set_remember_password ()">gsignond_signonui_data_set_remember_password</a>, function in <a class="link" href="gsignond-GSignondSignonuiData.html" title="GSignondSignonuiData">GSignondSignonuiData</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-request-id" title="gsignond_signonui_data_set_request_id ()">gsignond_signonui_data_set_request_id</a>, function in <a class="link" href="gsignond-GSignondSignonuiData.html" title="GSignondSignonuiData">GSignondSignonuiData</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-test-reply" title="gsignond_signonui_data_set_test_reply ()">gsignond_signonui_data_set_test_reply</a>, function in <a class="link" href="gsignond-GSignondSignonuiData.html" title="GSignondSignonuiData">GSignondSignonuiData</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-title" title="gsignond_signonui_data_set_title ()">gsignond_signonui_data_set_title</a>, function in <a class="link" href="gsignond-GSignondSignonuiData.html" title="GSignondSignonuiData">GSignondSignonuiData</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-url-response" title="gsignond_signonui_data_set_url_response ()">gsignond_signonui_data_set_url_response</a>, function in <a class="link" href="gsignond-GSignondSignonuiData.html" title="GSignondSignonuiData">GSignondSignonuiData</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-username" title="gsignond_signonui_data_set_username ()">gsignond_signonui_data_set_username</a>, function in <a class="link" href="gsignond-GSignondSignonuiData.html" title="GSignondSignonuiData">GSignondSignonuiData</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GSignondSsoTestPlugin.html#GSignondSsoTestPlugin-struct" title="struct GSignondSsoTestPlugin">GSignondSsoTestPlugin</a>, struct in <a class="link" href="GSignondSsoTestPlugin.html" title="GSignondSsoTestPlugin">GSignondSsoTestPlugin</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GSignondSsoTestPlugin.html#GSignondSsoTestPluginClass" title="struct GSignondSsoTestPluginClass">GSignondSsoTestPluginClass</a>, struct in <a class="link" href="GSignondSsoTestPlugin.html" title="GSignondSsoTestPlugin">GSignondSsoTestPlugin</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GSignondStorageManager.html#GSignondStorageManager-struct" title="struct GSignondStorageManager">GSignondStorageManager</a>, struct in <a class="link" href="GSignondStorageManager.html" title="GSignondStorageManager">GSignondStorageManager</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GSignondStorageManager.html#GSignondStorageManager--config" title='The "config" property'>GSignondStorageManager:config</a>, object property in <a class="link" href="GSignondStorageManager.html" title="GSignondStorageManager">GSignondStorageManager</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GSignondStorageManager.html#GSignondStorageManagerClass" title="struct GSignondStorageManagerClass">GSignondStorageManagerClass</a>, struct in <a class="link" href="GSignondStorageManager.html" title="GSignondStorageManager">GSignondStorageManager</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GSignondStorageManager.html#gsignond-storage-manager-delete-storage" title="gsignond_storage_manager_delete_storage ()">gsignond_storage_manager_delete_storage</a>, function in <a class="link" href="GSignondStorageManager.html" title="GSignondStorageManager">GSignondStorageManager</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GSignondStorageManager.html#gsignond-storage-manager-filesystem-is-mounted" title="gsignond_storage_manager_filesystem_is_mounted ()">gsignond_storage_manager_filesystem_is_mounted</a>, function in <a class="link" href="GSignondStorageManager.html" title="GSignondStorageManager">GSignondStorageManager</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GSignondStorageManager.html#gsignond-storage-manager-initialize-storage" title="gsignond_storage_manager_initialize_storage ()">gsignond_storage_manager_initialize_storage</a>, function in <a class="link" href="GSignondStorageManager.html" title="GSignondStorageManager">GSignondStorageManager</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GSignondStorageManager.html#gsignond-storage-manager-mount-filesystem" title="gsignond_storage_manager_mount_filesystem ()">gsignond_storage_manager_mount_filesystem</a>, function in <a class="link" href="GSignondStorageManager.html" title="GSignondStorageManager">GSignondStorageManager</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GSignondStorageManager.html#gsignond-storage-manager-storage-is-initialized" title="gsignond_storage_manager_storage_is_initialized ()">gsignond_storage_manager_storage_is_initialized</a>, function in <a class="link" href="GSignondStorageManager.html" title="GSignondStorageManager">GSignondStorageManager</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GSignondStorageManager.html#gsignond-storage-manager-unmount-filesystem" title="gsignond_storage_manager_unmount_filesystem ()">gsignond_storage_manager_unmount_filesystem</a>, function in <a class="link" href="GSignondStorageManager.html" title="GSignondStorageManager">GSignondStorageManager</a> +</dt> +<dd></dd> +<a name="idxT"></a><h3 class="title">T</h3> +<dt> +<a class="link" href="gsignond-Logging.html#TRACEBACK:CAPS" title="TRACEBACK">TRACEBACK</a>, macro in <a class="link" href="gsignond-Logging.html" title="Logging">Logging</a> +</dt> +<dd></dd> +<a name="idxU"></a><h3 class="title">U</h3> +<dt> +<a class="link" href="gsignond-GSignondSessionData.html#GSignondUiPolicy" title="enum GSignondUiPolicy">GSignondUiPolicy</a>, enum in <a class="link" href="gsignond-GSignondSessionData.html" title="GSignondSessionData">GSignondSessionData</a> +</dt> +<dd></dd> +<a name="idxW"></a><h3 class="title">W</h3> +<dt> +<a class="link" href="gsignond-Logging.html#WARN:CAPS" title="WARN()">WARN</a>, macro in <a class="link" href="gsignond-Logging.html" title="Logging">Logging</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-Utility-functions.html#gsignond-wipe-directory" title="gsignond_wipe_directory ()">gsignond_wipe_directory</a>, function in <a class="link" href="gsignond-Utility-functions.html" title="Utility functions">Utility functions</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="gsignond-Utility-functions.html#gsignond-wipe-file" title="gsignond_wipe_file ()">gsignond_wipe_file</a>, function in <a class="link" href="gsignond-Utility-functions.html" title="Utility functions">Utility functions</a> +</dt> +<dd></dd> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.19.1</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/html/ch01.html b/docs/html/ch01.html new file mode 100644 index 0000000..106fb9d --- /dev/null +++ b/docs/html/ch01.html @@ -0,0 +1,33 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GSignond building and installation</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="gsignond API Reference Manual"> +<link rel="up" href="index.html" title="gsignond API Reference Manual"> +<link rel="prev" href="index.html" title="gsignond API Reference Manual"> +<link rel="next" href="gsignond-building.html" title="Building and installing the gsignond daemon"> +<meta name="generator" content="GTK-Doc V1.19.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle"> +<td width="100%" align="left"></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><img src="up-insensitive.png" width="16" height="16" border="0"></td> +<td><a accesskey="p" href="index.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="gsignond-building.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="chapter"> +<div class="titlepage"><div><div><h2 class="title"> +<a name="idp3362528"></a>GSignond building and installation</h2></div></div></div> +<div class="toc"><dl><dt> +<span class="refentrytitle"><a href="gsignond-building.html">Building and installing the gsignond daemon</a></span><span class="refpurpose"></span> +</dt></dl></div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.19.1</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/html/ch02.html b/docs/html/ch02.html new file mode 100644 index 0000000..e81db75 --- /dev/null +++ b/docs/html/ch02.html @@ -0,0 +1,44 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GSignond configuration</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="gsignond API Reference Manual"> +<link rel="up" href="index.html" title="gsignond API Reference Manual"> +<link rel="prev" href="gsignond-building.html" title="Building and installing the gsignond daemon"> +<link rel="next" href="GSignondConfig.html" title="GSignondConfig"> +<meta name="generator" content="GTK-Doc V1.19.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle"> +<td width="100%" align="left"></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><img src="up-insensitive.png" width="16" height="16" border="0"></td> +<td><a accesskey="p" href="gsignond-building.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="GSignondConfig.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="chapter"> +<div class="titlepage"><div><div><h2 class="title"> +<a name="idp3688944"></a>GSignond configuration</h2></div></div></div> +<div class="toc"><dl> +<dt> +<span class="refentrytitle"><a href="GSignondConfig.html">GSignondConfig</a></span><span class="refpurpose"> — gSSO configuration information</span> +</dt> +<dt> +<span class="refentrytitle"><a href="gsignond-General-configuration.html">General configuration</a></span><span class="refpurpose"> — gSSO general configuration keys</span> +</dt> +<dt> +<span class="refentrytitle"><a href="gsignond-Database-configuration.html">Database configuration</a></span><span class="refpurpose"> — gSSO database configuration keys</span> +</dt> +<dt> +<span class="refentrytitle"><a href="gsignond-DBus-configuration.html">DBus configuration</a></span><span class="refpurpose"> — gSSO dbus configuration keys</span> +</dt> +</dl></div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.19.1</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/html/ch03.html b/docs/html/ch03.html new file mode 100644 index 0000000..f978c66 --- /dev/null +++ b/docs/html/ch03.html @@ -0,0 +1,44 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GSignond API for writing authentication plugins</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="gsignond API Reference Manual"> +<link rel="up" href="index.html" title="gsignond API Reference Manual"> +<link rel="prev" href="gsignond-DBus-configuration.html" title="DBus configuration"> +<link rel="next" href="gsignond-GSignondPlugin.html" title="GSignondPlugin"> +<meta name="generator" content="GTK-Doc V1.19.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle"> +<td width="100%" align="left"></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><img src="up-insensitive.png" width="16" height="16" border="0"></td> +<td><a accesskey="p" href="gsignond-DBus-configuration.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="gsignond-GSignondPlugin.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="chapter"> +<div class="titlepage"><div><div><h2 class="title"> +<a name="idp4976032"></a>GSignond API for writing authentication plugins</h2></div></div></div> +<div class="toc"><dl> +<dt> +<span class="refentrytitle"><a href="gsignond-GSignondPlugin.html">GSignondPlugin</a></span><span class="refpurpose"> — an interface for implementing authentication plugins</span> +</dt> +<dt> +<span class="refentrytitle"><a href="gsignond-GSignondDictionary.html">GSignondDictionary</a></span><span class="refpurpose"> — a dictionary container holding string keys and variant values</span> +</dt> +<dt> +<span class="refentrytitle"><a href="gsignond-GSignondSessionData.html">GSignondSessionData</a></span><span class="refpurpose"> — definitions for authentication session parameters</span> +</dt> +<dt> +<span class="refentrytitle"><a href="gsignond-GSignondSignonuiData.html">GSignondSignonuiData</a></span><span class="refpurpose"> — definitions for user interaction parameters</span> +</dt> +</dl></div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.19.1</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/html/ch04.html b/docs/html/ch04.html new file mode 100644 index 0000000..35f1d17 --- /dev/null +++ b/docs/html/ch04.html @@ -0,0 +1,41 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Standard in-tree authentication plugins</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="gsignond API Reference Manual"> +<link rel="up" href="index.html" title="gsignond API Reference Manual"> +<link rel="prev" href="gsignond-GSignondSignonuiData.html" title="GSignondSignonuiData"> +<link rel="next" href="GSignondDigestPlugin.html" title="GSignondDigestPlugin"> +<meta name="generator" content="GTK-Doc V1.19.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle"> +<td width="100%" align="left"></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><img src="up-insensitive.png" width="16" height="16" border="0"></td> +<td><a accesskey="p" href="gsignond-GSignondSignonuiData.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="GSignondDigestPlugin.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="chapter"> +<div class="titlepage"><div><div><h2 class="title"> +<a name="idp1837744"></a>Standard in-tree authentication plugins</h2></div></div></div> +<div class="toc"><dl> +<dt> +<span class="refentrytitle"><a href="GSignondDigestPlugin.html">GSignondDigestPlugin</a></span><span class="refpurpose"> — a plugin that performs HTTP Digest authentication</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GSignondSsoTestPlugin.html">GSignondSsoTestPlugin</a></span><span class="refpurpose"> — a plugin that is used internally in gsignond unit test</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GSignondPasswordPlugin.html">GSignondPasswordPlugin</a></span><span class="refpurpose"> — a plugin for retrieving the username/password</span> +</dt> +</dl></div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.19.1</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/html/ch05.html b/docs/html/ch05.html new file mode 100644 index 0000000..3b4a82a --- /dev/null +++ b/docs/html/ch05.html @@ -0,0 +1,50 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GSignond API for writing platform adaptation extensions</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="gsignond API Reference Manual"> +<link rel="up" href="index.html" title="gsignond API Reference Manual"> +<link rel="prev" href="GSignondPasswordPlugin.html" title="GSignondPasswordPlugin"> +<link rel="next" href="GSignondExtension.html" title="GSignondExtension"> +<meta name="generator" content="GTK-Doc V1.19.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle"> +<td width="100%" align="left"></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><img src="up-insensitive.png" width="16" height="16" border="0"></td> +<td><a accesskey="p" href="GSignondPasswordPlugin.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="GSignondExtension.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="chapter"> +<div class="titlepage"><div><div><h2 class="title"> +<a name="idp4701856"></a>GSignond API for writing platform adaptation extensions</h2></div></div></div> +<div class="toc"><dl> +<dt> +<span class="refentrytitle"><a href="GSignondExtension.html">GSignondExtension</a></span><span class="refpurpose"> — provides platform adaptation functionality</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GSignondAccessControlManager.html">GSignondAccessControlManager</a></span><span class="refpurpose"> — an object that performs access control checks</span> +</dt> +<dt> +<span class="refentrytitle"><a href="gsignond-GSignondSecurityContext.html">GSignondSecurityContext</a></span><span class="refpurpose"> — security context descriptor used in access control checks</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GSignondStorageManager.html">GSignondStorageManager</a></span><span class="refpurpose"> — manages encrypted disk storage for storing the secret database</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GSignondSecretStorage.html">GSignondSecretStorage</a></span><span class="refpurpose"> — provides access to the database that stores user credentials and identity/method cache</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GSignondCredentials.html">GSignondCredentials</a></span><span class="refpurpose"> — credentials (username, password) associated with an identity</span> +</dt> +</dl></div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.19.1</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/html/ch06.html b/docs/html/ch06.html new file mode 100644 index 0000000..9c984a2 --- /dev/null +++ b/docs/html/ch06.html @@ -0,0 +1,41 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Miscellaneous</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="gsignond API Reference Manual"> +<link rel="up" href="index.html" title="gsignond API Reference Manual"> +<link rel="prev" href="GSignondCredentials.html" title="GSignondCredentials"> +<link rel="next" href="gsignond-Errors.html" title="Errors"> +<meta name="generator" content="GTK-Doc V1.19.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle"> +<td width="100%" align="left"></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><img src="up-insensitive.png" width="16" height="16" border="0"></td> +<td><a accesskey="p" href="GSignondCredentials.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="gsignond-Errors.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="chapter"> +<div class="titlepage"><div><div><h2 class="title"> +<a name="idp2634192"></a>Miscellaneous</h2></div></div></div> +<div class="toc"><dl> +<dt> +<span class="refentrytitle"><a href="gsignond-Errors.html">Errors</a></span><span class="refpurpose"> — error definitions and utilities</span> +</dt> +<dt> +<span class="refentrytitle"><a href="gsignond-Logging.html">Logging</a></span><span class="refpurpose"> — logging facilities</span> +</dt> +<dt> +<span class="refentrytitle"><a href="gsignond-Utility-functions.html">Utility functions</a></span><span class="refpurpose"> — miscellaneous utility functions</span> +</dt> +</dl></div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.19.1</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/html/deprecated-api-index.html b/docs/html/deprecated-api-index.html new file mode 100644 index 0000000..47eb706 --- /dev/null +++ b/docs/html/deprecated-api-index.html @@ -0,0 +1,31 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Index of deprecated API</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="gsignond API Reference Manual"> +<link rel="up" href="index.html" title="gsignond API Reference Manual"> +<link rel="prev" href="api-index-full.html" title="API Index"> +<link rel="next" href="annotation-glossary.html" title="Annotation Glossary"> +<meta name="generator" content="GTK-Doc V1.19.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle"> +<td width="100%" align="left"></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><img src="up-insensitive.png" width="16" height="16" border="0"></td> +<td><a accesskey="p" href="api-index-full.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="annotation-glossary.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="index"> +<div class="titlepage"><div><div><h2 class="title"> +<a name="deprecated-api-index"></a>Index of deprecated API</h2></div></div></div> +<a name="idx"></a> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.19.1</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/html/gsignond-DBus-configuration.html b/docs/html/gsignond-DBus-configuration.html new file mode 100644 index 0000000..d466a79 --- /dev/null +++ b/docs/html/gsignond-DBus-configuration.html @@ -0,0 +1,107 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>DBus configuration</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="gsignond API Reference Manual"> +<link rel="up" href="ch02.html" title="GSignond configuration"> +<link rel="prev" href="gsignond-Database-configuration.html" title="Database configuration"> +<link rel="next" href="ch03.html" title="GSignond API for writing authentication plugins"> +<meta name="generator" content="GTK-Doc V1.19.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle"> +<td width="100%" align="left"> +<a href="#" class="shortcut">Top</a> +  | + <a href="#gsignond-DBus-configuration.description" class="shortcut">Description</a> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="gsignond-Database-configuration.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="ch03.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="gsignond-DBus-configuration"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="gsignond-DBus-configuration.top_of_page"></a>DBus configuration</span></h2> +<p>DBus configuration — gSSO dbus configuration keys</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="gsignond-DBus-configuration.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis"> +#include <gsignond/gsignond-config.h> + +#define <a class="link" href="gsignond-DBus-configuration.html#GSIGNOND-CONFIG-DBUS-AUTH-SESSION-TIMEOUT:CAPS" title="GSIGNOND_CONFIG_DBUS_AUTH_SESSION_TIMEOUT">GSIGNOND_CONFIG_DBUS_AUTH_SESSION_TIMEOUT</a> +#define <a class="link" href="gsignond-DBus-configuration.html#GSIGNOND-CONFIG-DBUS-DAEMON-TIMEOUT:CAPS" title="GSIGNOND_CONFIG_DBUS_DAEMON_TIMEOUT">GSIGNOND_CONFIG_DBUS_DAEMON_TIMEOUT</a> +#define <a class="link" href="gsignond-DBus-configuration.html#GSIGNOND-CONFIG-DBUS-IDENTITY-TIMEOUT:CAPS" title="GSIGNOND_CONFIG_DBUS_IDENTITY_TIMEOUT">GSIGNOND_CONFIG_DBUS_IDENTITY_TIMEOUT</a> +#define <a class="link" href="gsignond-DBus-configuration.html#GSIGNOND-CONFIG-DBUS-TIMEOUTS:CAPS" title="GSIGNOND_CONFIG_DBUS_TIMEOUTS">GSIGNOND_CONFIG_DBUS_TIMEOUTS</a> +</pre> +</div> +<div class="refsect1"> +<a name="gsignond-DBus-configuration.description"></a><h2>Description</h2> +<p> +DBus configuration keys are defined below. See <a class="link" href="GSignondConfig.html" title="GSignondConfig"><span class="type">GSignondConfig</span></a> for how to use them. +</p> +</div> +<div class="refsect1"> +<a name="gsignond-DBus-configuration.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GSIGNOND-CONFIG-DBUS-AUTH-SESSION-TIMEOUT:CAPS"></a><h3>GSIGNOND_CONFIG_DBUS_AUTH_SESSION_TIMEOUT</h3> +<pre class="programlisting">#define GSIGNOND_CONFIG_DBUS_AUTH_SESSION_TIMEOUT</pre> +<p> +A timeout in seconds, after which inactive authentication session dbus objects will be removed. +If not set, the dbus objects will persist. +</p> +<p> +Can be overriden in debug +builds by setting SSO_AUTH_SESSION_TIMEOUT environment variable. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="GSIGNOND-CONFIG-DBUS-DAEMON-TIMEOUT:CAPS"></a><h3>GSIGNOND_CONFIG_DBUS_DAEMON_TIMEOUT</h3> +<pre class="programlisting">#define GSIGNOND_CONFIG_DBUS_DAEMON_TIMEOUT</pre> +<p> +A timeout in seconds, after which the gSSO daemon will exit. If not set, +the daemon will not exit. Has no effect if P2P DBus is in use. +</p> +<p> +Can be overriden in debug +builds by setting SSO_DAEMON_TIMEOUT environment variable. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="GSIGNOND-CONFIG-DBUS-IDENTITY-TIMEOUT:CAPS"></a><h3>GSIGNOND_CONFIG_DBUS_IDENTITY_TIMEOUT</h3> +<pre class="programlisting">#define GSIGNOND_CONFIG_DBUS_IDENTITY_TIMEOUT</pre> +<p> +A timeout in seconds, after which inactive identity dbus objects will be removed. +If not set, the dbus objects will persist. +</p> +<p> +Can be overriden in debug +builds by setting SSO_IDENTITY_TIMEOUT environment variable. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="GSIGNOND-CONFIG-DBUS-TIMEOUTS:CAPS"></a><h3>GSIGNOND_CONFIG_DBUS_TIMEOUTS</h3> +<pre class="programlisting">#define GSIGNOND_CONFIG_DBUS_TIMEOUTS "ObjectTimeouts" +</pre> +<p> +A prefix for dbus timeout keys. Should be used only when defining new keys. +</p> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.19.1</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/html/gsignond-Database-configuration.html b/docs/html/gsignond-Database-configuration.html new file mode 100644 index 0000000..f60a27d --- /dev/null +++ b/docs/html/gsignond-Database-configuration.html @@ -0,0 +1,89 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Database configuration</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="gsignond API Reference Manual"> +<link rel="up" href="ch02.html" title="GSignond configuration"> +<link rel="prev" href="gsignond-General-configuration.html" title="General configuration"> +<link rel="next" href="gsignond-DBus-configuration.html" title="DBus configuration"> +<meta name="generator" content="GTK-Doc V1.19.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle"> +<td width="100%" align="left"> +<a href="#" class="shortcut">Top</a> +  | + <a href="#gsignond-Database-configuration.description" class="shortcut">Description</a> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="gsignond-General-configuration.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="gsignond-DBus-configuration.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="gsignond-Database-configuration"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="gsignond-Database-configuration.top_of_page"></a>Database configuration</span></h2> +<p>Database configuration — gSSO database configuration keys</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="gsignond-Database-configuration.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis"> +#include <gsignond/gsignond-config.h> + +#define <a class="link" href="gsignond-Database-configuration.html#GSIGNOND-CONFIG-DB-METADATA-DB-FILENAME:CAPS" title="GSIGNOND_CONFIG_DB_METADATA_DB_FILENAME">GSIGNOND_CONFIG_DB_METADATA_DB_FILENAME</a> +#define <a class="link" href="gsignond-Database-configuration.html#GSIGNOND-CONFIG-DB-SECRET-DB-FILENAME:CAPS" title="GSIGNOND_CONFIG_DB_SECRET_DB_FILENAME">GSIGNOND_CONFIG_DB_SECRET_DB_FILENAME</a> +#define <a class="link" href="gsignond-Database-configuration.html#GSIGNOND-CONFIG-DB-SSO:CAPS" title="GSIGNOND_CONFIG_DB_SSO">GSIGNOND_CONFIG_DB_SSO</a> +</pre> +</div> +<div class="refsect1"> +<a name="gsignond-Database-configuration.description"></a><h2>Description</h2> +<p> +Database configuration keys are defined below. See <a class="link" href="GSignondConfig.html" title="GSignondConfig"><span class="type">GSignondConfig</span></a> for how to use them. +</p> +</div> +<div class="refsect1"> +<a name="gsignond-Database-configuration.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GSIGNOND-CONFIG-DB-METADATA-DB-FILENAME:CAPS"></a><h3>GSIGNOND_CONFIG_DB_METADATA_DB_FILENAME</h3> +<pre class="programlisting">#define GSIGNOND_CONFIG_DB_METADATA_DB_FILENAME</pre> +<p> +The filename of the metadata database. +</p> +<p> +Default value: "metadata.db". +</p> +</div> +<hr> +<div class="refsect2"> +<a name="GSIGNOND-CONFIG-DB-SECRET-DB-FILENAME:CAPS"></a><h3>GSIGNOND_CONFIG_DB_SECRET_DB_FILENAME</h3> +<pre class="programlisting">#define GSIGNOND_CONFIG_DB_SECRET_DB_FILENAME</pre> +<p> +The filename of the credentials database. +</p> +<p> +Default value: "secret.db". +</p> +</div> +<hr> +<div class="refsect2"> +<a name="GSIGNOND-CONFIG-DB-SSO:CAPS"></a><h3>GSIGNOND_CONFIG_DB_SSO</h3> +<pre class="programlisting">#define GSIGNOND_CONFIG_DB_SSO "Storage" +</pre> +<p> +A prefix for database keys. Should be used only when defining new keys. +</p> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.19.1</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/html/gsignond-Errors.html b/docs/html/gsignond-Errors.html new file mode 100644 index 0000000..75e5ddd --- /dev/null +++ b/docs/html/gsignond-Errors.html @@ -0,0 +1,433 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Errors</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="gsignond API Reference Manual"> +<link rel="up" href="ch06.html" title="Miscellaneous"> +<link rel="prev" href="ch06.html" title="Miscellaneous"> +<link rel="next" href="gsignond-Logging.html" title="Logging"> +<meta name="generator" content="GTK-Doc V1.19.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle"> +<td width="100%" align="left"> +<a href="#" class="shortcut">Top</a> +  | + <a href="#gsignond-Errors.description" class="shortcut">Description</a> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="ch06.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="ch06.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="gsignond-Logging.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="gsignond-Errors"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="gsignond-Errors.top_of_page"></a>Errors</span></h2> +<p>Errors — error definitions and utilities</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="gsignond-Errors.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis"> +#include <gsignond/gsignond-error.h> + +#define <a class="link" href="gsignond-Errors.html#GSIGNOND-ERROR:CAPS" title="GSIGNOND_ERROR">GSIGNOND_ERROR</a> +enum <a class="link" href="gsignond-Errors.html#GSignondError" title="enum GSignondError">GSignondError</a>; +<a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="returnvalue">GError</span></a> * <a class="link" href="gsignond-Errors.html#gsignond-error-new-from-variant" title="gsignond_error_new_from_variant ()">gsignond_error_new_from_variant</a> (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *var</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> <a class="link" href="gsignond-Errors.html#gsignond-error-quark" title="gsignond_error_quark ()">gsignond_error_quark</a> (<em class="parameter"><code><span class="type">void</span></code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="returnvalue">GVariant</span></a> * <a class="link" href="gsignond-Errors.html#gsignond-error-to-variant" title="gsignond_error_to_variant ()">gsignond_error_to_variant</a> (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> *error</code></em>); +#define <a class="link" href="gsignond-Errors.html#gsignond-get-gerror-for-id" title="gsignond_get_gerror_for_id()">gsignond_get_gerror_for_id</a> (err, + message, + ...) +</pre> +</div> +<div class="refsect1"> +<a name="gsignond-Errors.description"></a><h2>Description</h2> +<p> +This file provides GSignond error definitions and utilities. +When creating an error, use <a class="link" href="gsignond-Errors.html#GSIGNOND-ERROR:CAPS" title="GSIGNOND_ERROR"><span class="type">GSIGNOND_ERROR</span></a> for the error domain and errors +from <a class="link" href="gsignond-Errors.html#GSignondError" title="enum GSignondError"><span class="type">GSignondError</span></a> for the error code. +</p> +<p> +</p> +<div class="informalexample"> + <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> + <tbody> + <tr> + <td class="listing_lines" align="right"><pre>1 +2</pre></td> + <td class="listing_code"><pre class="programlisting">GError* err = g_error_new(GSIGNOND_ERROR, GSIGNOND_ERROR_MISSING_DATA, + <span class="number">"Not enough data"</span>);</pre></td> + </tr> + </tbody> + </table> +</div> + +<p> +</p> +</div> +<div class="refsect1"> +<a name="gsignond-Errors.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GSIGNOND-ERROR:CAPS"></a><h3>GSIGNOND_ERROR</h3> +<pre class="programlisting">#define GSIGNOND_ERROR (gsignond_error_quark()) +</pre> +<p> +This macro should be used when creating a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> in GSignond plugins and extensions. +(for example with <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#g-error-new"><code class="function">g_error_new()</code></a> ) +</p> +</div> +<hr> +<div class="refsect2"> +<a name="GSignondError"></a><h3>enum GSignondError</h3> +<pre class="programlisting">typedef enum { + GSIGNOND_ERROR_NONE, + + GSIGNOND_ERROR_UNKNOWN = 1, + GSIGNOND_ERROR_INTERNAL_SERVER = 2, + GSIGNOND_ERROR_INTERNAL_COMMUNICATION = 3, + GSIGNOND_ERROR_PERMISSION_DENIED = 4, + GSIGNOND_ERROR_ENCRYPTION_FAILURE, + + GSIGNOND_ERROR_AUTH_SERVICE_ERR = 100, /* Placeholder to rearrange enumeration - AuthService specific */ + GSIGNOND_ERROR_METHOD_NOT_KNOWN, + GSIGNOND_ERROR_SERVICE_NOT_AVAILABLE, + GSIGNOND_ERROR_INVALID_QUERY, + + GSIGNOND_ERROR_IDENTITY_ERR = 200, /* Placeholder to rearrange enumeration - Identity specific */ + GSIGNOND_ERROR_METHOD_NOT_AVAILABLE, + GSIGNOND_ERROR_IDENTITY_NOT_FOUND, + GSIGNOND_ERROR_STORE_FAILED, + GSIGNOND_ERROR_REMOVE_FAILED, + GSIGNOND_ERROR_SIGN_OUT_FAILED, + GSIGNOND_ERROR_IDENTITY_OPERATION_CANCELED, + GSIGNOND_ERROR_CREDENTIALS_NOT_AVAILABLE, + GSIGNOND_ERROR_REFERENCE_NOT_FOUND, + + GSIGNOND_ERROR_AUTH_SESSION_ERR = 300, /* Placeholder to rearrange enumeration - AuthSession/PluginInterface specific */ + GSIGNOND_ERROR_MECHANISM_NOT_AVAILABLE, + GSIGNOND_ERROR_MISSING_DATA, + GSIGNOND_ERROR_INVALID_CREDENTIALS, + GSIGNOND_ERROR_NOT_AUTHORIZED, + GSIGNOND_ERROR_WRONG_STATE, + GSIGNOND_ERROR_OPERATION_NOT_SUPPORTED, + GSIGNOND_ERROR_NO_CONNECTION, + GSIGNOND_ERROR_NETWORK, + GSIGNOND_ERROR_SSL, + GSIGNOND_ERROR_RUNTIME, + GSIGNOND_ERROR_SESSION_CANCELED, + GSIGNOND_ERROR_TIMED_OUT, + GSIGNOND_ERROR_USER_INTERACTION, + GSIGNOND_ERROR_OPERATION_FAILED, + GSIGNOND_ERROR_ENCRYPTION_FAILED, + GSIGNOND_ERROR_TOS_NOT_ACCEPTED, + GSIGNOND_ERROR_FORGOT_PASSWORD, + GSIGNOND_ERROR_METHOD_OR_MECHANISM_NOT_ALLOWED, + GSIGNOND_ERROR_INCORRECT_DATE, + + GSIGNOND_ERROR_USER_ERR = 400 +} GSignondError; +</pre> +<p> +This enum provides a list of errors that plugins and extensions can use. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><a name="GSIGNOND-ERROR-NONE:CAPS"></a><span class="term"><code class="literal">GSIGNOND_ERROR_NONE</code></span></p></td> +<td>No error +</td> +</tr> +<tr> +<td><p><a name="GSIGNOND-ERROR-UNKNOWN:CAPS"></a><span class="term"><code class="literal">GSIGNOND_ERROR_UNKNOWN</code></span></p></td> +<td>Catch-all for errors not distinguished by another code. +</td> +</tr> +<tr> +<td><p><a name="GSIGNOND-ERROR-INTERNAL-SERVER:CAPS"></a><span class="term"><code class="literal">GSIGNOND_ERROR_INTERNAL_SERVER</code></span></p></td> +<td>Signon Daemon internal error. +</td> +</tr> +<tr> +<td><p><a name="GSIGNOND-ERROR-INTERNAL-COMMUNICATION:CAPS"></a><span class="term"><code class="literal">GSIGNOND_ERROR_INTERNAL_COMMUNICATION</code></span></p></td> +<td>Communication with Signon Daemon error. +</td> +</tr> +<tr> +<td><p><a name="GSIGNOND-ERROR-PERMISSION-DENIED:CAPS"></a><span class="term"><code class="literal">GSIGNOND_ERROR_PERMISSION_DENIED</code></span></p></td> +<td>The operation cannot be performed due to insufficient client permissions. +</td> +</tr> +<tr> +<td><p><a name="GSIGNOND-ERROR-ENCRYPTION-FAILURE:CAPS"></a><span class="term"><code class="literal">GSIGNOND_ERROR_ENCRYPTION_FAILURE</code></span></p></td> +<td>Failure during data encryption/decryption. +</td> +</tr> +<tr> +<td><p><a name="GSIGNOND-ERROR-AUTH-SERVICE-ERR:CAPS"></a><span class="term"><code class="literal">GSIGNOND_ERROR_AUTH_SERVICE_ERR</code></span></p></td> +<td>Placeholder to rearrange enumeration - AuthService specific +</td> +</tr> +<tr> +<td><p><a name="GSIGNOND-ERROR-METHOD-NOT-KNOWN:CAPS"></a><span class="term"><code class="literal">GSIGNOND_ERROR_METHOD_NOT_KNOWN</code></span></p></td> +<td>The method with this name is not found. +</td> +</tr> +<tr> +<td><p><a name="GSIGNOND-ERROR-SERVICE-NOT-AVAILABLE:CAPS"></a><span class="term"><code class="literal">GSIGNOND_ERROR_SERVICE_NOT_AVAILABLE</code></span></p></td> +<td>The service is temporarily unavailable. +</td> +</tr> +<tr> +<td><p><a name="GSIGNOND-ERROR-INVALID-QUERY:CAPS"></a><span class="term"><code class="literal">GSIGNOND_ERROR_INVALID_QUERY</code></span></p></td> +<td>Parameters for the query are invalid. +</td> +</tr> +<tr> +<td><p><a name="GSIGNOND-ERROR-IDENTITY-ERR:CAPS"></a><span class="term"><code class="literal">GSIGNOND_ERROR_IDENTITY_ERR</code></span></p></td> +<td>Placeholder to rearrange enumeration - Identity specific +</td> +</tr> +<tr> +<td><p><a name="GSIGNOND-ERROR-METHOD-NOT-AVAILABLE:CAPS"></a><span class="term"><code class="literal">GSIGNOND_ERROR_METHOD_NOT_AVAILABLE</code></span></p></td> +<td>The requested method is not available. +</td> +</tr> +<tr> +<td><p><a name="GSIGNOND-ERROR-IDENTITY-NOT-FOUND:CAPS"></a><span class="term"><code class="literal">GSIGNOND_ERROR_IDENTITY_NOT_FOUND</code></span></p></td> +<td>The identity matching this Identity object was not found on the service. +</td> +</tr> +<tr> +<td><p><a name="GSIGNOND-ERROR-STORE-FAILED:CAPS"></a><span class="term"><code class="literal">GSIGNOND_ERROR_STORE_FAILED</code></span></p></td> +<td>Storing credentials failed. +</td> +</tr> +<tr> +<td><p><a name="GSIGNOND-ERROR-REMOVE-FAILED:CAPS"></a><span class="term"><code class="literal">GSIGNOND_ERROR_REMOVE_FAILED</code></span></p></td> +<td>Removing credentials failed. +</td> +</tr> +<tr> +<td><p><a name="GSIGNOND-ERROR-SIGN-OUT-FAILED:CAPS"></a><span class="term"><code class="literal">GSIGNOND_ERROR_SIGN_OUT_FAILED</code></span></p></td> +<td>SignOut failed. +</td> +</tr> +<tr> +<td><p><a name="GSIGNOND-ERROR-IDENTITY-OPERATION-CANCELED:CAPS"></a><span class="term"><code class="literal">GSIGNOND_ERROR_IDENTITY_OPERATION_CANCELED</code></span></p></td> +<td>Identity operation was canceled by user. +</td> +</tr> +<tr> +<td><p><a name="GSIGNOND-ERROR-CREDENTIALS-NOT-AVAILABLE:CAPS"></a><span class="term"><code class="literal">GSIGNOND_ERROR_CREDENTIALS_NOT_AVAILABLE</code></span></p></td> +<td>Query failed. +</td> +</tr> +<tr> +<td><p><a name="GSIGNOND-ERROR-REFERENCE-NOT-FOUND:CAPS"></a><span class="term"><code class="literal">GSIGNOND_ERROR_REFERENCE_NOT_FOUND</code></span></p></td> +<td>Trying to remove nonexistent reference. +</td> +</tr> +<tr> +<td><p><a name="GSIGNOND-ERROR-AUTH-SESSION-ERR:CAPS"></a><span class="term"><code class="literal">GSIGNOND_ERROR_AUTH_SESSION_ERR</code></span></p></td> +<td>Placeholder to rearrange enumeration - AuthSession/PluginInterface specific +</td> +</tr> +<tr> +<td><p><a name="GSIGNOND-ERROR-MECHANISM-NOT-AVAILABLE:CAPS"></a><span class="term"><code class="literal">GSIGNOND_ERROR_MECHANISM_NOT_AVAILABLE</code></span></p></td> +<td>The requested mechanism is not available. +</td> +</tr> +<tr> +<td><p><a name="GSIGNOND-ERROR-MISSING-DATA:CAPS"></a><span class="term"><code class="literal">GSIGNOND_ERROR_MISSING_DATA</code></span></p></td> +<td>The SessionData object does not contain necessary information. +</td> +</tr> +<tr> +<td><p><a name="GSIGNOND-ERROR-INVALID-CREDENTIALS:CAPS"></a><span class="term"><code class="literal">GSIGNOND_ERROR_INVALID_CREDENTIALS</code></span></p></td> +<td>The supplied credentials are invalid for the mechanism implementation. +</td> +</tr> +<tr> +<td><p><a name="GSIGNOND-ERROR-NOT-AUTHORIZED:CAPS"></a><span class="term"><code class="literal">GSIGNOND_ERROR_NOT_AUTHORIZED</code></span></p></td> +<td>Authorization failed. +</td> +</tr> +<tr> +<td><p><a name="GSIGNOND-ERROR-WRONG-STATE:CAPS"></a><span class="term"><code class="literal">GSIGNOND_ERROR_WRONG_STATE</code></span></p></td> +<td>An operation method has been called in a wrong state. +</td> +</tr> +<tr> +<td><p><a name="GSIGNOND-ERROR-OPERATION-NOT-SUPPORTED:CAPS"></a><span class="term"><code class="literal">GSIGNOND_ERROR_OPERATION_NOT_SUPPORTED</code></span></p></td> +<td>The operation is not supported by the mechanism implementation. +</td> +</tr> +<tr> +<td><p><a name="GSIGNOND-ERROR-NO-CONNECTION:CAPS"></a><span class="term"><code class="literal">GSIGNOND_ERROR_NO_CONNECTION</code></span></p></td> +<td>No Network connetion. +</td> +</tr> +<tr> +<td><p><a name="GSIGNOND-ERROR-NETWORK:CAPS"></a><span class="term"><code class="literal">GSIGNOND_ERROR_NETWORK</code></span></p></td> +<td>Network connetion failed. +</td> +</tr> +<tr> +<td><p><a name="GSIGNOND-ERROR-SSL:CAPS"></a><span class="term"><code class="literal">GSIGNOND_ERROR_SSL</code></span></p></td> +<td>Ssl connection failed. +</td> +</tr> +<tr> +<td><p><a name="GSIGNOND-ERROR-RUNTIME:CAPS"></a><span class="term"><code class="literal">GSIGNOND_ERROR_RUNTIME</code></span></p></td> +<td>Casting SessionData into subclass failed +</td> +</tr> +<tr> +<td><p><a name="GSIGNOND-ERROR-SESSION-CANCELED:CAPS"></a><span class="term"><code class="literal">GSIGNOND_ERROR_SESSION_CANCELED</code></span></p></td> +<td>Challenge was cancelled. +</td> +</tr> +<tr> +<td><p><a name="GSIGNOND-ERROR-TIMED-OUT:CAPS"></a><span class="term"><code class="literal">GSIGNOND_ERROR_TIMED_OUT</code></span></p></td> +<td>Challenge was timed out. +</td> +</tr> +<tr> +<td><p><a name="GSIGNOND-ERROR-USER-INTERACTION:CAPS"></a><span class="term"><code class="literal">GSIGNOND_ERROR_USER_INTERACTION</code></span></p></td> +<td>User interaction dialog failed +</td> +</tr> +<tr> +<td><p><a name="GSIGNOND-ERROR-OPERATION-FAILED:CAPS"></a><span class="term"><code class="literal">GSIGNOND_ERROR_OPERATION_FAILED</code></span></p></td> +<td>Temporary failure in authentication. +</td> +</tr> +<tr> +<td><p><a name="GSIGNOND-ERROR-ENCRYPTION-FAILED:CAPS"></a><span class="term"><code class="literal">GSIGNOND_ERROR_ENCRYPTION_FAILED</code></span></p></td> +<td>Failure during data encryption/decryption. +</td> +</tr> +<tr> +<td><p><a name="GSIGNOND-ERROR-TOS-NOT-ACCEPTED:CAPS"></a><span class="term"><code class="literal">GSIGNOND_ERROR_TOS_NOT_ACCEPTED</code></span></p></td> +<td>User declined Terms of Service. +</td> +</tr> +<tr> +<td><p><a name="GSIGNOND-ERROR-FORGOT-PASSWORD:CAPS"></a><span class="term"><code class="literal">GSIGNOND_ERROR_FORGOT_PASSWORD</code></span></p></td> +<td>User requested reset password sequence. +</td> +</tr> +<tr> +<td><p><a name="GSIGNOND-ERROR-METHOD-OR-MECHANISM-NOT-ALLOWED:CAPS"></a><span class="term"><code class="literal">GSIGNOND_ERROR_METHOD_OR_MECHANISM_NOT_ALLOWED</code></span></p></td> +<td>Method or mechanism not allowed for this identity. +</td> +</tr> +<tr> +<td><p><a name="GSIGNOND-ERROR-INCORRECT-DATE:CAPS"></a><span class="term"><code class="literal">GSIGNOND_ERROR_INCORRECT_DATE</code></span></p></td> +<td>Date time incorrect on device. +</td> +</tr> +<tr> +<td><p><a name="GSIGNOND-ERROR-USER-ERR:CAPS"></a><span class="term"><code class="literal">GSIGNOND_ERROR_USER_ERR</code></span></p></td> +<td>Placeholder to rearrange enumeration - User space specific +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-error-new-from-variant"></a><h3>gsignond_error_new_from_variant ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="returnvalue">GError</span></a> * gsignond_error_new_from_variant (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *var</code></em>);</pre> +<p> +Converts the GVariant to GError. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>var</code></em> :</span></p></td> +<td>instance of <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> object if successful, NULL otherwise. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-error-quark"></a><h3>gsignond_error_quark ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> gsignond_error_quark (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p> +Creates and returns a domain for GSignond errors. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-error-to-variant"></a><h3>gsignond_error_to_variant ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="returnvalue">GVariant</span></a> * gsignond_error_to_variant (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> *error</code></em>);</pre> +<p> +Converts the GError to GVariant. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td> +<td>instance of <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> object if successful, NULL otherwise. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-get-gerror-for-id"></a><h3>gsignond_get_gerror_for_id()</h3> +<pre class="programlisting">#define gsignond_get_gerror_for_id(err, message, args...)</pre> +<p> +A helper macro that creates a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> with the proper gsignond domain +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td> +<td>A <a class="link" href="gsignond-Errors.html#GSignondError" title="enum GSignondError"><span class="type">GSignondError</span></a> specifying the error</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td> +<td>Format string for the error message</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td> +<td>parameters for the error string</td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.19.1</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/html/gsignond-GSignondDictionary.html b/docs/html/gsignond-GSignondDictionary.html new file mode 100644 index 0000000..8c7f6e2 --- /dev/null +++ b/docs/html/gsignond-GSignondDictionary.html @@ -0,0 +1,771 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GSignondDictionary</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="gsignond API Reference Manual"> +<link rel="up" href="ch03.html" title="GSignond API for writing authentication plugins"> +<link rel="prev" href="gsignond-GSignondPlugin.html" title="GSignondPlugin"> +<link rel="next" href="gsignond-GSignondSessionData.html" title="GSignondSessionData"> +<meta name="generator" content="GTK-Doc V1.19.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle"> +<td width="100%" align="left"> +<a href="#" class="shortcut">Top</a> +  | + <a href="#gsignond-GSignondDictionary.description" class="shortcut">Description</a> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="ch03.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="gsignond-GSignondPlugin.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="gsignond-GSignondSessionData.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="gsignond-GSignondDictionary"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="gsignond-GSignondDictionary.top_of_page"></a>GSignondDictionary</span></h2> +<p>GSignondDictionary — a dictionary container holding string keys and variant values</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="gsignond-GSignondDictionary.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis"> +#include <gsignond/gsignond-dictionary.h> + +typedef <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary">GSignondDictionary</a>; +<a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="returnvalue">GSignondDictionary</span></a> * <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-copy" title="gsignond_dictionary_copy ()">gsignond_dictionary_copy</a> (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *other</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="returnvalue">GVariant</span></a> * <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-get" title="gsignond_dictionary_get ()">gsignond_dictionary_get</a> (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-get-boolean" title="gsignond_dictionary_get_boolean ()">gsignond_dictionary_get_boolean</a> (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *value</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-get-int32" title="gsignond_dictionary_get_int32 ()">gsignond_dictionary_get_int32</a> (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *value</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-get-int64" title="gsignond_dictionary_get_int64 ()">gsignond_dictionary_get_int64</a> (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>, + <em class="parameter"><code><span class="type">gint64</span> *value</code></em>); +const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-get-string" title="gsignond_dictionary_get_string ()">gsignond_dictionary_get_string</a> (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-get-uint32" title="gsignond_dictionary_get_uint32 ()">gsignond_dictionary_get_uint32</a> (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *value</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-get-uint64" title="gsignond_dictionary_get_uint64 ()">gsignond_dictionary_get_uint64</a> (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>, + <em class="parameter"><code><span class="type">guint64</span> *value</code></em>); +<a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="returnvalue">GSignondDictionary</span></a> * <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-new" title="gsignond_dictionary_new ()">gsignond_dictionary_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>); +<a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="returnvalue">GSignondDictionary</span></a> * <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-new-from-variant" title="gsignond_dictionary_new_from_variant ()">gsignond_dictionary_new_from_variant</a> + (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *variant</code></em>); +<a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="returnvalue">GSignondDictionary</span></a> * <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-ref" title="gsignond_dictionary_ref ()">gsignond_dictionary_ref</a> (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-remove" title="gsignond_dictionary_remove ()">gsignond_dictionary_remove</a> (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-set" title="gsignond_dictionary_set ()">gsignond_dictionary_set</a> (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *value</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-set-boolean" title="gsignond_dictionary_set_boolean ()">gsignond_dictionary_set_boolean</a> (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> value</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-set-int32" title="gsignond_dictionary_set_int32 ()">gsignond_dictionary_set_int32</a> (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> value</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-set-int64" title="gsignond_dictionary_set_int64 ()">gsignond_dictionary_set_int64</a> (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>, + <em class="parameter"><code><span class="type">gint64</span> value</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-set-string" title="gsignond_dictionary_set_string ()">gsignond_dictionary_set_string</a> (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *value</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-set-uint32" title="gsignond_dictionary_set_uint32 ()">gsignond_dictionary_set_uint32</a> (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>, + <em class="parameter"><code><span class="type">guint32</span> value</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-set-uint64" title="gsignond_dictionary_set_uint64 ()">gsignond_dictionary_set_uint64</a> (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>, + <em class="parameter"><code><span class="type">guint64</span> value</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="returnvalue">GVariant</span></a> * <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-to-variant" title="gsignond_dictionary_to_variant ()">gsignond_dictionary_to_variant</a> (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>); +<span class="returnvalue">void</span> <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-unref" title="gsignond_dictionary_unref ()">gsignond_dictionary_unref</a> (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="gsignond-GSignondDictionary.description"></a><h2>Description</h2> +<p> +A <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> is a dictionary data structure that maps string keys to <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> values. +It's used in multiple places in gsignond and its public API to pass key-value +data sets. +</p> +<p> +</p> +<div class="informalexample"> + <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> + <tbody> + <tr> + <td class="listing_lines" align="right"><pre>1 +2 +3 +4 +5 +6 +7 +8</pre></td> + <td class="listing_code"><pre class="programlisting">GSignondDictionary* dict = gsignond_dictionary_new(); + gsignond_dictionary_set_string(dict, <span class="number">"name"</span>, <span class="number">"John Smith"</span>); + gsignond_dictionary_set_uint32(dict, <span class="number">"age"</span>, <span class="number">32</span>); + + guint32 age; + gboolean success = gsignond_dictionary_get_uint32(dict, <span class="number">"age"</span>, &age); + <span class="type">const</span> gchar* name = gsignond_dictionary_get_string(dict, <span class="number">"name"</span>); + gsignond_dictionary_unref(dict);</pre></td> + </tr> + </tbody> + </table> +</div> + +<p> +</p> +</div> +<div class="refsect1"> +<a name="gsignond-GSignondDictionary.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GSignondDictionary"></a><h3>GSignondDictionary</h3> +<pre class="programlisting">typedef GHashTable GSignondDictionary; +</pre> +<p> +<a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> is a typedef for <a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a>, which +means the developers may also use methods associated with that structure. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-dictionary-copy"></a><h3>gsignond_dictionary_copy ()</h3> +<pre class="programlisting"><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="returnvalue">GSignondDictionary</span></a> * gsignond_dictionary_copy (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *other</code></em>);</pre> +<p> +Creates a copy of the dictionary. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>other</code></em> :</span></p></td> +<td>instance of <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> object if the copy was successful, +NULL otherwise. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-dictionary-get"></a><h3>gsignond_dictionary_get ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="returnvalue">GVariant</span></a> * gsignond_dictionary_get (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>);</pre> +<p> +Retrieves a <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> value from the dictionary. This can be used to retrieve +a value of an arbitrary type, and then convert it manually to a specific type +using <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> methods. For most commonly used types, also getters that +return the specific type directly are provided (<a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-get-string" title="gsignond_dictionary_get_string ()"><code class="function">gsignond_dictionary_get_string()</code></a> +and similar). +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>dict</code></em> :</span></p></td> +<td>instance of <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td> +<td>the key to look up in the dictionary</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the value; NULL is returned in case of failure (for +example if the entry corresponding to the supplied key doesn't exist). <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-dictionary-get-boolean"></a><h3>gsignond_dictionary_get_boolean ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gsignond_dictionary_get_boolean (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *value</code></em>);</pre> +<p> +Retrieves a gboolean value. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>dict</code></em> :</span></p></td> +<td>instance of <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td> +<td>key to look up. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td> +<td>points to the location where the value should be set</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>TRUE if the value was retrieved successfully, FALSE otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-dictionary-get-int32"></a><h3>gsignond_dictionary_get_int32 ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gsignond_dictionary_get_int32 (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *value</code></em>);</pre> +<p> +Retrieves a int32 value. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>dict</code></em> :</span></p></td> +<td>instance of <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td> +<td>key to look up. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td> +<td>points to the location where the value should be set</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>TRUE if the value was retrieved successfully, FALSE otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-dictionary-get-int64"></a><h3>gsignond_dictionary_get_int64 ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gsignond_dictionary_get_int64 (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>, + <em class="parameter"><code><span class="type">gint64</span> *value</code></em>);</pre> +<p> +Retrieves a int64 value. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>dict</code></em> :</span></p></td> +<td>instance of <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td> +<td>key to look up. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td> +<td>points to the location where the value should be set</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>TRUE if the value was retrieved successfully, FALSE otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-dictionary-get-string"></a><h3>gsignond_dictionary_get_string ()</h3> +<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gsignond_dictionary_get_string (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>);</pre> +<p> +Retrieves a string value. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>dict</code></em> :</span></p></td> +<td>instance of <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td> +<td>key to look up. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the value if it was retrieved successfully, NULL otherwise. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-dictionary-get-uint32"></a><h3>gsignond_dictionary_get_uint32 ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gsignond_dictionary_get_uint32 (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *value</code></em>);</pre> +<p> +Retrieves a uint32 value. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>dict</code></em> :</span></p></td> +<td>instance of <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td> +<td>key to look up. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td> +<td>points to the location where the value should be set</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>TRUE if the value was retrieved successfully, FALSE otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-dictionary-get-uint64"></a><h3>gsignond_dictionary_get_uint64 ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gsignond_dictionary_get_uint64 (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>, + <em class="parameter"><code><span class="type">guint64</span> *value</code></em>);</pre> +<p> +Retrieves a uint64 value. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>dict</code></em> :</span></p></td> +<td>instance of <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td> +<td>key to look up. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td> +<td>points to the location where the value should be set</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>TRUE if the value was retrieved successfully, FALSE otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-dictionary-new"></a><h3>gsignond_dictionary_new ()</h3> +<pre class="programlisting"><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="returnvalue">GSignondDictionary</span></a> * gsignond_dictionary_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p> +Creates a new instance of <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> object if successful, +NULL otherwise. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span> +</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-dictionary-new-from-variant"></a><h3>gsignond_dictionary_new_from_variant ()</h3> +<pre class="programlisting"><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="returnvalue">GSignondDictionary</span></a> * gsignond_dictionary_new_from_variant + (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *variant</code></em>);</pre> +<p> +Converts the <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> to <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a>. This is useful for example if +the dictionary needs to be deserialized, or if it's contained in another +<a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> and has been retrieved using <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-get" title="gsignond_dictionary_get ()"><code class="function">gsignond_dictionary_get()</code></a>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>variant</code></em> :</span></p></td> +<td>instance of <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> if successful, NULL otherwise. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-dictionary-ref"></a><h3>gsignond_dictionary_ref ()</h3> +<pre class="programlisting"><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="returnvalue">GSignondDictionary</span></a> * gsignond_dictionary_ref (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>);</pre> +<p> +Increments the reference count of the dictionary structure. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>dict</code></em> :</span></p></td> +<td>instance of <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the pointer to the passed in <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-dictionary-remove"></a><h3>gsignond_dictionary_remove ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gsignond_dictionary_remove (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>);</pre> +<p> +Removes key-value pair in the dictionary as per key. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>dict</code></em> :</span></p></td> +<td>instance of <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td> +<td>key which needs to be removed from the dictionary. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>TRUE if successful, FALSE otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-dictionary-set"></a><h3>gsignond_dictionary_set ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gsignond_dictionary_set (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *value</code></em>);</pre> +<p> +Adds or replaces key-value pair in the dictionary. This allows to set a value +of an arbitrary type: it first needs to be converted to a <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a>. For most +commonly used types also type-specific setters are provided. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>dict</code></em> :</span></p></td> +<td>instance of <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td> +<td>key to be set. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td> +<td>value to be set. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>TRUE if successful, FALSE otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-dictionary-set-boolean"></a><h3>gsignond_dictionary_set_boolean ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gsignond_dictionary_set_boolean (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> value</code></em>);</pre> +<p> +Sets or replaces a gboolean value in the dictionary. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>dict</code></em> :</span></p></td> +<td>instance of <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td> +<td>key to set. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td> +<td>value to set</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>TRUE if the value was set or replaced successfully, FALSE otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-dictionary-set-int32"></a><h3>gsignond_dictionary_set_int32 ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gsignond_dictionary_set_int32 (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> value</code></em>);</pre> +<p> +Sets or replaces a int32 value in the dictionary. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>dict</code></em> :</span></p></td> +<td>instance of <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td> +<td>key to set. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td> +<td>value to set</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>TRUE if the value was set or replaced successfully, FALSE otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-dictionary-set-int64"></a><h3>gsignond_dictionary_set_int64 ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gsignond_dictionary_set_int64 (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>, + <em class="parameter"><code><span class="type">gint64</span> value</code></em>);</pre> +<p> +Sets or replaces a int64 value in the dictionary. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>dict</code></em> :</span></p></td> +<td>instance of <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td> +<td>key to set. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td> +<td>value to set</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>TRUE if the value was set or replaced successfully, FALSE otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-dictionary-set-string"></a><h3>gsignond_dictionary_set_string ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gsignond_dictionary_set_string (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *value</code></em>);</pre> +<p> +Sets or replaces a string value in the dictionary. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>dict</code></em> :</span></p></td> +<td>instance of <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td> +<td>key to set. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td> +<td>value to set. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>TRUE if the value was set or replaced successfully, FALSE otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-dictionary-set-uint32"></a><h3>gsignond_dictionary_set_uint32 ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gsignond_dictionary_set_uint32 (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>, + <em class="parameter"><code><span class="type">guint32</span> value</code></em>);</pre> +<p> +Sets or replaces a uint32 value in the dictionary. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>dict</code></em> :</span></p></td> +<td>instance of <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td> +<td>key to set. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td> +<td>value to set</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>TRUE if the value was set or replaced successfully, FALSE otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-dictionary-set-uint64"></a><h3>gsignond_dictionary_set_uint64 ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gsignond_dictionary_set_uint64 (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>, + <em class="parameter"><code><span class="type">guint64</span> value</code></em>);</pre> +<p> +Sets or replaces a uint64 value in the dictionary. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>dict</code></em> :</span></p></td> +<td>instance of <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td> +<td>key to set. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td> +<td>value to set</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>TRUE if the value was set or replaced successfully, FALSE otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-dictionary-to-variant"></a><h3>gsignond_dictionary_to_variant ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="returnvalue">GVariant</span></a> * gsignond_dictionary_to_variant (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>);</pre> +<p> +Converts the <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> to a <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a>. The result can be serialized +or put into another <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> using <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-set" title="gsignond_dictionary_set ()"><code class="function">gsignond_dictionary_set()</code></a>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>dict</code></em> :</span></p></td> +<td>instance of <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> object if successful, NULL otherwise. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-dictionary-unref"></a><h3>gsignond_dictionary_unref ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> gsignond_dictionary_unref (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>);</pre> +<p> +Decrements the reference count of the dictionary structure. If the reference +count reaches zero, the structure is deallocated and shouldn't be used. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><em class="parameter"><code>dict</code></em> :</span></p></td> +<td>instance of <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> +</td> +</tr></tbody> +</table></div> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.19.1</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/html/gsignond-GSignondPlugin.html b/docs/html/gsignond-GSignondPlugin.html new file mode 100644 index 0000000..d77d3f1 --- /dev/null +++ b/docs/html/gsignond-GSignondPlugin.html @@ -0,0 +1,694 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GSignondPlugin</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="gsignond API Reference Manual"> +<link rel="up" href="ch03.html" title="GSignond API for writing authentication plugins"> +<link rel="prev" href="ch03.html" title="GSignond API for writing authentication plugins"> +<link rel="next" href="gsignond-GSignondDictionary.html" title="GSignondDictionary"> +<meta name="generator" content="GTK-Doc V1.19.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle"> +<td width="100%" align="left"> +<a href="#" class="shortcut">Top</a> +  | + <a href="#gsignond-GSignondPlugin.description" class="shortcut">Description</a> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="ch03.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="ch03.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="gsignond-GSignondDictionary.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="gsignond-GSignondPlugin"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="gsignond-GSignondPlugin.top_of_page"></a>GSignondPlugin</span></h2> +<p>GSignondPlugin — an interface for implementing authentication plugins</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="gsignond-GSignondPlugin.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis"> +#include <gsignond/gsignond-plugin-interface.h> + +struct <a class="link" href="gsignond-GSignondPlugin.html#GSignondPluginInterface" title="struct GSignondPluginInterface">GSignondPluginInterface</a>; +enum <a class="link" href="gsignond-GSignondPlugin.html#GSignondPluginState" title="enum GSignondPluginState">GSignondPluginState</a>; +<span class="returnvalue">void</span> <a class="link" href="gsignond-GSignondPlugin.html#gsignond-plugin-cancel" title="gsignond_plugin_cancel ()">gsignond_plugin_cancel</a> (<em class="parameter"><code><span class="type">GSignondPlugin</span> *self</code></em>); +<span class="returnvalue">void</span> <a class="link" href="gsignond-GSignondPlugin.html#gsignond-plugin-error" title="gsignond_plugin_error ()">gsignond_plugin_error</a> (<em class="parameter"><code><span class="type">GSignondPlugin</span> *self</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> *error</code></em>); +<span class="returnvalue">void</span> <a class="link" href="gsignond-GSignondPlugin.html#gsignond-plugin-refresh" title="gsignond_plugin_refresh ()">gsignond_plugin_refresh</a> (<em class="parameter"><code><span class="type">GSignondPlugin</span> *self</code></em>, + <em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *ui_data</code></em>); +<span class="returnvalue">void</span> <a class="link" href="gsignond-GSignondPlugin.html#gsignond-plugin-refreshed" title="gsignond_plugin_refreshed ()">gsignond_plugin_refreshed</a> (<em class="parameter"><code><span class="type">GSignondPlugin</span> *self</code></em>, + <em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *ui_data</code></em>); +<span class="returnvalue">void</span> <a class="link" href="gsignond-GSignondPlugin.html#gsignond-plugin-request" title="gsignond_plugin_request ()">gsignond_plugin_request</a> (<em class="parameter"><code><span class="type">GSignondPlugin</span> *self</code></em>, + <em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *session_data</code></em>); +<span class="returnvalue">void</span> <a class="link" href="gsignond-GSignondPlugin.html#gsignond-plugin-request-initial" title="gsignond_plugin_request_initial ()">gsignond_plugin_request_initial</a> (<em class="parameter"><code><span class="type">GSignondPlugin</span> *self</code></em>, + <em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *session_data</code></em>, + <em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *identity_method_cache</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *mechanism</code></em>); +<span class="returnvalue">void</span> <a class="link" href="gsignond-GSignondPlugin.html#gsignond-plugin-response" title="gsignond_plugin_response ()">gsignond_plugin_response</a> (<em class="parameter"><code><span class="type">GSignondPlugin</span> *self</code></em>, + <em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *session_data</code></em>); +<span class="returnvalue">void</span> <a class="link" href="gsignond-GSignondPlugin.html#gsignond-plugin-response-final" title="gsignond_plugin_response_final ()">gsignond_plugin_response_final</a> (<em class="parameter"><code><span class="type">GSignondPlugin</span> *self</code></em>, + <em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *session_data</code></em>); +<span class="returnvalue">void</span> <a class="link" href="gsignond-GSignondPlugin.html#gsignond-plugin-status-changed" title="gsignond_plugin_status_changed ()">gsignond_plugin_status_changed</a> (<em class="parameter"><code><span class="type">GSignondPlugin</span> *self</code></em>, + <em class="parameter"><code><a class="link" href="gsignond-GSignondPlugin.html#GSignondPluginState" title="enum GSignondPluginState"><span class="type">GSignondPluginState</span></a> state</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *message</code></em>); +<span class="returnvalue">void</span> <a class="link" href="gsignond-GSignondPlugin.html#gsignond-plugin-store" title="gsignond_plugin_store ()">gsignond_plugin_store</a> (<em class="parameter"><code><span class="type">GSignondPlugin</span> *self</code></em>, + <em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *identity_method_cache</code></em>); +<span class="returnvalue">void</span> <a class="link" href="gsignond-GSignondPlugin.html#gsignond-plugin-user-action-finished" title="gsignond_plugin_user_action_finished ()">gsignond_plugin_user_action_finished</a> + (<em class="parameter"><code><span class="type">GSignondPlugin</span> *self</code></em>, + <em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *ui_data</code></em>); +<span class="returnvalue">void</span> <a class="link" href="gsignond-GSignondPlugin.html#gsignond-plugin-user-action-required" title="gsignond_plugin_user_action_required ()">gsignond_plugin_user_action_required</a> + (<em class="parameter"><code><span class="type">GSignondPlugin</span> *self</code></em>, + <em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *ui_data</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="gsignond-GSignondPlugin.description"></a><h2>Description</h2> +<p> +<span class="type">GSignondPlugin</span> is an interface for implementing authentication plugins. +</p> +<p> +When creating a plugin, write the <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> boilerplate code as usual, but +</p> +<p> +a) declare the type as follows: +</p> +<p> +</p> +<div class="informalexample"> + <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> + <tbody> + <tr> + <td class="listing_lines" align="right"><pre>1 +2 +3 +4</pre></td> + <td class="listing_code"><pre class="programlisting">G_DEFINE_TYPE_WITH_CODE (GSignondPasswordPlugin, gsignond_password_plugin, + G_TYPE_OBJECT, + G_IMPLEMENT_INTERFACE (GSIGNOND_TYPE_PLUGIN, + gsignond_plugin_interface_init));</pre></td> + </tr> + </tbody> + </table> +</div> + +<p> +</p> +<p> +b) implement <code class="function">gsignond_plugin_interface_init</code> as follows: +</p> +<p> +</p> +<div class="informalexample"> + <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> + <tbody> + <tr> + <td class="listing_lines" align="right"><pre>1 +2 +3 +4 +5 +6 +7 +8 +9</pre></td> + <td class="listing_code"><pre class="programlisting"><span class="type">static</span> <span class="type">void</span> +gsignond_plugin_interface_init (GSignondPluginInterface *iface) +{ + iface->cancel = gsignond_password_plugin_cancel; + iface->request_initial = gsignond_password_plugin_request_initial; + iface->request = gsignond_password_plugin_request; + iface->user_action_finished = gsignond_password_plugin_user_action_finished; + iface->refresh = gsignond_password_plugin_refresh; +}</pre></td> + </tr> + </tbody> + </table> +</div> + +<p> +</p> +<p> +where the <code class="function">gsignond_password_plugin_cancel</code> etc. are specific implementations of +plugin interface methods that every plugin must provide (see below for when +and how they're used by the daemon). +</p> +<p> +c) override <span class="type">"type"</span> and <span class="type">"mechanisms"</span> property +implementations in the plugin class constructor like this: +</p> +<p> +</p> +<div class="informalexample"> + <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> + <tbody> + <tr> + <td class="listing_lines" align="right"><pre>1 +2 +3 +4 +5 +6 +7 +8 +9 +10 +11 +12</pre></td> + <td class="listing_code"><pre class="programlisting"><span class="type">static</span> <span class="type">void</span> +gsignond_password_plugin_class_init (GSignondPasswordPluginClass *klass) +{ + GObjectClass *gobject_class = G_OBJECT_CLASS (klass); + + gobject_class->set_property = gsignond_password_plugin_set_property; + gobject_class->get_property = gsignond_password_plugin_get_property; + + g_object_class_override_property (gobject_class, PROP_TYPE, <span class="number">"type"</span>); + g_object_class_override_property (gobject_class, PROP_MECHANISMS, + <span class="number">"mechanisms"</span>); +}</pre></td> + </tr> + </tbody> + </table> +</div> + +<p> +(naturally, plugin's property setter should ignore attempts to set these properties, +and plugin's property getter should provide their values when asked) +</p> +<p> +</p> +<div class="refsect1"> +<a name="idp7924464"></a><h2>The plugin API</h2> +</div> +<p> +</p> +<p> +Plugins implement authentication sessions which are controlled through the +plugin API. Authentication sessions follow one another so there is only one active +session at a time. +</p> +<p> +The plugin API is a set of methods and signals that should be used in a specific +sequence: +</p> +<p> +</p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"><p>successful authentication session begins with <a class="link" href="gsignond-GSignondPlugin.html#gsignond-plugin-request-initial" title="gsignond_plugin_request_initial ()"><code class="function">gsignond_plugin_request_initial()</code></a> and ends +with the plugin issuing a <span class="type">"response-final"</span> signal</p></li> +<li class="listitem"><p>at any point the application can cancel an active session with +<a class="link" href="gsignond-GSignondPlugin.html#gsignond-plugin-cancel" title="gsignond_plugin_cancel ()"><code class="function">gsignond_plugin_cancel()</code></a></p></li> +<li class="listitem"><p>at any point the plugin can cancel an active session by issuing <span class="type">"error"</span> +signal, which also provides some details about the cancellation reason.</p></li> +<li class="listitem"><p>if a session is active, and the plugin has an intermediate response or needs +additional information, it issues <span class="type">"response"</span> signal, which the +application should respond to with <a class="link" href="gsignond-GSignondPlugin.html#gsignond-plugin-request" title="gsignond_plugin_request ()"><code class="function">gsignond_plugin_request()</code></a> method. This can +happen more than once.</p></li> +<li class="listitem"><p>if the plugin needs to launch UI interaction with the user, it's issuing +<span class="type">"user-action-required"</span> signal, which the application should +follow up with <a class="link" href="gsignond-GSignondPlugin.html#gsignond-plugin-user-action-finished" title="gsignond_plugin_user_action_finished ()"><code class="function">gsignond_plugin_user_action_finished()</code></a> method. This can happen +more than once as well.</p></li> +<li class="listitem"><p>if, during an active UI session, the application needs a UI refresh +(for example, to fetch a new captcha image), it's +requested from the plugin with <a class="link" href="gsignond-GSignondPlugin.html#gsignond-plugin-refresh" title="gsignond_plugin_refresh ()"><code class="function">gsignond_plugin_refresh()</code></a> method, followed +by the plugin's response via <span class="type">"refreshed"</span> signal. This can happen +more than once.</p></li> +<li class="listitem"><p>changes in plugin state are reported through <span class="type">"status-changed"</span> signal.</p></li> +<li class="listitem"><p>if the plugin needs to store information in persistent storage, it issues +<span class="type">"store"</span> signal. Later, that same information is provided as a +parameter to <a class="link" href="gsignond-GSignondPlugin.html#gsignond-plugin-request-initial" title="gsignond_plugin_request_initial ()"><code class="function">gsignond_plugin_request_initial()</code></a>.</p></li> +</ul></div> +<p> +</p> +<p> +</p> +<div class="refsect1"> +<a name="idp12313904"></a><h2>Example plugins</h2> +</div> +<p> +</p> +<p> +See example plugin implementation here: +<a class="ulink" href="https://code.google.com/p/accounts-sso/source/browse/?repo=gsignond#git%2Fsrc%2Fplugins" target="_top"> +https://code.google.com/p/accounts-sso/source/browse/?repo=gsignond#git%2Fsrc%2Fplugins</a>. +</p> +<p> +For examples of out of tree plugins, you can have a look at SASL or OAuth plugin +implementations: +<a class="ulink" href="http://code.google.com/p/accounts-sso/source/browse?repo=gsignond-plugin-sasl" target="_top"> +http://code.google.com/p/accounts-sso/source/browse?repo=gsignond-plugin-sasl</a>. +</p> +<p> +<a class="ulink" href="http://code.google.com/p/accounts-sso/source/browse?repo=gsignond-plugin-oa" target="_top"> +http://code.google.com/p/accounts-sso/source/browse?repo=gsignond-plugin-oa</a>. +</p> +</div> +<div class="refsect1"> +<a name="gsignond-GSignondPlugin.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GSignondPluginInterface"></a><h3>struct GSignondPluginInterface</h3> +<pre class="programlisting">struct GSignondPluginInterface { + GTypeInterface parent; + + void (*cancel) (GSignondPlugin *self); + void (*request_initial) (GSignondPlugin *self, + GSignondSessionData *session_data, + GSignondDictionary *identity_method_cache, + const gchar *mechanism); + void (*request) (GSignondPlugin *self, + GSignondSessionData *session_data); + void (*user_action_finished) (GSignondPlugin *self, + GSignondSignonuiData *session_data); + void (*refresh) (GSignondPlugin *self, + GSignondSignonuiData *session_data); +}; +</pre> +<p> +<a class="link" href="gsignond-GSignondPlugin.html#GSignondPluginInterface" title="struct GSignondPluginInterface"><span class="type">GSignondPluginInterface</span></a> interface containing pointers to methods that all +plugin implementations should provide. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GTypeInterface"><span class="type">GTypeInterface</span></a> <em class="structfield"><code><a name="GSignondPluginInterface.parent"></a>parent</code></em>;</span></p></td> +<td>parent interface type.</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="GSignondPluginInterface.cancel"></a>cancel</code></em> ()</span></p></td> +<td>implementation of <a class="link" href="gsignond-GSignondPlugin.html#gsignond-plugin-cancel" title="gsignond_plugin_cancel ()"><code class="function">gsignond_plugin_cancel()</code></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="GSignondPluginInterface.request-initial"></a>request_initial</code></em> ()</span></p></td> +<td>implementation of <a class="link" href="gsignond-GSignondPlugin.html#gsignond-plugin-request-initial" title="gsignond_plugin_request_initial ()"><code class="function">gsignond_plugin_request_initial()</code></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="GSignondPluginInterface.request"></a>request</code></em> ()</span></p></td> +<td>implementation of <a class="link" href="gsignond-GSignondPlugin.html#gsignond-plugin-request" title="gsignond_plugin_request ()"><code class="function">gsignond_plugin_request()</code></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="GSignondPluginInterface.user-action-finished"></a>user_action_finished</code></em> ()</span></p></td> +<td>implementation of <a class="link" href="gsignond-GSignondPlugin.html#gsignond-plugin-user-action-finished" title="gsignond_plugin_user_action_finished ()"><code class="function">gsignond_plugin_user_action_finished()</code></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="GSignondPluginInterface.refresh"></a>refresh</code></em> ()</span></p></td> +<td>implementation of <a class="link" href="gsignond-GSignondPlugin.html#gsignond-plugin-refresh" title="gsignond_plugin_refresh ()"><code class="function">gsignond_plugin_refresh()</code></a> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="GSignondPluginState"></a><h3>enum GSignondPluginState</h3> +<pre class="programlisting">typedef enum { + GSIGNOND_PLUGIN_STATE_NONE = 0, + GSIGNOND_PLUGIN_STATE_RESOLVING, + GSIGNOND_PLUGIN_STATE_CONNECTING, + GSIGNOND_PLUGIN_STATE_SENDING_DATA, + GSIGNOND_PLUGIN_STATE_WAITING, + GSIGNOND_PLUGIN_STATE_USER_PENDING, + GSIGNOND_PLUGIN_STATE_REFRESHING, + GSIGNOND_PLUGIN_STATE_PROCESS_PENDING, + GSIGNOND_PLUGIN_STATE_STARTED, + GSIGNOND_PLUGIN_STATE_CANCELING, + GSIGNOND_PLUGIN_STATE_DONE, + GSIGNOND_PLUGIN_STATE_HOLDING, +} GSignondPluginState; +</pre> +<p> +The plugin provides state updates by emitting <span class="type">"status-changed"</span> +signal with this enum and a string describing what happened. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><a name="GSIGNOND-PLUGIN-STATE-NONE:CAPS"></a><span class="term"><code class="literal">GSIGNOND_PLUGIN_STATE_NONE</code></span></p></td> +<td>State unknown +</td> +</tr> +<tr> +<td><p><a name="GSIGNOND-PLUGIN-STATE-RESOLVING:CAPS"></a><span class="term"><code class="literal">GSIGNOND_PLUGIN_STATE_RESOLVING</code></span></p></td> +<td>Resolving remote server host name +</td> +</tr> +<tr> +<td><p><a name="GSIGNOND-PLUGIN-STATE-CONNECTING:CAPS"></a><span class="term"><code class="literal">GSIGNOND_PLUGIN_STATE_CONNECTING</code></span></p></td> +<td>Connecting to remote server +</td> +</tr> +<tr> +<td><p><a name="GSIGNOND-PLUGIN-STATE-SENDING-DATA:CAPS"></a><span class="term"><code class="literal">GSIGNOND_PLUGIN_STATE_SENDING_DATA</code></span></p></td> +<td>Sending data to remote server +</td> +</tr> +<tr> +<td><p><a name="GSIGNOND-PLUGIN-STATE-WAITING:CAPS"></a><span class="term"><code class="literal">GSIGNOND_PLUGIN_STATE_WAITING</code></span></p></td> +<td>Waiting for reply from remote server +</td> +</tr> +<tr> +<td><p><a name="GSIGNOND-PLUGIN-STATE-USER-PENDING:CAPS"></a><span class="term"><code class="literal">GSIGNOND_PLUGIN_STATE_USER_PENDING</code></span></p></td> +<td>Waiting for response from user +</td> +</tr> +<tr> +<td><p><a name="GSIGNOND-PLUGIN-STATE-REFRESHING:CAPS"></a><span class="term"><code class="literal">GSIGNOND_PLUGIN_STATE_REFRESHING</code></span></p></td> +<td>Refreshing ui request +</td> +</tr> +<tr> +<td><p><a name="GSIGNOND-PLUGIN-STATE-PROCESS-PENDING:CAPS"></a><span class="term"><code class="literal">GSIGNOND_PLUGIN_STATE_PROCESS_PENDING</code></span></p></td> +<td>Request has been queued +</td> +</tr> +<tr> +<td><p><a name="GSIGNOND-PLUGIN-STATE-STARTED:CAPS"></a><span class="term"><code class="literal">GSIGNOND_PLUGIN_STATE_STARTED</code></span></p></td> +<td>Request has been dequeued +</td> +</tr> +<tr> +<td><p><a name="GSIGNOND-PLUGIN-STATE-CANCELING:CAPS"></a><span class="term"><code class="literal">GSIGNOND_PLUGIN_STATE_CANCELING</code></span></p></td> +<td>Canceling current process +</td> +</tr> +<tr> +<td><p><a name="GSIGNOND-PLUGIN-STATE-DONE:CAPS"></a><span class="term"><code class="literal">GSIGNOND_PLUGIN_STATE_DONE</code></span></p></td> +<td>Process is finished +</td> +</tr> +<tr> +<td><p><a name="GSIGNOND-PLUGIN-STATE-HOLDING:CAPS"></a><span class="term"><code class="literal">GSIGNOND_PLUGIN_STATE_HOLDING</code></span></p></td> +<td>Holding long non-expired token +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-plugin-cancel"></a><h3>gsignond_plugin_cancel ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> gsignond_plugin_cancel (<em class="parameter"><code><span class="type">GSignondPlugin</span> *self</code></em>);</pre> +<p> +This method cancels an ongoing authentication session. The plugin implementations +should issue a <span class="type">"error"</span> signal with <a class="link" href="gsignond-Errors.html#GSIGNOND-ERROR-SESSION-CANCELED:CAPS"><span class="type">GSIGNOND_ERROR_SESSION_CANCELED</span></a> +error, and prepare for a new authentication session. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>plugin instance</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-plugin-error"></a><h3>gsignond_plugin_error ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> gsignond_plugin_error (<em class="parameter"><code><span class="type">GSignondPlugin</span> *self</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> *error</code></em>);</pre> +<p> +Plugin implementations should use this to issue <span class="type">"error"</span> +signal. This method should not be used otherwise. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>plugin instance</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td> +<td>the error</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-plugin-refresh"></a><h3>gsignond_plugin_refresh ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> gsignond_plugin_refresh (<em class="parameter"><code><span class="type">GSignondPlugin</span> *self</code></em>, + <em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *ui_data</code></em>);</pre> +<p> +This method asks the plugin to refresh the UI. The plugin responds with +<span class="type">"refreshed"</span> signal. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>plugin instance</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>ui_data</code></em> :</span></p></td> +<td>UI refresh parameters</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-plugin-refreshed"></a><h3>gsignond_plugin_refreshed ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> gsignond_plugin_refreshed (<em class="parameter"><code><span class="type">GSignondPlugin</span> *self</code></em>, + <em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *ui_data</code></em>);</pre> +<p> +Plugin implementations should use this to issue <span class="type">"refreshed"</span> +signal. This method should not be used otherwise. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>plugin instance</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>ui_data</code></em> :</span></p></td> +<td>UI data</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-plugin-request"></a><h3>gsignond_plugin_request ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> gsignond_plugin_request (<em class="parameter"><code><span class="type">GSignondPlugin</span> *self</code></em>, + <em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *session_data</code></em>);</pre> +<p> +This method provides the plugin with additional parameters for the session +after the plugin has asked for it via <span class="type">"response"</span> signal. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>plugin instance</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>session_data</code></em> :</span></p></td> +<td>additional parameters for the session</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-plugin-request-initial"></a><h3>gsignond_plugin_request_initial ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> gsignond_plugin_request_initial (<em class="parameter"><code><span class="type">GSignondPlugin</span> *self</code></em>, + <em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *session_data</code></em>, + <em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *identity_method_cache</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *mechanism</code></em>);</pre> +<p> +This method starts a new authentication session. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>plugin instance</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>session_data</code></em> :</span></p></td> +<td>parameters for the session</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>identity_method_cache</code></em> :</span></p></td> +<td>data from persistent storage, saved previously via +<span class="type">"store"</span> signal</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>mechanism</code></em> :</span></p></td> +<td>mechanism to use for the authentication</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-plugin-response"></a><h3>gsignond_plugin_response ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> gsignond_plugin_response (<em class="parameter"><code><span class="type">GSignondPlugin</span> *self</code></em>, + <em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *session_data</code></em>);</pre> +<p> +Plugin implementations should use this to issue <span class="type">"response"</span> +signal. This method should not be used otherwise. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>plugin instance</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>session_data</code></em> :</span></p></td> +<td>session data</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-plugin-response-final"></a><h3>gsignond_plugin_response_final ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> gsignond_plugin_response_final (<em class="parameter"><code><span class="type">GSignondPlugin</span> *self</code></em>, + <em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *session_data</code></em>);</pre> +<p> +Plugin implementations should use this to issue <span class="type">"response-final"</span> +signal. This method should not be used otherwise. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>plugin instance</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>session_data</code></em> :</span></p></td> +<td>session data</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-plugin-status-changed"></a><h3>gsignond_plugin_status_changed ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> gsignond_plugin_status_changed (<em class="parameter"><code><span class="type">GSignondPlugin</span> *self</code></em>, + <em class="parameter"><code><a class="link" href="gsignond-GSignondPlugin.html#GSignondPluginState" title="enum GSignondPluginState"><span class="type">GSignondPluginState</span></a> state</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *message</code></em>);</pre> +<p> +Plugin implementations should use this to issue <span class="type">"status-changed"</span> +signal. This method should not be used otherwise. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>plugin instance</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td> +<td>the new state</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td> +<td>the message</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-plugin-store"></a><h3>gsignond_plugin_store ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> gsignond_plugin_store (<em class="parameter"><code><span class="type">GSignondPlugin</span> *self</code></em>, + <em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *identity_method_cache</code></em>);</pre> +<p> +Plugin implementations should use this to issue <span class="type">"store"</span> +signal. This method should not be used otherwise. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>plugin instance</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>identity_method_cache</code></em> :</span></p></td> +<td>data to store</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-plugin-user-action-finished"></a><h3>gsignond_plugin_user_action_finished ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> gsignond_plugin_user_action_finished + (<em class="parameter"><code><span class="type">GSignondPlugin</span> *self</code></em>, + <em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *ui_data</code></em>);</pre> +<p> +This method provides the plugin with the results of UI interaction +after the plugin has asked for it via <span class="type">"user-action-required"</span> signal. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>plugin instance</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>ui_data</code></em> :</span></p></td> +<td>results of UI interaction</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-plugin-user-action-required"></a><h3>gsignond_plugin_user_action_required ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> gsignond_plugin_user_action_required + (<em class="parameter"><code><span class="type">GSignondPlugin</span> *self</code></em>, + <em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *ui_data</code></em>);</pre> +<p> +Plugin implementations should use this to issue <span class="type">"user-action-required"</span> +signal. This method should not be used otherwise. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>plugin instance</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>ui_data</code></em> :</span></p></td> +<td>UI data</td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.19.1</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/html/gsignond-GSignondSecurityContext.html b/docs/html/gsignond-GSignondSecurityContext.html new file mode 100644 index 0000000..3fffcef --- /dev/null +++ b/docs/html/gsignond-GSignondSecurityContext.html @@ -0,0 +1,550 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GSignondSecurityContext</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="gsignond API Reference Manual"> +<link rel="up" href="ch05.html" title="GSignond API for writing platform adaptation extensions"> +<link rel="prev" href="GSignondAccessControlManager.html" title="GSignondAccessControlManager"> +<link rel="next" href="GSignondStorageManager.html" title="GSignondStorageManager"> +<meta name="generator" content="GTK-Doc V1.19.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle"> +<td width="100%" align="left"> +<a href="#" class="shortcut">Top</a> +  | + <a href="#gsignond-GSignondSecurityContext.description" class="shortcut">Description</a> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="ch05.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="GSignondAccessControlManager.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="GSignondStorageManager.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="gsignond-GSignondSecurityContext"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="gsignond-GSignondSecurityContext.top_of_page"></a>GSignondSecurityContext</span></h2> +<p>GSignondSecurityContext — security context descriptor used in access control checks</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="gsignond-GSignondSecurityContext.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis"> +#include <gsignond/gsignond-security-context.h> + + <a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext">GSignondSecurityContext</a>; +typedef <a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContextList" title="GSignondSecurityContextList">GSignondSecurityContextList</a>; +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gsignond-GSignondSecurityContext.html#gsignond-security-context-check" title="gsignond_security_context_check ()">gsignond_security_context_check</a> (<em class="parameter"><code>const <a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a> *reference</code></em>, + <em class="parameter"><code>const <a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a> *test</code></em>); +<span class="returnvalue">int</span> <a class="link" href="gsignond-GSignondSecurityContext.html#gsignond-security-context-compare" title="gsignond_security_context_compare ()">gsignond_security_context_compare</a> (<em class="parameter"><code>const <a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a> *ctx1</code></em>, + <em class="parameter"><code>const <a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a> *ctx2</code></em>); +<a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="returnvalue">GSignondSecurityContext</span></a> * <a class="link" href="gsignond-GSignondSecurityContext.html#gsignond-security-context-copy" title="gsignond_security_context_copy ()">gsignond_security_context_copy</a> + (<em class="parameter"><code>const <a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a> *src_ctx</code></em>); +<span class="returnvalue">void</span> <a class="link" href="gsignond-GSignondSecurityContext.html#gsignond-security-context-free" title="gsignond_security_context_free ()">gsignond_security_context_free</a> (<em class="parameter"><code><a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a> *ctx</code></em>); +<a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="returnvalue">GSignondSecurityContext</span></a> * <a class="link" href="gsignond-GSignondSecurityContext.html#gsignond-security-context-from-variant" title="gsignond_security_context_from_variant ()">gsignond_security_context_from_variant</a> + (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *variant</code></em>); +const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="gsignond-GSignondSecurityContext.html#gsignond-security-context-get-application-context" title="gsignond_security_context_get_application_context ()">gsignond_security_context_get_application_context</a> + (<em class="parameter"><code>const <a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a> *ctx</code></em>); +const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="gsignond-GSignondSecurityContext.html#gsignond-security-context-get-system-context" title="gsignond_security_context_get_system_context ()">gsignond_security_context_get_system_context</a> + (<em class="parameter"><code>const <a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a> *ctx</code></em>); +<a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContextList" title="GSignondSecurityContextList"><span class="returnvalue">GSignondSecurityContextList</span></a> * <a class="link" href="gsignond-GSignondSecurityContext.html#gsignond-security-context-list-copy" title="gsignond_security_context_list_copy ()">gsignond_security_context_list_copy</a> + (<em class="parameter"><code>const <a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContextList" title="GSignondSecurityContextList"><span class="type">GSignondSecurityContextList</span></a> *src_list</code></em>); +<span class="returnvalue">void</span> <a class="link" href="gsignond-GSignondSecurityContext.html#gsignond-security-context-list-free" title="gsignond_security_context_list_free ()">gsignond_security_context_list_free</a> (<em class="parameter"><code><a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContextList" title="GSignondSecurityContextList"><span class="type">GSignondSecurityContextList</span></a> *seclist</code></em>); +<a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContextList" title="GSignondSecurityContextList"><span class="returnvalue">GSignondSecurityContextList</span></a> * <a class="link" href="gsignond-GSignondSecurityContext.html#gsignond-security-context-list-from-variant" title="gsignond_security_context_list_from_variant ()">gsignond_security_context_list_from_variant</a> + (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *variant</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="returnvalue">GVariant</span></a> * <a class="link" href="gsignond-GSignondSecurityContext.html#gsignond-security-context-list-to-variant" title="gsignond_security_context_list_to_variant ()">gsignond_security_context_list_to_variant</a> + (<em class="parameter"><code>const <a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContextList" title="GSignondSecurityContextList"><span class="type">GSignondSecurityContextList</span></a> *list</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gsignond-GSignondSecurityContext.html#gsignond-security-context-match" title="gsignond_security_context_match ()">gsignond_security_context_match</a> (<em class="parameter"><code>const <a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a> *ctx1</code></em>, + <em class="parameter"><code>const <a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a> *ctx2</code></em>); +<a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="returnvalue">GSignondSecurityContext</span></a> * <a class="link" href="gsignond-GSignondSecurityContext.html#gsignond-security-context-new" title="gsignond_security_context_new ()">gsignond_security_context_new</a> (); +<a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="returnvalue">GSignondSecurityContext</span></a> * <a class="link" href="gsignond-GSignondSecurityContext.html#gsignond-security-context-new-from-values" title="gsignond_security_context_new_from_values ()">gsignond_security_context_new_from_values</a> + (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *system_context</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *application_context</code></em>); +<span class="returnvalue">void</span> <a class="link" href="gsignond-GSignondSecurityContext.html#gsignond-security-context-set-application-context" title="gsignond_security_context_set_application_context ()">gsignond_security_context_set_application_context</a> + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a> *ctx</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *application_context</code></em>); +<span class="returnvalue">void</span> <a class="link" href="gsignond-GSignondSecurityContext.html#gsignond-security-context-set-system-context" title="gsignond_security_context_set_system_context ()">gsignond_security_context_set_system_context</a> + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a> *ctx</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *system_context</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="returnvalue">GVariant</span></a> * <a class="link" href="gsignond-GSignondSecurityContext.html#gsignond-security-context-to-variant" title="gsignond_security_context_to_variant ()">gsignond_security_context_to_variant</a> + (<em class="parameter"><code>const <a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a> *ctx</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="gsignond-GSignondSecurityContext.description"></a><h2>Description</h2> +<p> +Security context is a string tuple of system context and application context. +</p> +<p> +System context can be a binary path, SMACK-label, or MSSF token. +</p> +<p> +Application context identifies a script or a webpage within an application, +and it's used for providing access control to runtime environments (when making an access +control decision requires not only a binary identifier, but also information +about what the binary is doing). +</p> +<p> +When an application is trying to access the gSSO service, the system context +is determined by a specific <a class="link" href="GSignondAccessControlManager.html" title="GSignondAccessControlManager"><span class="type">GSignondAccessControlManager</span></a> instance using +system services of a specific platform. Application context is set by the +application itself. Then both contexts are used by <a class="link" href="GSignondAccessControlManager.html" title="GSignondAccessControlManager"><span class="type">GSignondAccessControlManager</span></a> +to perform an access control check. +</p> +</div> +<div class="refsect1"> +<a name="gsignond-GSignondSecurityContext.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GSignondSecurityContext"></a><h3>GSignondSecurityContext</h3> +<pre class="programlisting">typedef struct { + gchar *sys_ctx; + gchar *app_ctx; +} GSignondSecurityContext; +</pre> +<p> +Security context descriptor used for access control checks. System context +and application context can contain a wildcard match "*" which has special +meaning in <a class="link" href="gsignond-GSignondSecurityContext.html#gsignond-security-context-match" title="gsignond_security_context_match ()"><code class="function">gsignond_security_context_match()</code></a> and +<a class="link" href="gsignond-GSignondSecurityContext.html#gsignond-security-context-check" title="gsignond_security_context_check ()"><code class="function">gsignond_security_context_check()</code></a>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GSignondSecurityContext.sys-ctx"></a>sys_ctx</code></em>;</span></p></td> +<td>system context</td> +</tr> +<tr> +<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GSignondSecurityContext.app-ctx"></a>app_ctx</code></em>;</span></p></td> +<td>application context</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="GSignondSecurityContextList"></a><h3>GSignondSecurityContextList</h3> +<pre class="programlisting">typedef GList GSignondSecurityContextList; +</pre> +<p> +GList of <a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a> items. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-security-context-check"></a><h3>gsignond_security_context_check ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gsignond_security_context_check (<em class="parameter"><code>const <a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a> *reference</code></em>, + <em class="parameter"><code>const <a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a> *test</code></em>);</pre> +<p> +Check if <em class="parameter"><code>test</code></em> is covered by <em class="parameter"><code>reference</code></em>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>reference</code></em> :</span></p></td> +<td>reference security context item to check against.</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>test</code></em> :</span></p></td> +<td>security context item to be checked.</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>TRUE if contexts are equal or the <em class="parameter"><code>reference</code></em> has a wildcard +system context, or if system contexts are equal and <em class="parameter"><code>reference</code></em> has a wildcard +application context, otherwise FALSE. If either or both contexts are NULL, +FALSE is returned.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-security-context-compare"></a><h3>gsignond_security_context_compare ()</h3> +<pre class="programlisting"><span class="returnvalue">int</span> gsignond_security_context_compare (<em class="parameter"><code>const <a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a> *ctx1</code></em>, + <em class="parameter"><code>const <a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a> *ctx2</code></em>);</pre> +<p> +Compare two <a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a> items in a similar way to <code class="function">strcmp()</code>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>ctx1</code></em> :</span></p></td> +<td>first item to compare.</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>ctx2</code></em> :</span></p></td> +<td>second item to compare.</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>negative if ctx1 < ctx2, 0 if ctx1 == ctx2 and positive if ctx1 > ctx2.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-security-context-copy"></a><h3>gsignond_security_context_copy ()</h3> +<pre class="programlisting"><a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="returnvalue">GSignondSecurityContext</span></a> * gsignond_security_context_copy + (<em class="parameter"><code>const <a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a> *src_ctx</code></em>);</pre> +<p> +Copies a security context item. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>src_ctx</code></em> :</span></p></td> +<td>source security context to copy.</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a copy of the <a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a> item. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-security-context-free"></a><h3>gsignond_security_context_free ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> gsignond_security_context_free (<em class="parameter"><code><a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a> *ctx</code></em>);</pre> +<p> +Frees a security context item. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><em class="parameter"><code>ctx</code></em> :</span></p></td> +<td> +<a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a> to be freed.</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-security-context-from-variant"></a><h3>gsignond_security_context_from_variant ()</h3> +<pre class="programlisting"><a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="returnvalue">GSignondSecurityContext</span></a> * gsignond_security_context_from_variant + (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *variant</code></em>);</pre> +<p> +Builds a <a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a> item from a GVariant of type "(ss)". +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>variant</code></em> :</span></p></td> +<td>GVariant item with a <a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a> construct.</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a> item. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-security-context-get-application-context"></a><h3>gsignond_security_context_get_application_context ()</h3> +<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gsignond_security_context_get_application_context + (<em class="parameter"><code>const <a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a> *ctx</code></em>);</pre> +<p> +Get the application context part of +the <a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>ctx</code></em> :</span></p></td> +<td> +<a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a> item.</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>application context. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-security-context-get-system-context"></a><h3>gsignond_security_context_get_system_context ()</h3> +<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gsignond_security_context_get_system_context + (<em class="parameter"><code>const <a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a> *ctx</code></em>);</pre> +<p> +Get the system context partof the +<a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>ctx</code></em> :</span></p></td> +<td> +<a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a> item.</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>system context. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-security-context-list-copy"></a><h3>gsignond_security_context_list_copy ()</h3> +<pre class="programlisting"><a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContextList" title="GSignondSecurityContextList"><span class="returnvalue">GSignondSecurityContextList</span></a> * gsignond_security_context_list_copy + (<em class="parameter"><code>const <a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContextList" title="GSignondSecurityContextList"><span class="type">GSignondSecurityContextList</span></a> *src_list</code></em>);</pre> +<p> +Copies a GList of <a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a> items. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>src_list</code></em> :</span></p></td> +<td>source <a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContextList" title="GSignondSecurityContextList"><span class="type">GSignondSecurityContextList</span></a>.</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContextList" title="GSignondSecurityContextList"><span class="type">GSignondSecurityContextList</span></a> item. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-security-context-list-free"></a><h3>gsignond_security_context_list_free ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> gsignond_security_context_list_free (<em class="parameter"><code><a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContextList" title="GSignondSecurityContextList"><span class="type">GSignondSecurityContextList</span></a> *seclist</code></em>);</pre> +<p> +Frees all items and the GList of <a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><em class="parameter"><code>seclist</code></em> :</span></p></td> +<td> +<a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContextList" title="GSignondSecurityContextList"><span class="type">GSignondSecurityContextList</span></a> item. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span> +</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-security-context-list-from-variant"></a><h3>gsignond_security_context_list_from_variant ()</h3> +<pre class="programlisting"><a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContextList" title="GSignondSecurityContextList"><span class="returnvalue">GSignondSecurityContextList</span></a> * gsignond_security_context_list_from_variant + (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *variant</code></em>);</pre> +<p> +Builds a GList of <a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a> items from a GVariant of type +"a(ss)". +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>variant</code></em> :</span></p></td> +<td>GVariant item with a list of security context tuples.</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContextList" title="GSignondSecurityContextList"><span class="type">GSignondSecurityContextList</span></a> item. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-security-context-list-to-variant"></a><h3>gsignond_security_context_list_to_variant ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="returnvalue">GVariant</span></a> * gsignond_security_context_list_to_variant + (<em class="parameter"><code>const <a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContextList" title="GSignondSecurityContextList"><span class="type">GSignondSecurityContextList</span></a> *list</code></em>);</pre> +<p> +Builds a GVariant of type "a(ss)" from a GList of <a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a> +items. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td> +<td> +<a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContextList" title="GSignondSecurityContextList"><span class="type">GSignondSecurityContextList</span></a> item.</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>GVariant construct of a <a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContextList" title="GSignondSecurityContextList"><span class="type">GSignondSecurityContextList</span></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-security-context-match"></a><h3>gsignond_security_context_match ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gsignond_security_context_match (<em class="parameter"><code>const <a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a> *ctx1</code></em>, + <em class="parameter"><code>const <a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a> *ctx2</code></em>);</pre> +<p> +Compare two <a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a> items match. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>ctx1</code></em> :</span></p></td> +<td>first item to compare.</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>ctx2</code></em> :</span></p></td> +<td>second item to compare.</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>TRUE if contexts are equal or if either side has a wildcard match for +system context, or if system contexts are equal and either side has a wildcard +match for the app context, +otherwise FALSE. Two NULL contexts match.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-security-context-new"></a><h3>gsignond_security_context_new ()</h3> +<pre class="programlisting"><a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="returnvalue">GSignondSecurityContext</span></a> * gsignond_security_context_new ();</pre> +<p> +Allocates a new security context item. System and app context are empty strings. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>allocated <a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span> +</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-security-context-new-from-values"></a><h3>gsignond_security_context_new_from_values ()</h3> +<pre class="programlisting"><a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="returnvalue">GSignondSecurityContext</span></a> * gsignond_security_context_new_from_values + (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *system_context</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *application_context</code></em>);</pre> +<p> +Allocates and initializes a new security context item. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>system_context</code></em> :</span></p></td> +<td>system security context</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>application_context</code></em> :</span></p></td> +<td>application security context</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>allocated <a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-security-context-set-application-context"></a><h3>gsignond_security_context_set_application_context ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> gsignond_security_context_set_application_context + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a> *ctx</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *application_context</code></em>);</pre> +<p> +Sets the application context part of +the <a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>ctx</code></em> :</span></p></td> +<td> +<a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a> item.</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>application_context</code></em> :</span></p></td> +<td>application security context.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-security-context-set-system-context"></a><h3>gsignond_security_context_set_system_context ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> gsignond_security_context_set_system_context + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a> *ctx</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *system_context</code></em>);</pre> +<p> +Sets the system context part of the +<a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>ctx</code></em> :</span></p></td> +<td> +<a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a> item.</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>system_context</code></em> :</span></p></td> +<td>system security context.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-security-context-to-variant"></a><h3>gsignond_security_context_to_variant ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="returnvalue">GVariant</span></a> * gsignond_security_context_to_variant + (<em class="parameter"><code>const <a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a> *ctx</code></em>);</pre> +<p> +Build a GVariant of type "(ss)" from a <a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a> item. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>ctx</code></em> :</span></p></td> +<td> +<a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a> item.</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>GVariant construct of a <a class="link" href="gsignond-GSignondSecurityContext.html#GSignondSecurityContext" title="GSignondSecurityContext"><span class="type">GSignondSecurityContext</span></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span> +</td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.19.1</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/html/gsignond-GSignondSessionData.html b/docs/html/gsignond-GSignondSessionData.html new file mode 100644 index 0000000..5682ef3 --- /dev/null +++ b/docs/html/gsignond-GSignondSessionData.html @@ -0,0 +1,582 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GSignondSessionData</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="gsignond API Reference Manual"> +<link rel="up" href="ch03.html" title="GSignond API for writing authentication plugins"> +<link rel="prev" href="gsignond-GSignondDictionary.html" title="GSignondDictionary"> +<link rel="next" href="gsignond-GSignondSignonuiData.html" title="GSignondSignonuiData"> +<meta name="generator" content="GTK-Doc V1.19.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle"> +<td width="100%" align="left"> +<a href="#" class="shortcut">Top</a> +  | + <a href="#gsignond-GSignondSessionData.description" class="shortcut">Description</a> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="ch03.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="gsignond-GSignondDictionary.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="gsignond-GSignondSignonuiData.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="gsignond-GSignondSessionData"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="gsignond-GSignondSessionData.top_of_page"></a>GSignondSessionData</span></h2> +<p>GSignondSessionData — definitions for authentication session parameters</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="gsignond-GSignondSessionData.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis"> +#include <gsignond/gsignond-session-data.h> + +typedef <a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData">GSignondSessionData</a>; +enum <a class="link" href="gsignond-GSignondSessionData.html#GSignondUiPolicy" title="enum GSignondUiPolicy">GSignondUiPolicy</a>; +const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-get-caption" title="gsignond_session_data_get_caption ()">gsignond_session_data_get_caption</a> (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>); +const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-get-network-proxy" title="gsignond_session_data_get_network_proxy ()">gsignond_session_data_get_network_proxy</a> + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-get-network-timeout" title="gsignond_session_data_get_network_timeout ()">gsignond_session_data_get_network_timeout</a> + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>, + <em class="parameter"><code><span class="type">guint32</span> *network_timeout</code></em>); +const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-get-realm" title="gsignond_session_data_get_realm ()">gsignond_session_data_get_realm</a> (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-get-renew-token" title="gsignond_session_data_get_renew_token ()">gsignond_session_data_get_renew_token</a> + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *renew_token</code></em>); +const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-get-secret" title="gsignond_session_data_get_secret ()">gsignond_session_data_get_secret</a> (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-get-ui-policy" title="gsignond_session_data_get_ui_policy ()">gsignond_session_data_get_ui_policy</a> (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>, + <em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondUiPolicy" title="enum GSignondUiPolicy"><span class="type">GSignondUiPolicy</span></a> *ui_policy</code></em>); +const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-get-username" title="gsignond_session_data_get_username ()">gsignond_session_data_get_username</a> (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-get-window-id" title="gsignond_session_data_get_window_id ()">gsignond_session_data_get_window_id</a> (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>, + <em class="parameter"><code><span class="type">guint32</span> *window_id</code></em>); +<span class="returnvalue">void</span> <a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-set-caption" title="gsignond_session_data_set_caption ()">gsignond_session_data_set_caption</a> (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *caption</code></em>); +<span class="returnvalue">void</span> <a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-set-network-proxy" title="gsignond_session_data_set_network_proxy ()">gsignond_session_data_set_network_proxy</a> + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *network_proxy</code></em>); +<span class="returnvalue">void</span> <a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-set-network-timeout" title="gsignond_session_data_set_network_timeout ()">gsignond_session_data_set_network_timeout</a> + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>, + <em class="parameter"><code><span class="type">guint32</span> network_timeout</code></em>); +<span class="returnvalue">void</span> <a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-set-realm" title="gsignond_session_data_set_realm ()">gsignond_session_data_set_realm</a> (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *realm</code></em>); +<span class="returnvalue">void</span> <a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-set-renew-token" title="gsignond_session_data_set_renew_token ()">gsignond_session_data_set_renew_token</a> + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> renew_token</code></em>); +<span class="returnvalue">void</span> <a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-set-secret" title="gsignond_session_data_set_secret ()">gsignond_session_data_set_secret</a> (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *secret</code></em>); +<span class="returnvalue">void</span> <a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-set-ui-policy" title="gsignond_session_data_set_ui_policy ()">gsignond_session_data_set_ui_policy</a> (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>, + <em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondUiPolicy" title="enum GSignondUiPolicy"><span class="type">GSignondUiPolicy</span></a> ui_policy</code></em>); +<span class="returnvalue">void</span> <a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-set-username" title="gsignond_session_data_set_username ()">gsignond_session_data_set_username</a> (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *username</code></em>); +<span class="returnvalue">void</span> <a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-set-window-id" title="gsignond_session_data_set_window_id ()">gsignond_session_data_set_window_id</a> (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>, + <em class="parameter"><code><span class="type">guint32</span> window_id</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="gsignond-GSignondSessionData.description"></a><h2>Description</h2> +<p> +This file provides commonly used parameters for authentication sessions. +For each of those a getter and setter is defined, on <a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> +container. The plugins may not use all of these parameters, and they commonly +require additional, custom parameters which are set using <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> +setters with explicit key string. +</p> +</div> +<div class="refsect1"> +<a name="gsignond-GSignondSessionData.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GSignondSessionData"></a><h3>GSignondSessionData</h3> +<pre class="programlisting">typedef GSignondDictionary GSignondSessionData; +</pre> +<p> +<a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> is simply a typedef for <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a>, which +means the developers may also freely use methods associated with that structure, +in particular for creating a <a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> object with +<a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-new" title="gsignond_dictionary_new ()"><code class="function">gsignond_dictionary_new()</code></a>. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="GSignondUiPolicy"></a><h3>enum GSignondUiPolicy</h3> +<pre class="programlisting">typedef enum { + GSIGNOND_UI_POLICY_DEFAULT = 0, + GSIGNOND_UI_POLICY_REQUEST_PASSWORD, + GSIGNOND_UI_POLICY_NO_USER_INTERACTION, + GSIGNOND_UI_POLICY_VALIDATION +} GSignondUiPolicy; +</pre> +<p> +Policy setting to define how plugins should handle interaction with the user. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><a name="GSIGNOND-UI-POLICY-DEFAULT:CAPS"></a><span class="term"><code class="literal">GSIGNOND_UI_POLICY_DEFAULT</code></span></p></td> +<td>use a default user interaction scenario +</td> +</tr> +<tr> +<td><p><a name="GSIGNOND-UI-POLICY-REQUEST-PASSWORD:CAPS"></a><span class="term"><code class="literal">GSIGNOND_UI_POLICY_REQUEST_PASSWORD</code></span></p></td> +<td>force an authorization request from the user; +any cached access tokens should be discarded by the plugin. +</td> +</tr> +<tr> +<td><p><a name="GSIGNOND-UI-POLICY-NO-USER-INTERACTION:CAPS"></a><span class="term"><code class="literal">GSIGNOND_UI_POLICY_NO_USER_INTERACTION</code></span></p></td> +<td>force no interaction with the user +</td> +</tr> +<tr> +<td><p><a name="GSIGNOND-UI-POLICY-VALIDATION:CAPS"></a><span class="term"><code class="literal">GSIGNOND_UI_POLICY_VALIDATION</code></span></p></td> +<td>interaction with the user is only allowed +for validation captchas and similar security measures +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-session-data-get-caption"></a><h3>gsignond_session_data_get_caption ()</h3> +<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gsignond_session_data_get_caption (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>);</pre> +<p> +A getter for a caption associated with the authentication session. +Caption tells the user which application/credentials/provider is requestion +authentication. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> +<td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>(transfer none)</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-session-data-get-network-proxy"></a><h3>gsignond_session_data_get_network_proxy ()</h3> +<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gsignond_session_data_get_network_proxy + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>);</pre> +<p> +A getter for a network proxy setting associated with the authentication session. +If this property is not set, the default system proxy settings should be used. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> +<td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>(transfer none)</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-session-data-get-network-timeout"></a><h3>gsignond_session_data_get_network_timeout ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gsignond_session_data_get_network_timeout + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>, + <em class="parameter"><code><span class="type">guint32</span> *network_timeout</code></em>);</pre> +<p> +A getter for a network timeout setting associated with the authentication session. +This can be used to change the default timeout in case of unresponsive servers. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> +<td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>network_timeout</code></em> :</span></p></td> +<td>the value for the parameter is written here</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>whether the key-value pair exists in the <em class="parameter"><code>data</code></em> dictionary or not.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-session-data-get-realm"></a><h3>gsignond_session_data_get_realm ()</h3> +<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gsignond_session_data_get_realm (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>);</pre> +<p> +A getter for a realm associated with the authentication session. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> +<td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>(transfer none)</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-session-data-get-renew-token"></a><h3>gsignond_session_data_get_renew_token ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gsignond_session_data_get_renew_token + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *renew_token</code></em>);</pre> +<p> +A getter for a renew token property associated with the authentication session. +This property tells the plugin to discard any cached tokens and start +the authentication process anew. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> +<td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>renew_token</code></em> :</span></p></td> +<td>the value for the parameter is written here</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>whether the key-value pair exists in the <em class="parameter"><code>data</code></em> dictionary or not.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-session-data-get-secret"></a><h3>gsignond_session_data_get_secret ()</h3> +<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gsignond_session_data_get_secret (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>);</pre> +<p> +A getter for a secret (e.g. a password) associated with the authentication session. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> +<td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>(transfer none)</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-session-data-get-ui-policy"></a><h3>gsignond_session_data_get_ui_policy ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gsignond_session_data_get_ui_policy (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>, + <em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondUiPolicy" title="enum GSignondUiPolicy"><span class="type">GSignondUiPolicy</span></a> *ui_policy</code></em>);</pre> +<p> +A getter for UI policy setting associated with the authentication session. +The UI policy indicates how the authentication plugin should interact with the user. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> +<td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>ui_policy</code></em> :</span></p></td> +<td>the value for the parameter is written here</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>whether the key-value pair exists in the <em class="parameter"><code>data</code></em> dictionary or not.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-session-data-get-username"></a><h3>gsignond_session_data_get_username ()</h3> +<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gsignond_session_data_get_username (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>);</pre> +<p> +A getter for a username associated with the authentication session. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> +<td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>(transfer none)</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-session-data-get-window-id"></a><h3>gsignond_session_data_get_window_id ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gsignond_session_data_get_window_id (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>, + <em class="parameter"><code><span class="type">guint32</span> *window_id</code></em>);</pre> +<p> +A getter for a window id setting associated with the authentication session. +This can be used to embed the user interaction window produced by the authentication +session into an application window. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> +<td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>window_id</code></em> :</span></p></td> +<td>the value for the parameter is written here</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>whether the key-value pair exists in the <em class="parameter"><code>data</code></em> dictionary or not.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-session-data-set-caption"></a><h3>gsignond_session_data_set_caption ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> gsignond_session_data_set_caption (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *caption</code></em>);</pre> +<p> +A setter for a caption associated with the authentication session. +Caption tells the user which application/credentials/provider is requestion +authentication. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> +<td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>caption</code></em> :</span></p></td> +<td>a caption to set</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-session-data-set-network-proxy"></a><h3>gsignond_session_data_set_network_proxy ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> gsignond_session_data_set_network_proxy + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *network_proxy</code></em>);</pre> +<p> +A setter for a network proxy setting associated with the authentication session. +If this property is not set, the default system proxy settings should be used. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> +<td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>network_proxy</code></em> :</span></p></td> +<td>network proxy to use</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-session-data-set-network-timeout"></a><h3>gsignond_session_data_set_network_timeout ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> gsignond_session_data_set_network_timeout + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>, + <em class="parameter"><code><span class="type">guint32</span> network_timeout</code></em>);</pre> +<p> +A setter for a network timeout setting associated with the authentication session. +This can be used to change the default timeout in case of unresponsive servers. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> +<td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>network_timeout</code></em> :</span></p></td> +<td>network timeout to use</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-session-data-set-realm"></a><h3>gsignond_session_data_set_realm ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> gsignond_session_data_set_realm (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *realm</code></em>);</pre> +<p> +A setter for a realm associated with the authentication session. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> +<td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>realm</code></em> :</span></p></td> +<td>a realm to set</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-session-data-set-renew-token"></a><h3>gsignond_session_data_set_renew_token ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> gsignond_session_data_set_renew_token + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> renew_token</code></em>);</pre> +<p> +A setter for a renew token property associated with the authentication session. +This property tells the plugin to discard any cached tokens and start +the authentication process anew. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> +<td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>renew_token</code></em> :</span></p></td> +<td>whether to renew the token set</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-session-data-set-secret"></a><h3>gsignond_session_data_set_secret ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> gsignond_session_data_set_secret (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *secret</code></em>);</pre> +<p> +A setter for a secret (e.g. a password) associated with the authentication session. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> +<td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>secret</code></em> :</span></p></td> +<td>a secret to set</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-session-data-set-ui-policy"></a><h3>gsignond_session_data_set_ui_policy ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> gsignond_session_data_set_ui_policy (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>, + <em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondUiPolicy" title="enum GSignondUiPolicy"><span class="type">GSignondUiPolicy</span></a> ui_policy</code></em>);</pre> +<p> +A getter for UI policy setting associated with the authentication session. +The UI policy indicates how the authentication plugin should interact with the user. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> +<td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>ui_policy</code></em> :</span></p></td> +<td>ui policy to set</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-session-data-set-username"></a><h3>gsignond_session_data_set_username ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> gsignond_session_data_set_username (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *username</code></em>);</pre> +<p> +A setter for a username associated with the authentication session. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> +<td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>username</code></em> :</span></p></td> +<td>username to set</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-session-data-set-window-id"></a><h3>gsignond_session_data_set_window_id ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> gsignond_session_data_set_window_id (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>, + <em class="parameter"><code><span class="type">guint32</span> window_id</code></em>);</pre> +<p> +A setter for a window id setting associated with the authentication session. +This can be used to embed the user interaction window produced by the authentication +session into an application window. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> +<td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>window_id</code></em> :</span></p></td> +<td>window id to use</td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.19.1</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/html/gsignond-GSignondSignonuiData.html b/docs/html/gsignond-GSignondSignonuiData.html new file mode 100644 index 0000000..75053f5 --- /dev/null +++ b/docs/html/gsignond-GSignondSignonuiData.html @@ -0,0 +1,1160 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GSignondSignonuiData</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="gsignond API Reference Manual"> +<link rel="up" href="ch03.html" title="GSignond API for writing authentication plugins"> +<link rel="prev" href="gsignond-GSignondSessionData.html" title="GSignondSessionData"> +<link rel="next" href="ch04.html" title="Standard in-tree authentication plugins"> +<meta name="generator" content="GTK-Doc V1.19.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle"> +<td width="100%" align="left"> +<a href="#" class="shortcut">Top</a> +  | + <a href="#gsignond-GSignondSignonuiData.description" class="shortcut">Description</a> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="ch03.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="gsignond-GSignondSessionData.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="ch04.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="gsignond-GSignondSignonuiData"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="gsignond-GSignondSignonuiData.top_of_page"></a>GSignondSignonuiData</span></h2> +<p>GSignondSignonuiData — definitions for user interaction parameters</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="gsignond-GSignondSignonuiData.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis"> +#include <gsignond/gsignond-signonui-data.h> + +typedef <a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData">GSignondSignonuiData</a>; +enum <a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiError" title="enum GSignondSignonuiError">GSignondSignonuiError</a>; +const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-captcha-response" title="gsignond_signonui_data_get_captcha_response ()">gsignond_signonui_data_get_captcha_response</a> + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>); +const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-captcha-url" title="gsignond_signonui_data_get_captcha_url ()">gsignond_signonui_data_get_captcha_url</a> + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>); +const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-caption" title="gsignond_signonui_data_get_caption ()">gsignond_signonui_data_get_caption</a> (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-confirm" title="gsignond_signonui_data_get_confirm ()">gsignond_signonui_data_get_confirm</a> (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *confirm</code></em>); +const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-final-url" title="gsignond_signonui_data_get_final_url ()">gsignond_signonui_data_get_final_url</a> + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>); +const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-forgot-password" title="gsignond_signonui_data_get_forgot_password ()">gsignond_signonui_data_get_forgot_password</a> + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>); +const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-forgot-password-url" title="gsignond_signonui_data_get_forgot_password_url ()">gsignond_signonui_data_get_forgot_password_url</a> + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>); +const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-message" title="gsignond_signonui_data_get_message ()">gsignond_signonui_data_get_message</a> (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>); +const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-open-url" title="gsignond_signonui_data_get_open_url ()">gsignond_signonui_data_get_open_url</a> (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>); +const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-password" title="gsignond_signonui_data_get_password ()">gsignond_signonui_data_get_password</a> (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-query-error" title="gsignond_signonui_data_get_query_error ()">gsignond_signonui_data_get_query_error</a> + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>, + <em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiError" title="enum GSignondSignonuiError"><span class="type">GSignondSignonuiError</span></a> *error</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-query-password" title="gsignond_signonui_data_get_query_password ()">gsignond_signonui_data_get_query_password</a> + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *query_password</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-query-username" title="gsignond_signonui_data_get_query_username ()">gsignond_signonui_data_get_query_username</a> + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *query_username</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-remember-password" title="gsignond_signonui_data_get_remember_password ()">gsignond_signonui_data_get_remember_password</a> + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *remember_password</code></em>); +const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-request-id" title="gsignond_signonui_data_get_request_id ()">gsignond_signonui_data_get_request_id</a> + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>); +const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-test-reply" title="gsignond_signonui_data_get_test_reply ()">gsignond_signonui_data_get_test_reply</a> + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>); +const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-title" title="gsignond_signonui_data_get_title ()">gsignond_signonui_data_get_title</a> (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>); +const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-url-response" title="gsignond_signonui_data_get_url_response ()">gsignond_signonui_data_get_url_response</a> + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>); +const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-username" title="gsignond_signonui_data_get_username ()">gsignond_signonui_data_get_username</a> (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>); +<span class="returnvalue">void</span> <a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-captcha-response" title="gsignond_signonui_data_set_captcha_response ()">gsignond_signonui_data_set_captcha_response</a> + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *response</code></em>); +<span class="returnvalue">void</span> <a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-captcha-url" title="gsignond_signonui_data_set_captcha_url ()">gsignond_signonui_data_set_captcha_url</a> + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *url</code></em>); +<span class="returnvalue">void</span> <a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-caption" title="gsignond_signonui_data_set_caption ()">gsignond_signonui_data_set_caption</a> (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *caption</code></em>); +<span class="returnvalue">void</span> <a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-confirm" title="gsignond_signonui_data_set_confirm ()">gsignond_signonui_data_set_confirm</a> (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> confirm</code></em>); +<span class="returnvalue">void</span> <a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-final-url" title="gsignond_signonui_data_set_final_url ()">gsignond_signonui_data_set_final_url</a> + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *url</code></em>); +<span class="returnvalue">void</span> <a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-forgot-password" title="gsignond_signonui_data_set_forgot_password ()">gsignond_signonui_data_set_forgot_password</a> + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *forgot</code></em>); +<span class="returnvalue">void</span> <a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-forgot-password-url" title="gsignond_signonui_data_set_forgot_password_url ()">gsignond_signonui_data_set_forgot_password_url</a> + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *url</code></em>); +<span class="returnvalue">void</span> <a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-message" title="gsignond_signonui_data_set_message ()">gsignond_signonui_data_set_message</a> (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *message</code></em>); +<span class="returnvalue">void</span> <a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-open-url" title="gsignond_signonui_data_set_open_url ()">gsignond_signonui_data_set_open_url</a> (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *url</code></em>); +<span class="returnvalue">void</span> <a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-password" title="gsignond_signonui_data_set_password ()">gsignond_signonui_data_set_password</a> (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *password</code></em>); +<span class="returnvalue">void</span> <a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-query-error" title="gsignond_signonui_data_set_query_error ()">gsignond_signonui_data_set_query_error</a> + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>, + <em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiError" title="enum GSignondSignonuiError"><span class="type">GSignondSignonuiError</span></a> error</code></em>); +<span class="returnvalue">void</span> <a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-query-password" title="gsignond_signonui_data_set_query_password ()">gsignond_signonui_data_set_query_password</a> + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> query</code></em>); +<span class="returnvalue">void</span> <a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-query-username" title="gsignond_signonui_data_set_query_username ()">gsignond_signonui_data_set_query_username</a> + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> query</code></em>); +<span class="returnvalue">void</span> <a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-remember-password" title="gsignond_signonui_data_set_remember_password ()">gsignond_signonui_data_set_remember_password</a> + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> remember</code></em>); +<span class="returnvalue">void</span> <a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-request-id" title="gsignond_signonui_data_set_request_id ()">gsignond_signonui_data_set_request_id</a> + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *id</code></em>); +<span class="returnvalue">void</span> <a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-test-reply" title="gsignond_signonui_data_set_test_reply ()">gsignond_signonui_data_set_test_reply</a> + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *reply</code></em>); +<span class="returnvalue">void</span> <a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-title" title="gsignond_signonui_data_set_title ()">gsignond_signonui_data_set_title</a> (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *title</code></em>); +<span class="returnvalue">void</span> <a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-url-response" title="gsignond_signonui_data_set_url_response ()">gsignond_signonui_data_set_url_response</a> + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *response</code></em>); +<span class="returnvalue">void</span> <a class="link" href="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-username" title="gsignond_signonui_data_set_username ()">gsignond_signonui_data_set_username</a> (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *username</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="gsignond-GSignondSignonuiData.description"></a><h2>Description</h2> +<p> +This file provides commonly used parameters for user interaction during +authentication sessions. +For each of those a getter and setter is defined, on <a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> +container. +</p> +<p> +This container is used in two directions: by plugins to specify the parameters +for user interaction that is then performed by SignonUI component, and by SignonUI +to return the results of that interaction to the plugins. See <span class="type">GSignondPlugin</span> +for the user interaction API from the plugins' perspective. +</p> +<p> +The parameters that are set by the plugin and read by signon UI are captcha url, +caption, confirm, final url, forgot password, forgot password url, message, +open url, password, query password, query username, remember +password, request id, test reply values, title, username. +</p> +<p> +The parameters that are returned by signon UI to the plugin are captcha response, +password, query error code, remember password, url response. +</p> +</div> +<div class="refsect1"> +<a name="gsignond-GSignondSignonuiData.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GSignondSignonuiData"></a><h3>GSignondSignonuiData</h3> +<pre class="programlisting">typedef GSignondDictionary GSignondSignonuiData; +</pre> +<p> +<a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> is simply a typedef for <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a>, which +means the developers may also freely use methods associated with that structure, +in particular for creating a <a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> object with +<a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-new" title="gsignond_dictionary_new ()"><code class="function">gsignond_dictionary_new()</code></a>. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="GSignondSignonuiError"></a><h3>enum GSignondSignonuiError</h3> +<pre class="programlisting">typedef enum { + SIGNONUI_ERROR_NONE = 0, + SIGNONUI_ERROR_GENERAL, + SIGNONUI_ERROR_NO_SIGNONUI, + SIGNONUI_ERROR_BAD_PARAMETERS, + SIGNONUI_ERROR_CANCELED, + SIGNONUI_ERROR_NOT_AVAILABLE, + SIGNONUI_ERROR_BAD_URL, + SIGNONUI_ERROR_BAD_CAPTCHA, + SIGNONUI_ERROR_BAD_CAPTCHA_URL, + SIGNONUI_ERROR_REFRESH_FAILED, + SIGNONUI_ERROR_FORBIDDEN, + SIGNONUI_ERROR_FORGOT_PASSWORD +} GSignondSignonuiError; +</pre> +<p> +This enum defines errors that may happen during user interaction. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><a name="SIGNONUI-ERROR-NONE:CAPS"></a><span class="term"><code class="literal">SIGNONUI_ERROR_NONE</code></span></p></td> +<td>No errors +</td> +</tr> +<tr> +<td><p><a name="SIGNONUI-ERROR-GENERAL:CAPS"></a><span class="term"><code class="literal">SIGNONUI_ERROR_GENERAL</code></span></p></td> +<td>Generic error during interaction +</td> +</tr> +<tr> +<td><p><a name="SIGNONUI-ERROR-NO-SIGNONUI:CAPS"></a><span class="term"><code class="literal">SIGNONUI_ERROR_NO_SIGNONUI</code></span></p></td> +<td>Cannot send request to signon-ui +</td> +</tr> +<tr> +<td><p><a name="SIGNONUI-ERROR-BAD-PARAMETERS:CAPS"></a><span class="term"><code class="literal">SIGNONUI_ERROR_BAD_PARAMETERS</code></span></p></td> +<td>Signon-Ui cannot create dialog based on the given UiSessionData +</td> +</tr> +<tr> +<td><p><a name="SIGNONUI-ERROR-CANCELED:CAPS"></a><span class="term"><code class="literal">SIGNONUI_ERROR_CANCELED</code></span></p></td> +<td>User canceled action. Plugin should not retry automatically after this +</td> +</tr> +<tr> +<td><p><a name="SIGNONUI-ERROR-NOT-AVAILABLE:CAPS"></a><span class="term"><code class="literal">SIGNONUI_ERROR_NOT_AVAILABLE</code></span></p></td> +<td>Requested ui is not available. For example browser cannot be started +</td> +</tr> +<tr> +<td><p><a name="SIGNONUI-ERROR-BAD-URL:CAPS"></a><span class="term"><code class="literal">SIGNONUI_ERROR_BAD_URL</code></span></p></td> +<td>Given url was not valid +</td> +</tr> +<tr> +<td><p><a name="SIGNONUI-ERROR-BAD-CAPTCHA:CAPS"></a><span class="term"><code class="literal">SIGNONUI_ERROR_BAD_CAPTCHA</code></span></p></td> +<td>Given captcha image was not valid +</td> +</tr> +<tr> +<td><p><a name="SIGNONUI-ERROR-BAD-CAPTCHA-URL:CAPS"></a><span class="term"><code class="literal">SIGNONUI_ERROR_BAD_CAPTCHA_URL</code></span></p></td> +<td>Given url for capctha loading was not valid +</td> +</tr> +<tr> +<td><p><a name="SIGNONUI-ERROR-REFRESH-FAILED:CAPS"></a><span class="term"><code class="literal">SIGNONUI_ERROR_REFRESH_FAILED</code></span></p></td> +<td>Refresh failed +</td> +</tr> +<tr> +<td><p><a name="SIGNONUI-ERROR-FORBIDDEN:CAPS"></a><span class="term"><code class="literal">SIGNONUI_ERROR_FORBIDDEN</code></span></p></td> +<td>Showing ui forbidden by ui policy +</td> +</tr> +<tr> +<td><p><a name="SIGNONUI-ERROR-FORGOT-PASSWORD:CAPS"></a><span class="term"><code class="literal">SIGNONUI_ERROR_FORGOT_PASSWORD</code></span></p></td> +<td>User pressed forgot password +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-signonui-data-get-captcha-response"></a><h3>gsignond_signonui_data_get_captcha_response ()</h3> +<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gsignond_signonui_data_get_captcha_response + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>);</pre> +<p> +A getter for the user's response to a captcha query. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> +<td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the string entered by the user in response to a captcha query. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-signonui-data-get-captcha-url"></a><h3>gsignond_signonui_data_get_captcha_url ()</h3> +<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gsignond_signonui_data_get_captcha_url + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>);</pre> +<p> +A getter for the captcha URL. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> +<td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the URL to the captcha image to be verified by user. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-signonui-data-get-caption"></a><h3>gsignond_signonui_data_get_caption ()</h3> +<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gsignond_signonui_data_get_caption (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>);</pre> +<p> +A getter for the caption string. Caption tells the user which +application/credentials/provider is requestion authentication. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> +<td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>(transfer none)</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-signonui-data-get-confirm"></a><h3>gsignond_signonui_data_get_confirm ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gsignond_signonui_data_get_confirm (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *confirm</code></em>);</pre> +<p> +A getter for the confirm mode. In confirm mode the user is asked to enter +an old password (which is compared to the supplied password), and a new password twice +(which is returned). +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> +<td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>confirm</code></em> :</span></p></td> +<td>the value for the property is written here</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>whether this property exists in the <em class="parameter"><code>data</code></em> dictionary or not.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-signonui-data-get-final-url"></a><h3>gsignond_signonui_data_get_final_url ()</h3> +<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gsignond_signonui_data_get_final_url + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>);</pre> +<p> +A getter for the final URL. When the signon UI detects that the user is at +the final URL (possibly with additional query or fragment parameters), it +will close the window and return the full URL via url response property. +This is used by redirection-based authentication, such as OAuth. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> +<td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>(transfer none)</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-signonui-data-get-forgot-password"></a><h3>gsignond_signonui_data_get_forgot_password ()</h3> +<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gsignond_signonui_data_get_forgot_password + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>);</pre> +<p> +A getter for the forgot password string which is shown to the user as a link to +reset the password or remind him of the password. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> +<td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>(transfer none)</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-signonui-data-get-forgot-password-url"></a><h3>gsignond_signonui_data_get_forgot_password_url ()</h3> +<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gsignond_signonui_data_get_forgot_password_url + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>);</pre> +<p> +A getter for the forgot password URL, where the user can reset or request a +reminder of the password. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> +<td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>(transfer none)</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-signonui-data-get-message"></a><h3>gsignond_signonui_data_get_message ()</h3> +<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gsignond_signonui_data_get_message (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>);</pre> +<p> +A getter for the message which is show to the user in the signon UI dialog. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> +<td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>(transfer none)</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-signonui-data-get-open-url"></a><h3>gsignond_signonui_data_get_open_url ()</h3> +<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gsignond_signonui_data_get_open_url (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>);</pre> +<p> +A getter for the URL that should be opened by signon UI. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> +<td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>(transfer none)</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-signonui-data-get-password"></a><h3>gsignond_signonui_data_get_password ()</h3> +<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gsignond_signonui_data_get_password (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>);</pre> +<p> +A getter for the password string. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> +<td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>(transfer none)</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-signonui-data-get-query-error"></a><h3>gsignond_signonui_data_get_query_error ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gsignond_signonui_data_get_query_error + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>, + <em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiError" title="enum GSignondSignonuiError"><span class="type">GSignondSignonuiError</span></a> *error</code></em>);</pre> +<p> +A getter for the UI interaction error. Signon UI sets this to <em class="parameter"><code>SIGNONUI_ERROR_NONE</code></em> if +there were no errors. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> +<td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td> +<td>the error is written here</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>whether this property exists in the <em class="parameter"><code>data</code></em> dictionary or not.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-signonui-data-get-query-password"></a><h3>gsignond_signonui_data_get_query_password ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gsignond_signonui_data_get_query_password + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *query_password</code></em>);</pre> +<p> +A getter for the query password property. It indicates whether the signon UI +should ask the user for a password (and return it in the password property). +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> +<td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>query_password</code></em> :</span></p></td> +<td>the property is written here</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>whether this property exists in the <em class="parameter"><code>data</code></em> dictionary or not.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-signonui-data-get-query-username"></a><h3>gsignond_signonui_data_get_query_username ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gsignond_signonui_data_get_query_username + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *query_username</code></em>);</pre> +<p> +A getter for the query username property. It indicates whether the signon UI +should ask the user for a username (and return it in the username property). +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> +<td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>query_username</code></em> :</span></p></td> +<td>the property is written here</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>whether this property exists in the <em class="parameter"><code>data</code></em> dictionary or not.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-signonui-data-get-remember-password"></a><h3>gsignond_signonui_data_get_remember_password ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gsignond_signonui_data_get_remember_password + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *remember_password</code></em>);</pre> +<p> +A getter for whether the password should be remembered. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> +<td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>remember_password</code></em> :</span></p></td> +<td>the property is written here</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>whether this property exists in the <em class="parameter"><code>data</code></em> dictionary or not.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-signonui-data-get-request-id"></a><h3>gsignond_signonui_data_get_request_id ()</h3> +<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gsignond_signonui_data_get_request_id + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>);</pre> +<p> +A getter for the dialog request id. The id identifies the dialog so that it +can be refreshed or updated. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> +<td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>(transfer none)</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-signonui-data-get-test-reply"></a><h3>gsignond_signonui_data_get_test_reply ()</h3> +<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gsignond_signonui_data_get_test_reply + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>);</pre> +<p> +A getter for the test reply values. It's used only by the signon ui +implementations to test themselves. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> +<td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>(transfer none)</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-signonui-data-get-title"></a><h3>gsignond_signonui_data_get_title ()</h3> +<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gsignond_signonui_data_get_title (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>);</pre> +<p> +A getter for the UI dialog title. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> +<td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>(transfer none)</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-signonui-data-get-url-response"></a><h3>gsignond_signonui_data_get_url_response ()</h3> +<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gsignond_signonui_data_get_url_response + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>);</pre> +<p> +A getter for the response URL. If the final URL was set in the request to the signon UI, and the signon UI +detects that it has been reached, then the full final URL is returned using +this property. This is used by redirection-based authentication such as OAauth. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> +<td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>(transfer none)</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-signonui-data-get-username"></a><h3>gsignond_signonui_data_get_username ()</h3> +<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gsignond_signonui_data_get_username (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>);</pre> +<p> +A getter for the username string. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> +<td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>(transfer none)</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-signonui-data-set-captcha-response"></a><h3>gsignond_signonui_data_set_captcha_response ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> gsignond_signonui_data_set_captcha_response + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *response</code></em>);</pre> +<p> +A setter for the user's response to a captcha query. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> +<td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>response</code></em> :</span></p></td> +<td>the string entered by the user in response to a captcha query.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-signonui-data-set-captcha-url"></a><h3>gsignond_signonui_data_set_captcha_url ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> gsignond_signonui_data_set_captcha_url + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *url</code></em>);</pre> +<p> +A setter for the captcha URL. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> +<td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>url</code></em> :</span></p></td> +<td>the URL to the captcha image to be verified by user</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-signonui-data-set-caption"></a><h3>gsignond_signonui_data_set_caption ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> gsignond_signonui_data_set_caption (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *caption</code></em>);</pre> +<p> +A setter for the caption string. Caption tells the user which +application/credentials/provider is requestion authentication. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> +<td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>caption</code></em> :</span></p></td> +<td>the caption string</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-signonui-data-set-confirm"></a><h3>gsignond_signonui_data_set_confirm ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> gsignond_signonui_data_set_confirm (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> confirm</code></em>);</pre> +<p> +A setter for the confirm mode. In confirm mode the user is asked to enter +an old password (which is compared to the supplied password), and a new password twice +(which is returned). +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> +<td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>confirm</code></em> :</span></p></td> +<td>the value for the property</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-signonui-data-set-final-url"></a><h3>gsignond_signonui_data_set_final_url ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> gsignond_signonui_data_set_final_url + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *url</code></em>);</pre> +<p> +A setter for the final URL. When the signon UI detects that the user is at +the final URL (possibly with additional query or fragment parameters), it +will close the window and return the full URL via url response property. +This is used by redirection-based authentication, such as OAuth. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> +<td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>url</code></em> :</span></p></td> +<td>the final url</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-signonui-data-set-forgot-password"></a><h3>gsignond_signonui_data_set_forgot_password ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> gsignond_signonui_data_set_forgot_password + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *forgot</code></em>);</pre> +<p> +A setter for the forgot password string, which is shown to the user as a link to +reset the password or remind him of the password. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> +<td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>forgot</code></em> :</span></p></td> +<td>the forgot password string</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-signonui-data-set-forgot-password-url"></a><h3>gsignond_signonui_data_set_forgot_password_url ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> gsignond_signonui_data_set_forgot_password_url + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *url</code></em>);</pre> +<p> +A setter for the forgot password URL, where the user can reset or request a +reminder of the password. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> +<td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>url</code></em> :</span></p></td> +<td>the forgot password URL</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-signonui-data-set-message"></a><h3>gsignond_signonui_data_set_message ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> gsignond_signonui_data_set_message (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *message</code></em>);</pre> +<p> +A setter for the message which is show to the user in the signon UI dialog. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> +<td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td> +<td>the message</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-signonui-data-set-open-url"></a><h3>gsignond_signonui_data_set_open_url ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> gsignond_signonui_data_set_open_url (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *url</code></em>);</pre> +<p> +A setter for the URL that should be opened by signon UI. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> +<td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>url</code></em> :</span></p></td> +<td>the url to open</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-signonui-data-set-password"></a><h3>gsignond_signonui_data_set_password ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> gsignond_signonui_data_set_password (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *password</code></em>);</pre> +<p> +A setter for the password string. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> +<td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>password</code></em> :</span></p></td> +<td>the password string</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-signonui-data-set-query-error"></a><h3>gsignond_signonui_data_set_query_error ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> gsignond_signonui_data_set_query_error + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>, + <em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiError" title="enum GSignondSignonuiError"><span class="type">GSignondSignonuiError</span></a> error</code></em>);</pre> +<p> +A setter for the UI interaction error. Signon UI sets this to <em class="parameter"><code>SIGNONUI_ERROR_NONE</code></em> if +there were no errors. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> +<td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td> +<td>the error</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-signonui-data-set-query-password"></a><h3>gsignond_signonui_data_set_query_password ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> gsignond_signonui_data_set_query_password + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> query</code></em>);</pre> +<p> +A setter for the query password property. It indicates whether the signon UI +should ask the user for a password (and return it in the password property). +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> +<td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>query</code></em> :</span></p></td> +<td>the property value</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-signonui-data-set-query-username"></a><h3>gsignond_signonui_data_set_query_username ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> gsignond_signonui_data_set_query_username + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> query</code></em>);</pre> +<p> +A setter for the query username property. It indicates whether the signon UI +should ask the user for a username (and return it in the username property). +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> +<td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>query</code></em> :</span></p></td> +<td>the property value</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-signonui-data-set-remember-password"></a><h3>gsignond_signonui_data_set_remember_password ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> gsignond_signonui_data_set_remember_password + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> remember</code></em>);</pre> +<p> +A setter for whether the password should be remembered. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> +<td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>remember</code></em> :</span></p></td> +<td>the property value</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-signonui-data-set-request-id"></a><h3>gsignond_signonui_data_set_request_id ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> gsignond_signonui_data_set_request_id + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *id</code></em>);</pre> +<p> +A setter for the dialog request id. The id identifies the dialog so that it +can be refreshed or updated. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> +<td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td> +<td>request id</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-signonui-data-set-test-reply"></a><h3>gsignond_signonui_data_set_test_reply ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> gsignond_signonui_data_set_test_reply + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *reply</code></em>);</pre> +<p> +A setter for the test reply values. It's used only by the signon ui +implementations to test themselves. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> +<td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>reply</code></em> :</span></p></td> +<td>test reply values</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-signonui-data-set-title"></a><h3>gsignond_signonui_data_set_title ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> gsignond_signonui_data_set_title (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *title</code></em>);</pre> +<p> +A setter for the UI dialog title. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> +<td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>title</code></em> :</span></p></td> +<td>the title</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-signonui-data-set-url-response"></a><h3>gsignond_signonui_data_set_url_response ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> gsignond_signonui_data_set_url_response + (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *response</code></em>);</pre> +<p> +A getter for the response URL. If the final URL was set in the request to the +signon UI, and the signon UI +detects that it has been reached, then the full final URL is returned using +this property. This is used by redirection-based authentication such as OAauth. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> +<td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>response</code></em> :</span></p></td> +<td>the response URL</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-signonui-data-set-username"></a><h3>gsignond_signonui_data_set_username ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> gsignond_signonui_data_set_username (<em class="parameter"><code><a class="link" href="gsignond-GSignondSignonuiData.html#GSignondSignonuiData" title="GSignondSignonuiData"><span class="type">GSignondSignonuiData</span></a> *data</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *username</code></em>);</pre> +<p> +A setter for the username string. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> +<td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>username</code></em> :</span></p></td> +<td>the username string</td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.19.1</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/html/gsignond-General-configuration.html b/docs/html/gsignond-General-configuration.html new file mode 100644 index 0000000..90875dd --- /dev/null +++ b/docs/html/gsignond-General-configuration.html @@ -0,0 +1,161 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>General configuration</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="gsignond API Reference Manual"> +<link rel="up" href="ch02.html" title="GSignond configuration"> +<link rel="prev" href="GSignondConfig.html" title="GSignondConfig"> +<link rel="next" href="gsignond-Database-configuration.html" title="Database configuration"> +<meta name="generator" content="GTK-Doc V1.19.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle"> +<td width="100%" align="left"> +<a href="#" class="shortcut">Top</a> +  | + <a href="#gsignond-General-configuration.description" class="shortcut">Description</a> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="GSignondConfig.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="gsignond-Database-configuration.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="gsignond-General-configuration"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="gsignond-General-configuration.top_of_page"></a>General configuration</span></h2> +<p>General configuration — gSSO general configuration keys</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="gsignond-General-configuration.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis"> +#include <gsignond/gsignond-config.h> + +#define <a class="link" href="gsignond-General-configuration.html#GSIGNOND-CONFIG-GENERAL:CAPS" title="GSIGNOND_CONFIG_GENERAL">GSIGNOND_CONFIG_GENERAL</a> +#define <a class="link" href="gsignond-General-configuration.html#GSIGNOND-CONFIG-GENERAL-BIN-DIR:CAPS" title="GSIGNOND_CONFIG_GENERAL_BIN_DIR">GSIGNOND_CONFIG_GENERAL_BIN_DIR</a> +#define <a class="link" href="gsignond-General-configuration.html#GSIGNOND-CONFIG-GENERAL-EXTENSION:CAPS" title="GSIGNOND_CONFIG_GENERAL_EXTENSION">GSIGNOND_CONFIG_GENERAL_EXTENSION</a> +#define <a class="link" href="gsignond-General-configuration.html#GSIGNOND-CONFIG-GENERAL-EXTENSIONS-DIR:CAPS" title="GSIGNOND_CONFIG_GENERAL_EXTENSIONS_DIR">GSIGNOND_CONFIG_GENERAL_EXTENSIONS_DIR</a> +#define <a class="link" href="gsignond-General-configuration.html#GSIGNOND-CONFIG-GENERAL-PLUGINS-DIR:CAPS" title="GSIGNOND_CONFIG_GENERAL_PLUGINS_DIR">GSIGNOND_CONFIG_GENERAL_PLUGINS_DIR</a> +#define <a class="link" href="gsignond-General-configuration.html#GSIGNOND-CONFIG-GENERAL-SECURE-DIR:CAPS" title="GSIGNOND_CONFIG_GENERAL_SECURE_DIR">GSIGNOND_CONFIG_GENERAL_SECURE_DIR</a> +#define <a class="link" href="gsignond-General-configuration.html#GSIGNOND-CONFIG-GENERAL-STORAGE-PATH:CAPS" title="GSIGNOND_CONFIG_GENERAL_STORAGE_PATH">GSIGNOND_CONFIG_GENERAL_STORAGE_PATH</a> +#define <a class="link" href="gsignond-General-configuration.html#GSIGNOND-CONFIG-PLUGIN-TIMEOUT:CAPS" title="GSIGNOND_CONFIG_PLUGIN_TIMEOUT">GSIGNOND_CONFIG_PLUGIN_TIMEOUT</a> +</pre> +</div> +<div class="refsect1"> +<a name="gsignond-General-configuration.description"></a><h2>Description</h2> +<p> +General configuration keys are defined below. See <a class="link" href="GSignondConfig.html" title="GSignondConfig"><span class="type">GSignondConfig</span></a> for how to use them. +</p> +</div> +<div class="refsect1"> +<a name="gsignond-General-configuration.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GSIGNOND-CONFIG-GENERAL:CAPS"></a><h3>GSIGNOND_CONFIG_GENERAL</h3> +<pre class="programlisting">#define GSIGNOND_CONFIG_GENERAL "General" +</pre> +<p> +A prefix for general keys. Should be used only when defining new keys. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="GSIGNOND-CONFIG-GENERAL-BIN-DIR:CAPS"></a><h3>GSIGNOND_CONFIG_GENERAL_BIN_DIR</h3> +<pre class="programlisting">#define GSIGNOND_CONFIG_GENERAL_BIN_DIR</pre> +<p> +The path where gSSO is looking for the gsignond-plugind binary when it needs +to start a plugin process. Can be used for finding other supplementary binaries in +the future. +</p> +<p> +Default value: $(bindir), can be overriden in debug +builds by setting SSO_BIN_DIR environment variable. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="GSIGNOND-CONFIG-GENERAL-EXTENSION:CAPS"></a><h3>GSIGNOND_CONFIG_GENERAL_EXTENSION</h3> +<pre class="programlisting">#define GSIGNOND_CONFIG_GENERAL_EXTENSION</pre> +<p> +The name of the gSSO extension to use. If not specified, the default +implementation is used (see <a class="link" href="GSignondExtension.html" title="GSignondExtension"><span class="type">GSignondExtension</span></a>). +</p> +<p> +Can be overriden in debug +builds by setting SSO_EXTENSION environment variable. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="GSIGNOND-CONFIG-GENERAL-EXTENSIONS-DIR:CAPS"></a><h3>GSIGNOND_CONFIG_GENERAL_EXTENSIONS_DIR</h3> +<pre class="programlisting">#define GSIGNOND_CONFIG_GENERAL_EXTENSIONS_DIR</pre> +<p> +The path where gSSO is looking for available extension modules. +</p> +<p> +Default value: $(pkglibdir)/extensions, can be overriden in debug +builds by setting SSO_EXTENSIONS_DIR environment variable. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="GSIGNOND-CONFIG-GENERAL-PLUGINS-DIR:CAPS"></a><h3>GSIGNOND_CONFIG_GENERAL_PLUGINS_DIR</h3> +<pre class="programlisting">#define GSIGNOND_CONFIG_GENERAL_PLUGINS_DIR</pre> +<p> +The path where gSSO is looking for available plugins. +</p> +<p> +Default value: $(pkglibdir)/plugins, can be overriden in debug +builds by setting SSO_PLUGINS_DIR environment variable. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="GSIGNOND-CONFIG-GENERAL-SECURE-DIR:CAPS"></a><h3>GSIGNOND_CONFIG_GENERAL_SECURE_DIR</h3> +<pre class="programlisting">#define GSIGNOND_CONFIG_GENERAL_SECURE_DIR</pre> +<p> +Path provided by <a class="link" href="GSignondStorageManager.html" title="GSignondStorageManager"><span class="type">GSignondStorageManager</span></a> for storing user-specific +information, including secret and metadata databases. +</p> +<p> +Value provided by the default implementation: +<a class="link" href="gsignond-General-configuration.html#GSIGNOND-CONFIG-GENERAL-STORAGE-PATH:CAPS" title="GSIGNOND_CONFIG_GENERAL_STORAGE_PATH"><span class="type">GSIGNOND_CONFIG_GENERAL_STORAGE_PATH</span></a> + "/gsignond." + <a href="http://library.gnome.org/devel/glib/unstable/glib-Miscellaneous-Utility-Functions.html#g-get-user-name"><code class="function">g_get_user_name()</code></a>. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="GSIGNOND-CONFIG-GENERAL-STORAGE-PATH:CAPS"></a><h3>GSIGNOND_CONFIG_GENERAL_STORAGE_PATH</h3> +<pre class="programlisting">#define GSIGNOND_CONFIG_GENERAL_STORAGE_PATH</pre> +<p> +Base path for <a class="link" href="GSignondStorageManager.html" title="GSignondStorageManager"><span class="type">GSignondStorageManager</span></a> to operate in. +</p> +<p> +Default value: "/var/db", can be overriden in debug +builds by setting SSO_STORAGE_PATH environment variable. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="GSIGNOND-CONFIG-PLUGIN-TIMEOUT:CAPS"></a><h3>GSIGNOND_CONFIG_PLUGIN_TIMEOUT</h3> +<pre class="programlisting">#define GSIGNOND_CONFIG_PLUGIN_TIMEOUT</pre> +<p> +A timeout in seconds, after which inactive plugin objects and processes are removed. +If not set, the plugin objects will persist for possible reuse. +</p> +<p> +Can be overriden in debug +builds by setting SSO_PLUGIN_TIMEOUT environment variable. +</p> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.19.1</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/html/gsignond-Logging.html b/docs/html/gsignond-Logging.html new file mode 100644 index 0000000..074a419 --- /dev/null +++ b/docs/html/gsignond-Logging.html @@ -0,0 +1,177 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Logging</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="gsignond API Reference Manual"> +<link rel="up" href="ch06.html" title="Miscellaneous"> +<link rel="prev" href="gsignond-Errors.html" title="Errors"> +<link rel="next" href="gsignond-Utility-functions.html" title="Utility functions"> +<meta name="generator" content="GTK-Doc V1.19.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle"> +<td width="100%" align="left"> +<a href="#" class="shortcut">Top</a> +  | + <a href="#gsignond-Logging.description" class="shortcut">Description</a> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="ch06.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="gsignond-Errors.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="gsignond-Utility-functions.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="gsignond-Logging"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="gsignond-Logging.top_of_page"></a>Logging</span></h2> +<p>Logging — logging facilities</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="gsignond-Logging.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis"> +#include <gsignond/gsignond-log.h> + +#define <a class="link" href="gsignond-Logging.html#DBG:CAPS" title="DBG()">DBG</a> (frmt, + ...) +#define <a class="link" href="gsignond-Logging.html#ERR:CAPS" title="ERR()">ERR</a> (frmt, + ...) +#define <a class="link" href="gsignond-Logging.html#INFO:CAPS" title="INFO()">INFO</a> (frmt, + ...) +#define <a class="link" href="gsignond-Logging.html#TRACEBACK:CAPS" title="TRACEBACK">TRACEBACK</a> +#define <a class="link" href="gsignond-Logging.html#WARN:CAPS" title="WARN()">WARN</a> (frmt, + ...) +</pre> +</div> +<div class="refsect1"> +<a name="gsignond-Logging.description"></a><h2>Description</h2> +<p> +<code class="filename">gsignond/gsignond-log.h</code> file contains logging macros +that plugins and extensions should use for debugging and tracing. +</p> +<p> +For example: +</p> +<div class="informalexample"> + <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> + <tbody> + <tr> + <td class="listing_lines" align="right"><pre>1</pre></td> + <td class="listing_code"><pre class="programlisting">INFO(<span class="number">"Plugin </span><span class="symbol">%s</span><span class="number"> initialized"</span>, plugin_mechanism);</pre></td> + </tr> + </tbody> + </table> +</div> + +<p> +</p> +</div> +<div class="refsect1"> +<a name="gsignond-Logging.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="DBG:CAPS"></a><h3>DBG()</h3> +<pre class="programlisting">#define DBG(frmt, args...)</pre> +<p> +Use this macro to log debug messages. GSignond will take care of +correctly saving them. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>frmt</code></em> :</span></p></td> +<td>format string for the message</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td> +<td>arguments for the format string</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="ERR:CAPS"></a><h3>ERR()</h3> +<pre class="programlisting">#define ERR(frmt, args...)</pre> +<p> +Use this macro to log error messages. GSignond will take care of +correctly saving them. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>frmt</code></em> :</span></p></td> +<td>format string for the message</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td> +<td>arguments for the format string</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="INFO:CAPS"></a><h3>INFO()</h3> +<pre class="programlisting">#define INFO(frmt, args...)</pre> +<p> +Use this macro to log informational messages. GSignond will take care of +correctly saving them. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>frmt</code></em> :</span></p></td> +<td>format string for the message</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td> +<td>arguments for the format string</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="TRACEBACK:CAPS"></a><h3>TRACEBACK</h3> +<pre class="programlisting">#define TRACEBACK()</pre> +<p> +This macro prints the current function call stack to stderr. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="WARN:CAPS"></a><h3>WARN()</h3> +<pre class="programlisting">#define WARN(frmt, args...)</pre> +<p> +Use this macro to log warning messages. GSignond will take care of +correctly saving them. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>frmt</code></em> :</span></p></td> +<td>format string for the message</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td> +<td>arguments for the format string</td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.19.1</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/html/gsignond-Utility-functions.html b/docs/html/gsignond-Utility-functions.html new file mode 100644 index 0000000..26fcca1 --- /dev/null +++ b/docs/html/gsignond-Utility-functions.html @@ -0,0 +1,119 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Utility functions</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="gsignond API Reference Manual"> +<link rel="up" href="ch06.html" title="Miscellaneous"> +<link rel="prev" href="gsignond-Logging.html" title="Logging"> +<link rel="next" href="object-tree.html" title="Object Hierarchy"> +<meta name="generator" content="GTK-Doc V1.19.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle"> +<td width="100%" align="left"> +<a href="#" class="shortcut">Top</a> +  | + <a href="#gsignond-Utility-functions.description" class="shortcut">Description</a> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="ch06.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="gsignond-Logging.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="object-tree.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="gsignond-Utility-functions"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="gsignond-Utility-functions.top_of_page"></a>Utility functions</span></h2> +<p>Utility functions — miscellaneous utility functions</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="gsignond-Utility-functions.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis"> +#include <gsignond/gsignond-utils.h> + +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="gsignond-Utility-functions.html#gsignond-generate-nonce" title="gsignond_generate_nonce ()">gsignond_generate_nonce</a> (); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gsignond-Utility-functions.html#gsignond-wipe-directory" title="gsignond_wipe_directory ()">gsignond_wipe_directory</a> (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *dirname</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gsignond-Utility-functions.html#gsignond-wipe-file" title="gsignond_wipe_file ()">gsignond_wipe_file</a> (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="gsignond-Utility-functions.description"></a><h2>Description</h2> +<p> +Miscellaneous utility functions are described below. +</p> +</div> +<div class="refsect1"> +<a name="gsignond-Utility-functions.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="gsignond-generate-nonce"></a><h3>gsignond_generate_nonce ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gsignond_generate_nonce ();</pre> +<p> +This function generates a random secure nonce using SHA1 HMAC. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the nonce in lowercase hexadecimal format, 40 bytes long. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span> +</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-wipe-directory"></a><h3>gsignond_wipe_directory ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gsignond_wipe_directory (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *dirname</code></em>);</pre> +<p> +This function securely wipes the contents of the directory by calling +<a class="link" href="gsignond-Utility-functions.html#gsignond-wipe-file" title="gsignond_wipe_file ()"><code class="function">gsignond_wipe_file()</code></a> on each file. It also removes links and empty directories but +does not recursively wipe them. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>dirname</code></em> :</span></p></td> +<td>directory to wipe</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>TRUE if wiping and removal was successful.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gsignond-wipe-file"></a><h3>gsignond_wipe_file ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gsignond_wipe_file (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>);</pre> +<p> +This function securely wipes the contents of the file, by overwriting it with +0's, then 1's, then random data. The file is then removed. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td> +<td>filename to wipe</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>TRUE if wiping and removal was successful.</td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.19.1</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/html/gsignond-building.html b/docs/html/gsignond-building.html new file mode 100644 index 0000000..d92d299 --- /dev/null +++ b/docs/html/gsignond-building.html @@ -0,0 +1,161 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Building and installing the gsignond daemon</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="gsignond API Reference Manual"> +<link rel="up" href="ch01.html" title="GSignond building and installation"> +<link rel="prev" href="ch01.html" title="GSignond building and installation"> +<link rel="next" href="ch02.html" title="GSignond configuration"> +<meta name="generator" content="GTK-Doc V1.19.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle"> +<td width="100%" align="left"></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="ch01.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="ch02.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="gsignond-building"></a><div class="titlepage"></div> +<div class="refsect1"> +<a name="building"></a><h2>Building gsignond</h2> +<p> + GSignond uses the standard GNU build system, + using <span class="application">autoconf</span> for package + configuration and resolving portability issues, + <span class="application">automake</span> for building makefiles + that comply with the GNU Coding Standards, and + <span class="application">libtool</span> for building shared + libraries on multiple platforms. The normal sequence for + compiling and installing gsignond from distribution tarballs is thus: + + </p> +<div class="literallayout"><p><br> +        <strong class="userinput"><code>./configure</code></strong><br> +        <strong class="userinput"><code>make</code></strong><br> +        <strong class="userinput"><code>make install</code></strong><br> +      </p></div> +<p> + + If you have obtained the source code directly from git repository, + execute the <span class="command"><strong>./autogen.sh</strong></span> script + before the steps above. + </p> +<p> + The standard options provided by <span class="application">GNU + autoconf</span> may be passed to the + <span class="command"><strong>configure</strong></span> script. Please see the + <span class="application">autoconf</span> documentation or run + <span class="command"><strong>./configure --help</strong></span> for information about + the standard options. + </p> +</div> +<div class="refsect1"> +<a name="dependencies"></a><h2>Dependencies</h2> +<p> + Before you can compile GSignond, you need to have + various other tools and libraries installed on your + system. The two tools needed during the build process + are <span class="command"><strong>pkg-config</strong></span> and + <a class="ulink" href="http://www.gnu.org/software/make" target="_top">GNU make</a>. + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p> + <a class="ulink" href="http://www.freedesktop.org/software/pkgconfig/" target="_top">pkg-config</a> + is a tool for tracking the compilation flags needed for + libraries that are used by the GSignond. (For each + library, a small <code class="literal">.pc</code> text file is + installed in a standard location that contains the compilation + flags needed for that library along with version number + information.) + </p></li></ul></div> +<p> + GSignond depends on a number of other libraries. + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"><p> + The <a class="ulink" href="https://developer.gnome.org/glib/" target="_top">GLib + library</a> is the development framework that GSignond is built on. + </p></li> +<li class="listitem"><p> + The <a class="ulink" href="http://www.sqlite.org/" target="_top">SQLite library</a> + provides a database implementation that GSignond is using for + storing data. + </p></li> +<li class="listitem"><p> + The <a class="ulink" href="http://check.sourceforge.net/" target="_top">check library</a> + provides a unit testing framework. It is needed only if you would + like to run unit tests with <span class="command"><strong>make check</strong></span>. + </p></li> +<li class="listitem"><p> + For building Tizen extension module that integrates gsignond into + the Tizen platform, the + <a class="ulink" href="http://schaufler-ca.com/" target="_top">libsmack</a> and + <a class="ulink" href="http://ecryptfs.org/" target="_top">ecryptfs</a> are required. + They are not needed otherwise. + </p></li> +</ul></div> +</div> +<div class="refsect1"> +<a name="extra-configuration-options"></a><h2>Extra Configuration Options</h2> +<p> + In addition to the normal options, the + <span class="command"><strong>configure</strong></span> script supports these additional arguments: + </p> +<p><b><code class="systemitem">--enable-debug</code>. </b> + Turns on debugging support. This enables unit tests and allows setting + environment variables to influence the runtime behaviour of GSignond + (see <a class="link" href="GSignondConfig.html" title="GSignondConfig">GSignondConfig</a> and + <a class="link" href="GSignondAccessControlManager.html" title="GSignondAccessControlManager">GSignondAccessControlManager</a>). + Also, the daemon will exit in case of critical errors. + </p> +<p><b><code class="systemitem">--enable-sql-log</code>. </b> + Turns on SQL statement logging. For this, also + <code class="systemitem">--enable-debug</code> must be used. + </p> +<p><b><code class="systemitem">--enable-dbus-type=dbus-type</code>. </b> + Sets the way in which GSignond is using DBus to communicate with + the client library. <code class="systemitem">dbus-type</code> can be one of + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"><p> + <code class="systemitem">'p2p'</code> which is the default and recommended + value. GSignond will use direct connection over a UNIX domain socket + with the client library without involving the DBus daemon. + </p></li> +<li class="listitem"><p> + <code class="systemitem">'session'</code> which will use the session bus. + This is not recommended to use because session bus isn't secure + against eavesdropping, but it can be used for debugging purposes, + as it allows the use of standard tools such as + <span class="command"><strong>dbus-monitor</strong></span>, <span class="command"><strong>d-feet</strong></span> and + so on. + </p></li> +<li class="listitem"><p> + <code class="systemitem">'system'</code> which will use the system bus. + Can be used on a single-user systems, but 'p2p' is preferred. + </p></li> +</ul></div> +<p> + </p> +</div> +<div class="refsect1"> +<a name="building-packages"></a><h2>Building distribution packages</h2> +<p> + Instead of running <span class="command"><strong>make install</strong></span> to install gsignond + into a system location it is possible to build distribution-specific + packages. <code class="filename">dists/</code> directory in the source tree + contains a number of package confuguration files, and to use them also + a distribution tarball is needed. If you are building from a git tree, + use <span class="command"><strong>make dist</strong></span> to create such a tarball. + </p> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.19.1</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/html/gsignond.devhelp2 b/docs/html/gsignond.devhelp2 new file mode 100644 index 0000000..107f848 --- /dev/null +++ b/docs/html/gsignond.devhelp2 @@ -0,0 +1,320 @@ +<?xml version="1.0" encoding="utf-8" standalone="no"?> +<!DOCTYPE book PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" ""> +<book xmlns="http://www.devhelp.net/book" title="gsignond API Reference Manual" link="index.html" author="" name="gsignond" version="2" language="c"> + <chapters> + <sub name="GSignond building and installation" link="ch01.html"> + <sub name="Building and installing the gsignond daemon" link="gsignond-building.html"/> + </sub> + <sub name="GSignond configuration" link="ch02.html"> + <sub name="GSignondConfig" link="GSignondConfig.html"/> + <sub name="General configuration" link="gsignond-General-configuration.html"/> + <sub name="Database configuration" link="gsignond-Database-configuration.html"/> + <sub name="DBus configuration" link="gsignond-DBus-configuration.html"/> + </sub> + <sub name="GSignond API for writing authentication plugins" link="ch03.html"> + <sub name="GSignondPlugin" link="gsignond-GSignondPlugin.html"/> + <sub name="GSignondDictionary" link="gsignond-GSignondDictionary.html"/> + <sub name="GSignondSessionData" link="gsignond-GSignondSessionData.html"/> + <sub name="GSignondSignonuiData" link="gsignond-GSignondSignonuiData.html"/> + </sub> + <sub name="Standard in-tree authentication plugins" link="ch04.html"> + <sub name="GSignondDigestPlugin" link="GSignondDigestPlugin.html"/> + <sub name="GSignondSsoTestPlugin" link="GSignondSsoTestPlugin.html"/> + <sub name="GSignondPasswordPlugin" link="GSignondPasswordPlugin.html"/> + </sub> + <sub name="GSignond API for writing platform adaptation extensions" link="ch05.html"> + <sub name="GSignondExtension" link="GSignondExtension.html"/> + <sub name="GSignondAccessControlManager" link="GSignondAccessControlManager.html"/> + <sub name="GSignondSecurityContext" link="gsignond-GSignondSecurityContext.html"/> + <sub name="GSignondStorageManager" link="GSignondStorageManager.html"/> + <sub name="GSignondSecretStorage" link="GSignondSecretStorage.html"/> + <sub name="GSignondCredentials" link="GSignondCredentials.html"/> + </sub> + <sub name="Miscellaneous" link="ch06.html"> + <sub name="Errors" link="gsignond-Errors.html"/> + <sub name="Logging" link="gsignond-Logging.html"/> + <sub name="Utility functions" link="gsignond-Utility-functions.html"/> + </sub> + <sub name="Object Hierarchy" link="object-tree.html"/> + <sub name="API Index" link="api-index-full.html"/> + <sub name="Index of deprecated API" link="deprecated-api-index.html"/> + <sub name="Annotation Glossary" link="annotation-glossary.html"/> + </chapters> + <functions> + <keyword type="struct" name="struct GSignondConfig" link="GSignondConfig.html#GSignondConfig-struct"/> + <keyword type="struct" name="struct GSignondConfigClass" link="GSignondConfig.html#GSignondConfigClass"/> + <keyword type="function" name="gsignond_config_get_integer ()" link="GSignondConfig.html#gsignond-config-get-integer"/> + <keyword type="function" name="gsignond_config_get_string ()" link="GSignondConfig.html#gsignond-config-get-string"/> + <keyword type="function" name="gsignond_config_new ()" link="GSignondConfig.html#gsignond-config-new"/> + <keyword type="function" name="gsignond_config_set_integer ()" link="GSignondConfig.html#gsignond-config-set-integer"/> + <keyword type="function" name="gsignond_config_set_string ()" link="GSignondConfig.html#gsignond-config-set-string"/> + <keyword type="macro" name="GSIGNOND_CONFIG_GENERAL" link="gsignond-General-configuration.html#GSIGNOND-CONFIG-GENERAL:CAPS"/> + <keyword type="macro" name="GSIGNOND_CONFIG_GENERAL_BIN_DIR" link="gsignond-General-configuration.html#GSIGNOND-CONFIG-GENERAL-BIN-DIR:CAPS"/> + <keyword type="macro" name="GSIGNOND_CONFIG_GENERAL_EXTENSION" link="gsignond-General-configuration.html#GSIGNOND-CONFIG-GENERAL-EXTENSION:CAPS"/> + <keyword type="macro" name="GSIGNOND_CONFIG_GENERAL_EXTENSIONS_DIR" link="gsignond-General-configuration.html#GSIGNOND-CONFIG-GENERAL-EXTENSIONS-DIR:CAPS"/> + <keyword type="macro" name="GSIGNOND_CONFIG_GENERAL_PLUGINS_DIR" link="gsignond-General-configuration.html#GSIGNOND-CONFIG-GENERAL-PLUGINS-DIR:CAPS"/> + <keyword type="macro" name="GSIGNOND_CONFIG_GENERAL_SECURE_DIR" link="gsignond-General-configuration.html#GSIGNOND-CONFIG-GENERAL-SECURE-DIR:CAPS"/> + <keyword type="macro" name="GSIGNOND_CONFIG_GENERAL_STORAGE_PATH" link="gsignond-General-configuration.html#GSIGNOND-CONFIG-GENERAL-STORAGE-PATH:CAPS"/> + <keyword type="macro" name="GSIGNOND_CONFIG_PLUGIN_TIMEOUT" link="gsignond-General-configuration.html#GSIGNOND-CONFIG-PLUGIN-TIMEOUT:CAPS"/> + <keyword type="macro" name="GSIGNOND_CONFIG_DB_METADATA_DB_FILENAME" link="gsignond-Database-configuration.html#GSIGNOND-CONFIG-DB-METADATA-DB-FILENAME:CAPS"/> + <keyword type="macro" name="GSIGNOND_CONFIG_DB_SECRET_DB_FILENAME" link="gsignond-Database-configuration.html#GSIGNOND-CONFIG-DB-SECRET-DB-FILENAME:CAPS"/> + <keyword type="macro" name="GSIGNOND_CONFIG_DB_SSO" link="gsignond-Database-configuration.html#GSIGNOND-CONFIG-DB-SSO:CAPS"/> + <keyword type="macro" name="GSIGNOND_CONFIG_DBUS_AUTH_SESSION_TIMEOUT" link="gsignond-DBus-configuration.html#GSIGNOND-CONFIG-DBUS-AUTH-SESSION-TIMEOUT:CAPS"/> + <keyword type="macro" name="GSIGNOND_CONFIG_DBUS_DAEMON_TIMEOUT" link="gsignond-DBus-configuration.html#GSIGNOND-CONFIG-DBUS-DAEMON-TIMEOUT:CAPS"/> + <keyword type="macro" name="GSIGNOND_CONFIG_DBUS_IDENTITY_TIMEOUT" link="gsignond-DBus-configuration.html#GSIGNOND-CONFIG-DBUS-IDENTITY-TIMEOUT:CAPS"/> + <keyword type="macro" name="GSIGNOND_CONFIG_DBUS_TIMEOUTS" link="gsignond-DBus-configuration.html#GSIGNOND-CONFIG-DBUS-TIMEOUTS:CAPS"/> + <keyword type="struct" name="struct GSignondPluginInterface" link="gsignond-GSignondPlugin.html#GSignondPluginInterface"/> + <keyword type="enum" name="enum GSignondPluginState" link="gsignond-GSignondPlugin.html#GSignondPluginState"/> + <keyword type="function" name="gsignond_plugin_cancel ()" link="gsignond-GSignondPlugin.html#gsignond-plugin-cancel"/> + <keyword type="function" name="gsignond_plugin_error ()" link="gsignond-GSignondPlugin.html#gsignond-plugin-error"/> + <keyword type="function" name="gsignond_plugin_refresh ()" link="gsignond-GSignondPlugin.html#gsignond-plugin-refresh"/> + <keyword type="function" name="gsignond_plugin_refreshed ()" link="gsignond-GSignondPlugin.html#gsignond-plugin-refreshed"/> + <keyword type="function" name="gsignond_plugin_request ()" link="gsignond-GSignondPlugin.html#gsignond-plugin-request"/> + <keyword type="function" name="gsignond_plugin_request_initial ()" link="gsignond-GSignondPlugin.html#gsignond-plugin-request-initial"/> + <keyword type="function" name="gsignond_plugin_response ()" link="gsignond-GSignondPlugin.html#gsignond-plugin-response"/> + <keyword type="function" name="gsignond_plugin_response_final ()" link="gsignond-GSignondPlugin.html#gsignond-plugin-response-final"/> + <keyword type="function" name="gsignond_plugin_status_changed ()" link="gsignond-GSignondPlugin.html#gsignond-plugin-status-changed"/> + <keyword type="function" name="gsignond_plugin_store ()" link="gsignond-GSignondPlugin.html#gsignond-plugin-store"/> + <keyword type="function" name="gsignond_plugin_user_action_finished ()" link="gsignond-GSignondPlugin.html#gsignond-plugin-user-action-finished"/> + <keyword type="function" name="gsignond_plugin_user_action_required ()" link="gsignond-GSignondPlugin.html#gsignond-plugin-user-action-required"/> + <keyword type="typedef" name="GSignondDictionary" link="gsignond-GSignondDictionary.html#GSignondDictionary"/> + <keyword type="function" name="gsignond_dictionary_copy ()" link="gsignond-GSignondDictionary.html#gsignond-dictionary-copy"/> + <keyword type="function" name="gsignond_dictionary_get ()" link="gsignond-GSignondDictionary.html#gsignond-dictionary-get"/> + <keyword type="function" name="gsignond_dictionary_get_boolean ()" link="gsignond-GSignondDictionary.html#gsignond-dictionary-get-boolean"/> + <keyword type="function" name="gsignond_dictionary_get_int32 ()" link="gsignond-GSignondDictionary.html#gsignond-dictionary-get-int32"/> + <keyword type="function" name="gsignond_dictionary_get_int64 ()" link="gsignond-GSignondDictionary.html#gsignond-dictionary-get-int64"/> + <keyword type="function" name="gsignond_dictionary_get_string ()" link="gsignond-GSignondDictionary.html#gsignond-dictionary-get-string"/> + <keyword type="function" name="gsignond_dictionary_get_uint32 ()" link="gsignond-GSignondDictionary.html#gsignond-dictionary-get-uint32"/> + <keyword type="function" name="gsignond_dictionary_get_uint64 ()" link="gsignond-GSignondDictionary.html#gsignond-dictionary-get-uint64"/> + <keyword type="function" name="gsignond_dictionary_new ()" link="gsignond-GSignondDictionary.html#gsignond-dictionary-new"/> + <keyword type="function" name="gsignond_dictionary_new_from_variant ()" link="gsignond-GSignondDictionary.html#gsignond-dictionary-new-from-variant"/> + <keyword type="function" name="gsignond_dictionary_ref ()" link="gsignond-GSignondDictionary.html#gsignond-dictionary-ref"/> + <keyword type="function" name="gsignond_dictionary_remove ()" link="gsignond-GSignondDictionary.html#gsignond-dictionary-remove"/> + <keyword type="function" name="gsignond_dictionary_set ()" link="gsignond-GSignondDictionary.html#gsignond-dictionary-set"/> + <keyword type="function" name="gsignond_dictionary_set_boolean ()" link="gsignond-GSignondDictionary.html#gsignond-dictionary-set-boolean"/> + <keyword type="function" name="gsignond_dictionary_set_int32 ()" link="gsignond-GSignondDictionary.html#gsignond-dictionary-set-int32"/> + <keyword type="function" name="gsignond_dictionary_set_int64 ()" link="gsignond-GSignondDictionary.html#gsignond-dictionary-set-int64"/> + <keyword type="function" name="gsignond_dictionary_set_string ()" link="gsignond-GSignondDictionary.html#gsignond-dictionary-set-string"/> + <keyword type="function" name="gsignond_dictionary_set_uint32 ()" link="gsignond-GSignondDictionary.html#gsignond-dictionary-set-uint32"/> + <keyword type="function" name="gsignond_dictionary_set_uint64 ()" link="gsignond-GSignondDictionary.html#gsignond-dictionary-set-uint64"/> + <keyword type="function" name="gsignond_dictionary_to_variant ()" link="gsignond-GSignondDictionary.html#gsignond-dictionary-to-variant"/> + <keyword type="function" name="gsignond_dictionary_unref ()" link="gsignond-GSignondDictionary.html#gsignond-dictionary-unref"/> + <keyword type="typedef" name="GSignondSessionData" link="gsignond-GSignondSessionData.html#GSignondSessionData"/> + <keyword type="enum" name="enum GSignondUiPolicy" link="gsignond-GSignondSessionData.html#GSignondUiPolicy"/> + <keyword type="function" name="gsignond_session_data_get_caption ()" link="gsignond-GSignondSessionData.html#gsignond-session-data-get-caption"/> + <keyword type="function" name="gsignond_session_data_get_network_proxy ()" link="gsignond-GSignondSessionData.html#gsignond-session-data-get-network-proxy"/> + <keyword type="function" name="gsignond_session_data_get_network_timeout ()" link="gsignond-GSignondSessionData.html#gsignond-session-data-get-network-timeout"/> + <keyword type="function" name="gsignond_session_data_get_realm ()" link="gsignond-GSignondSessionData.html#gsignond-session-data-get-realm"/> + <keyword type="function" name="gsignond_session_data_get_renew_token ()" link="gsignond-GSignondSessionData.html#gsignond-session-data-get-renew-token"/> + <keyword type="function" name="gsignond_session_data_get_secret ()" link="gsignond-GSignondSessionData.html#gsignond-session-data-get-secret"/> + <keyword type="function" name="gsignond_session_data_get_ui_policy ()" link="gsignond-GSignondSessionData.html#gsignond-session-data-get-ui-policy"/> + <keyword type="function" name="gsignond_session_data_get_username ()" link="gsignond-GSignondSessionData.html#gsignond-session-data-get-username"/> + <keyword type="function" name="gsignond_session_data_get_window_id ()" link="gsignond-GSignondSessionData.html#gsignond-session-data-get-window-id"/> + <keyword type="function" name="gsignond_session_data_set_caption ()" link="gsignond-GSignondSessionData.html#gsignond-session-data-set-caption"/> + <keyword type="function" name="gsignond_session_data_set_network_proxy ()" link="gsignond-GSignondSessionData.html#gsignond-session-data-set-network-proxy"/> + <keyword type="function" name="gsignond_session_data_set_network_timeout ()" link="gsignond-GSignondSessionData.html#gsignond-session-data-set-network-timeout"/> + <keyword type="function" name="gsignond_session_data_set_realm ()" link="gsignond-GSignondSessionData.html#gsignond-session-data-set-realm"/> + <keyword type="function" name="gsignond_session_data_set_renew_token ()" link="gsignond-GSignondSessionData.html#gsignond-session-data-set-renew-token"/> + <keyword type="function" name="gsignond_session_data_set_secret ()" link="gsignond-GSignondSessionData.html#gsignond-session-data-set-secret"/> + <keyword type="function" name="gsignond_session_data_set_ui_policy ()" link="gsignond-GSignondSessionData.html#gsignond-session-data-set-ui-policy"/> + <keyword type="function" name="gsignond_session_data_set_username ()" link="gsignond-GSignondSessionData.html#gsignond-session-data-set-username"/> + <keyword type="function" name="gsignond_session_data_set_window_id ()" link="gsignond-GSignondSessionData.html#gsignond-session-data-set-window-id"/> + <keyword type="typedef" name="GSignondSignonuiData" link="gsignond-GSignondSignonuiData.html#GSignondSignonuiData"/> + <keyword type="enum" name="enum GSignondSignonuiError" link="gsignond-GSignondSignonuiData.html#GSignondSignonuiError"/> + <keyword type="function" name="gsignond_signonui_data_get_captcha_response ()" link="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-captcha-response"/> + <keyword type="function" name="gsignond_signonui_data_get_captcha_url ()" link="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-captcha-url"/> + <keyword type="function" name="gsignond_signonui_data_get_caption ()" link="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-caption"/> + <keyword type="function" name="gsignond_signonui_data_get_confirm ()" link="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-confirm"/> + <keyword type="function" name="gsignond_signonui_data_get_final_url ()" link="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-final-url"/> + <keyword type="function" name="gsignond_signonui_data_get_forgot_password ()" link="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-forgot-password"/> + <keyword type="function" name="gsignond_signonui_data_get_forgot_password_url ()" link="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-forgot-password-url"/> + <keyword type="function" name="gsignond_signonui_data_get_message ()" link="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-message"/> + <keyword type="function" name="gsignond_signonui_data_get_open_url ()" link="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-open-url"/> + <keyword type="function" name="gsignond_signonui_data_get_password ()" link="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-password"/> + <keyword type="function" name="gsignond_signonui_data_get_query_error ()" link="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-query-error"/> + <keyword type="function" name="gsignond_signonui_data_get_query_password ()" link="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-query-password"/> + <keyword type="function" name="gsignond_signonui_data_get_query_username ()" link="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-query-username"/> + <keyword type="function" name="gsignond_signonui_data_get_remember_password ()" link="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-remember-password"/> + <keyword type="function" name="gsignond_signonui_data_get_request_id ()" link="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-request-id"/> + <keyword type="function" name="gsignond_signonui_data_get_test_reply ()" link="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-test-reply"/> + <keyword type="function" name="gsignond_signonui_data_get_title ()" link="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-title"/> + <keyword type="function" name="gsignond_signonui_data_get_url_response ()" link="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-url-response"/> + <keyword type="function" name="gsignond_signonui_data_get_username ()" link="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-username"/> + <keyword type="function" name="gsignond_signonui_data_set_captcha_response ()" link="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-captcha-response"/> + <keyword type="function" name="gsignond_signonui_data_set_captcha_url ()" link="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-captcha-url"/> + <keyword type="function" name="gsignond_signonui_data_set_caption ()" link="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-caption"/> + <keyword type="function" name="gsignond_signonui_data_set_confirm ()" link="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-confirm"/> + <keyword type="function" name="gsignond_signonui_data_set_final_url ()" link="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-final-url"/> + <keyword type="function" name="gsignond_signonui_data_set_forgot_password ()" link="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-forgot-password"/> + <keyword type="function" name="gsignond_signonui_data_set_forgot_password_url ()" link="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-forgot-password-url"/> + <keyword type="function" name="gsignond_signonui_data_set_message ()" link="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-message"/> + <keyword type="function" name="gsignond_signonui_data_set_open_url ()" link="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-open-url"/> + <keyword type="function" name="gsignond_signonui_data_set_password ()" link="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-password"/> + <keyword type="function" name="gsignond_signonui_data_set_query_error ()" link="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-query-error"/> + <keyword type="function" name="gsignond_signonui_data_set_query_password ()" link="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-query-password"/> + <keyword type="function" name="gsignond_signonui_data_set_query_username ()" link="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-query-username"/> + <keyword type="function" name="gsignond_signonui_data_set_remember_password ()" link="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-remember-password"/> + <keyword type="function" name="gsignond_signonui_data_set_request_id ()" link="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-request-id"/> + <keyword type="function" name="gsignond_signonui_data_set_test_reply ()" link="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-test-reply"/> + <keyword type="function" name="gsignond_signonui_data_set_title ()" link="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-title"/> + <keyword type="function" name="gsignond_signonui_data_set_url_response ()" link="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-url-response"/> + <keyword type="function" name="gsignond_signonui_data_set_username ()" link="gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-username"/> + <keyword type="struct" name="struct GSignondDigestPlugin" link="GSignondDigestPlugin.html#GSignondDigestPlugin-struct"/> + <keyword type="struct" name="struct GSignondDigestPluginClass" link="GSignondDigestPlugin.html#GSignondDigestPluginClass"/> + <keyword type="struct" name="struct GSignondSsoTestPlugin" link="GSignondSsoTestPlugin.html#GSignondSsoTestPlugin-struct"/> + <keyword type="struct" name="struct GSignondSsoTestPluginClass" link="GSignondSsoTestPlugin.html#GSignondSsoTestPluginClass"/> + <keyword type="struct" name="struct GSignondPasswordPlugin" link="GSignondPasswordPlugin.html#GSignondPasswordPlugin-struct"/> + <keyword type="struct" name="struct GSignondPasswordPluginClass" link="GSignondPasswordPlugin.html#GSignondPasswordPluginClass"/> + <keyword type="struct" name="struct GSignondExtension" link="GSignondExtension.html#GSignondExtension-struct"/> + <keyword type="struct" name="struct GSignondExtensionClass" link="GSignondExtension.html#GSignondExtensionClass"/> + <keyword type="function" name="gsignond_extension_get_access_control_manager ()" link="GSignondExtension.html#gsignond-extension-get-access-control-manager"/> + <keyword type="function" name="gsignond_extension_get_name ()" link="GSignondExtension.html#gsignond-extension-get-name"/> + <keyword type="function" name="gsignond_extension_get_secret_storage ()" link="GSignondExtension.html#gsignond-extension-get-secret-storage"/> + <keyword type="function" name="gsignond_extension_get_storage_manager ()" link="GSignondExtension.html#gsignond-extension-get-storage-manager"/> + <keyword type="function" name="gsignond_extension_get_version ()" link="GSignondExtension.html#gsignond-extension-get-version"/> + <keyword type="struct" name="struct GSignondAccessControlManager" link="GSignondAccessControlManager.html#GSignondAccessControlManager-struct"/> + <keyword type="struct" name="struct GSignondAccessControlManagerClass" link="GSignondAccessControlManager.html#GSignondAccessControlManagerClass"/> + <keyword type="function" name="gsignond_access_control_manager_acl_is_valid ()" link="GSignondAccessControlManager.html#gsignond-access-control-manager-acl-is-valid"/> + <keyword type="function" name="gsignond_access_control_manager_peer_is_allowed_to_use_identity ()" link="GSignondAccessControlManager.html#gsignond-access-control-manager-peer-is-allowed-to-use-identity"/> + <keyword type="function" name="gsignond_access_control_manager_peer_is_owner_of_identity ()" link="GSignondAccessControlManager.html#gsignond-access-control-manager-peer-is-owner-of-identity"/> + <keyword type="function" name="gsignond_access_control_manager_security_context_of_keychain ()" link="GSignondAccessControlManager.html#gsignond-access-control-manager-security-context-of-keychain"/> + <keyword type="function" name="gsignond_access_control_manager_security_context_of_peer ()" link="GSignondAccessControlManager.html#gsignond-access-control-manager-security-context-of-peer"/> + <keyword type="property" name="The "config" property" link="GSignondAccessControlManager.html#GSignondAccessControlManager--config"/> + <keyword type="struct" name="GSignondSecurityContext" link="gsignond-GSignondSecurityContext.html#GSignondSecurityContext"/> + <keyword type="typedef" name="GSignondSecurityContextList" link="gsignond-GSignondSecurityContext.html#GSignondSecurityContextList"/> + <keyword type="function" name="gsignond_security_context_check ()" link="gsignond-GSignondSecurityContext.html#gsignond-security-context-check"/> + <keyword type="function" name="gsignond_security_context_compare ()" link="gsignond-GSignondSecurityContext.html#gsignond-security-context-compare"/> + <keyword type="function" name="gsignond_security_context_copy ()" link="gsignond-GSignondSecurityContext.html#gsignond-security-context-copy"/> + <keyword type="function" name="gsignond_security_context_free ()" link="gsignond-GSignondSecurityContext.html#gsignond-security-context-free"/> + <keyword type="function" name="gsignond_security_context_from_variant ()" link="gsignond-GSignondSecurityContext.html#gsignond-security-context-from-variant"/> + <keyword type="function" name="gsignond_security_context_get_application_context ()" link="gsignond-GSignondSecurityContext.html#gsignond-security-context-get-application-context"/> + <keyword type="function" name="gsignond_security_context_get_system_context ()" link="gsignond-GSignondSecurityContext.html#gsignond-security-context-get-system-context"/> + <keyword type="function" name="gsignond_security_context_list_copy ()" link="gsignond-GSignondSecurityContext.html#gsignond-security-context-list-copy"/> + <keyword type="function" name="gsignond_security_context_list_free ()" link="gsignond-GSignondSecurityContext.html#gsignond-security-context-list-free"/> + <keyword type="function" name="gsignond_security_context_list_from_variant ()" link="gsignond-GSignondSecurityContext.html#gsignond-security-context-list-from-variant"/> + <keyword type="function" name="gsignond_security_context_list_to_variant ()" link="gsignond-GSignondSecurityContext.html#gsignond-security-context-list-to-variant"/> + <keyword type="function" name="gsignond_security_context_match ()" link="gsignond-GSignondSecurityContext.html#gsignond-security-context-match"/> + <keyword type="function" name="gsignond_security_context_new ()" link="gsignond-GSignondSecurityContext.html#gsignond-security-context-new"/> + <keyword type="function" name="gsignond_security_context_new_from_values ()" link="gsignond-GSignondSecurityContext.html#gsignond-security-context-new-from-values"/> + <keyword type="function" name="gsignond_security_context_set_application_context ()" link="gsignond-GSignondSecurityContext.html#gsignond-security-context-set-application-context"/> + <keyword type="function" name="gsignond_security_context_set_system_context ()" link="gsignond-GSignondSecurityContext.html#gsignond-security-context-set-system-context"/> + <keyword type="function" name="gsignond_security_context_to_variant ()" link="gsignond-GSignondSecurityContext.html#gsignond-security-context-to-variant"/> + <keyword type="struct" name="struct GSignondStorageManager" link="GSignondStorageManager.html#GSignondStorageManager-struct"/> + <keyword type="struct" name="struct GSignondStorageManagerClass" link="GSignondStorageManager.html#GSignondStorageManagerClass"/> + <keyword type="function" name="gsignond_storage_manager_delete_storage ()" link="GSignondStorageManager.html#gsignond-storage-manager-delete-storage"/> + <keyword type="function" name="gsignond_storage_manager_filesystem_is_mounted ()" link="GSignondStorageManager.html#gsignond-storage-manager-filesystem-is-mounted"/> + <keyword type="function" name="gsignond_storage_manager_initialize_storage ()" link="GSignondStorageManager.html#gsignond-storage-manager-initialize-storage"/> + <keyword type="function" name="gsignond_storage_manager_mount_filesystem ()" link="GSignondStorageManager.html#gsignond-storage-manager-mount-filesystem"/> + <keyword type="function" name="gsignond_storage_manager_storage_is_initialized ()" link="GSignondStorageManager.html#gsignond-storage-manager-storage-is-initialized"/> + <keyword type="function" name="gsignond_storage_manager_unmount_filesystem ()" link="GSignondStorageManager.html#gsignond-storage-manager-unmount-filesystem"/> + <keyword type="property" name="The "config" property" link="GSignondStorageManager.html#GSignondStorageManager--config"/> + <keyword type="struct" name="GSignondSecretStorage" link="GSignondSecretStorage.html#GSignondSecretStorage-struct"/> + <keyword type="struct" name="GSignondSecretStorageClass" link="GSignondSecretStorage.html#GSignondSecretStorageClass"/> + <keyword type="function" name="gsignond_secret_storage_check_credentials ()" link="GSignondSecretStorage.html#gsignond-secret-storage-check-credentials"/> + <keyword type="function" name="gsignond_secret_storage_clear_db ()" link="GSignondSecretStorage.html#gsignond-secret-storage-clear-db"/> + <keyword type="function" name="gsignond_secret_storage_close_db ()" link="GSignondSecretStorage.html#gsignond-secret-storage-close-db"/> + <keyword type="function" name="gsignond_secret_storage_get_last_error ()" link="GSignondSecretStorage.html#gsignond-secret-storage-get-last-error"/> + <keyword type="function" name="gsignond_secret_storage_is_open_db ()" link="GSignondSecretStorage.html#gsignond-secret-storage-is-open-db"/> + <keyword type="function" name="gsignond_secret_storage_load_credentials ()" link="GSignondSecretStorage.html#gsignond-secret-storage-load-credentials"/> + <keyword type="function" name="gsignond_secret_storage_load_data ()" link="GSignondSecretStorage.html#gsignond-secret-storage-load-data"/> + <keyword type="function" name="gsignond_secret_storage_open_db ()" link="GSignondSecretStorage.html#gsignond-secret-storage-open-db"/> + <keyword type="function" name="gsignond_secret_storage_remove_credentials ()" link="GSignondSecretStorage.html#gsignond-secret-storage-remove-credentials"/> + <keyword type="function" name="gsignond_secret_storage_remove_data ()" link="GSignondSecretStorage.html#gsignond-secret-storage-remove-data"/> + <keyword type="function" name="gsignond_secret_storage_update_credentials ()" link="GSignondSecretStorage.html#gsignond-secret-storage-update-credentials"/> + <keyword type="function" name="gsignond_secret_storage_update_data ()" link="GSignondSecretStorage.html#gsignond-secret-storage-update-data"/> + <keyword type="property" name="The "config" property" link="GSignondSecretStorage.html#GSignondSecretStorage--config"/> + <keyword type="struct" name="GSignondCredentials" link="GSignondCredentials.html#GSignondCredentials-struct"/> + <keyword type="struct" name="GSignondCredentialsClass" link="GSignondCredentials.html#GSignondCredentialsClass"/> + <keyword type="function" name="gsignond_credentials_equal ()" link="GSignondCredentials.html#gsignond-credentials-equal"/> + <keyword type="function" name="gsignond_credentials_get_id ()" link="GSignondCredentials.html#gsignond-credentials-get-id"/> + <keyword type="function" name="gsignond_credentials_get_password ()" link="GSignondCredentials.html#gsignond-credentials-get-password"/> + <keyword type="function" name="gsignond_credentials_get_username ()" link="GSignondCredentials.html#gsignond-credentials-get-username"/> + <keyword type="function" name="gsignond_credentials_new ()" link="GSignondCredentials.html#gsignond-credentials-new"/> + <keyword type="function" name="gsignond_credentials_set_data ()" link="GSignondCredentials.html#gsignond-credentials-set-data"/> + <keyword type="function" name="gsignond_credentials_set_id ()" link="GSignondCredentials.html#gsignond-credentials-set-id"/> + <keyword type="function" name="gsignond_credentials_set_password ()" link="GSignondCredentials.html#gsignond-credentials-set-password"/> + <keyword type="function" name="gsignond_credentials_set_username ()" link="GSignondCredentials.html#gsignond-credentials-set-username"/> + <keyword type="macro" name="GSIGNOND_ERROR" link="gsignond-Errors.html#GSIGNOND-ERROR:CAPS"/> + <keyword type="enum" name="enum GSignondError" link="gsignond-Errors.html#GSignondError"/> + <keyword type="function" name="gsignond_error_new_from_variant ()" link="gsignond-Errors.html#gsignond-error-new-from-variant"/> + <keyword type="function" name="gsignond_error_quark ()" link="gsignond-Errors.html#gsignond-error-quark"/> + <keyword type="function" name="gsignond_error_to_variant ()" link="gsignond-Errors.html#gsignond-error-to-variant"/> + <keyword type="macro" name="gsignond_get_gerror_for_id()" link="gsignond-Errors.html#gsignond-get-gerror-for-id"/> + <keyword type="macro" name="DBG()" link="gsignond-Logging.html#DBG:CAPS"/> + <keyword type="macro" name="ERR()" link="gsignond-Logging.html#ERR:CAPS"/> + <keyword type="macro" name="INFO()" link="gsignond-Logging.html#INFO:CAPS"/> + <keyword type="macro" name="TRACEBACK" link="gsignond-Logging.html#TRACEBACK:CAPS"/> + <keyword type="macro" name="WARN()" link="gsignond-Logging.html#WARN:CAPS"/> + <keyword type="function" name="gsignond_generate_nonce ()" link="gsignond-Utility-functions.html#gsignond-generate-nonce"/> + <keyword type="function" name="gsignond_wipe_directory ()" link="gsignond-Utility-functions.html#gsignond-wipe-directory"/> + <keyword type="function" name="gsignond_wipe_file ()" link="gsignond-Utility-functions.html#gsignond-wipe-file"/> + <keyword type="constant" name="GSIGNOND_PLUGIN_STATE_NONE" link="gsignond-GSignondPlugin.html#GSIGNOND-PLUGIN-STATE-NONE:CAPS"/> + <keyword type="constant" name="GSIGNOND_PLUGIN_STATE_RESOLVING" link="gsignond-GSignondPlugin.html#GSIGNOND-PLUGIN-STATE-RESOLVING:CAPS"/> + <keyword type="constant" name="GSIGNOND_PLUGIN_STATE_CONNECTING" link="gsignond-GSignondPlugin.html#GSIGNOND-PLUGIN-STATE-CONNECTING:CAPS"/> + <keyword type="constant" name="GSIGNOND_PLUGIN_STATE_SENDING_DATA" link="gsignond-GSignondPlugin.html#GSIGNOND-PLUGIN-STATE-SENDING-DATA:CAPS"/> + <keyword type="constant" name="GSIGNOND_PLUGIN_STATE_WAITING" link="gsignond-GSignondPlugin.html#GSIGNOND-PLUGIN-STATE-WAITING:CAPS"/> + <keyword type="constant" name="GSIGNOND_PLUGIN_STATE_USER_PENDING" link="gsignond-GSignondPlugin.html#GSIGNOND-PLUGIN-STATE-USER-PENDING:CAPS"/> + <keyword type="constant" name="GSIGNOND_PLUGIN_STATE_REFRESHING" link="gsignond-GSignondPlugin.html#GSIGNOND-PLUGIN-STATE-REFRESHING:CAPS"/> + <keyword type="constant" name="GSIGNOND_PLUGIN_STATE_PROCESS_PENDING" link="gsignond-GSignondPlugin.html#GSIGNOND-PLUGIN-STATE-PROCESS-PENDING:CAPS"/> + <keyword type="constant" name="GSIGNOND_PLUGIN_STATE_STARTED" link="gsignond-GSignondPlugin.html#GSIGNOND-PLUGIN-STATE-STARTED:CAPS"/> + <keyword type="constant" name="GSIGNOND_PLUGIN_STATE_CANCELING" link="gsignond-GSignondPlugin.html#GSIGNOND-PLUGIN-STATE-CANCELING:CAPS"/> + <keyword type="constant" name="GSIGNOND_PLUGIN_STATE_DONE" link="gsignond-GSignondPlugin.html#GSIGNOND-PLUGIN-STATE-DONE:CAPS"/> + <keyword type="constant" name="GSIGNOND_PLUGIN_STATE_HOLDING" link="gsignond-GSignondPlugin.html#GSIGNOND-PLUGIN-STATE-HOLDING:CAPS"/> + <keyword type="constant" name="GSIGNOND_UI_POLICY_DEFAULT" link="gsignond-GSignondSessionData.html#GSIGNOND-UI-POLICY-DEFAULT:CAPS"/> + <keyword type="constant" name="GSIGNOND_UI_POLICY_REQUEST_PASSWORD" link="gsignond-GSignondSessionData.html#GSIGNOND-UI-POLICY-REQUEST-PASSWORD:CAPS"/> + <keyword type="constant" name="GSIGNOND_UI_POLICY_NO_USER_INTERACTION" link="gsignond-GSignondSessionData.html#GSIGNOND-UI-POLICY-NO-USER-INTERACTION:CAPS"/> + <keyword type="constant" name="GSIGNOND_UI_POLICY_VALIDATION" link="gsignond-GSignondSessionData.html#GSIGNOND-UI-POLICY-VALIDATION:CAPS"/> + <keyword type="constant" name="SIGNONUI_ERROR_NONE" link="gsignond-GSignondSignonuiData.html#SIGNONUI-ERROR-NONE:CAPS"/> + <keyword type="constant" name="SIGNONUI_ERROR_GENERAL" link="gsignond-GSignondSignonuiData.html#SIGNONUI-ERROR-GENERAL:CAPS"/> + <keyword type="constant" name="SIGNONUI_ERROR_NO_SIGNONUI" link="gsignond-GSignondSignonuiData.html#SIGNONUI-ERROR-NO-SIGNONUI:CAPS"/> + <keyword type="constant" name="SIGNONUI_ERROR_BAD_PARAMETERS" link="gsignond-GSignondSignonuiData.html#SIGNONUI-ERROR-BAD-PARAMETERS:CAPS"/> + <keyword type="constant" name="SIGNONUI_ERROR_CANCELED" link="gsignond-GSignondSignonuiData.html#SIGNONUI-ERROR-CANCELED:CAPS"/> + <keyword type="constant" name="SIGNONUI_ERROR_NOT_AVAILABLE" link="gsignond-GSignondSignonuiData.html#SIGNONUI-ERROR-NOT-AVAILABLE:CAPS"/> + <keyword type="constant" name="SIGNONUI_ERROR_BAD_URL" link="gsignond-GSignondSignonuiData.html#SIGNONUI-ERROR-BAD-URL:CAPS"/> + <keyword type="constant" name="SIGNONUI_ERROR_BAD_CAPTCHA" link="gsignond-GSignondSignonuiData.html#SIGNONUI-ERROR-BAD-CAPTCHA:CAPS"/> + <keyword type="constant" name="SIGNONUI_ERROR_BAD_CAPTCHA_URL" link="gsignond-GSignondSignonuiData.html#SIGNONUI-ERROR-BAD-CAPTCHA-URL:CAPS"/> + <keyword type="constant" name="SIGNONUI_ERROR_REFRESH_FAILED" link="gsignond-GSignondSignonuiData.html#SIGNONUI-ERROR-REFRESH-FAILED:CAPS"/> + <keyword type="constant" name="SIGNONUI_ERROR_FORBIDDEN" link="gsignond-GSignondSignonuiData.html#SIGNONUI-ERROR-FORBIDDEN:CAPS"/> + <keyword type="constant" name="SIGNONUI_ERROR_FORGOT_PASSWORD" link="gsignond-GSignondSignonuiData.html#SIGNONUI-ERROR-FORGOT-PASSWORD:CAPS"/> + <keyword type="constant" name="GSIGNOND_ERROR_NONE" link="gsignond-Errors.html#GSIGNOND-ERROR-NONE:CAPS"/> + <keyword type="constant" name="GSIGNOND_ERROR_UNKNOWN" link="gsignond-Errors.html#GSIGNOND-ERROR-UNKNOWN:CAPS"/> + <keyword type="constant" name="GSIGNOND_ERROR_INTERNAL_SERVER" link="gsignond-Errors.html#GSIGNOND-ERROR-INTERNAL-SERVER:CAPS"/> + <keyword type="constant" name="GSIGNOND_ERROR_INTERNAL_COMMUNICATION" link="gsignond-Errors.html#GSIGNOND-ERROR-INTERNAL-COMMUNICATION:CAPS"/> + <keyword type="constant" name="GSIGNOND_ERROR_PERMISSION_DENIED" link="gsignond-Errors.html#GSIGNOND-ERROR-PERMISSION-DENIED:CAPS"/> + <keyword type="constant" name="GSIGNOND_ERROR_ENCRYPTION_FAILURE" link="gsignond-Errors.html#GSIGNOND-ERROR-ENCRYPTION-FAILURE:CAPS"/> + <keyword type="constant" name="GSIGNOND_ERROR_AUTH_SERVICE_ERR" link="gsignond-Errors.html#GSIGNOND-ERROR-AUTH-SERVICE-ERR:CAPS"/> + <keyword type="constant" name="GSIGNOND_ERROR_METHOD_NOT_KNOWN" link="gsignond-Errors.html#GSIGNOND-ERROR-METHOD-NOT-KNOWN:CAPS"/> + <keyword type="constant" name="GSIGNOND_ERROR_SERVICE_NOT_AVAILABLE" link="gsignond-Errors.html#GSIGNOND-ERROR-SERVICE-NOT-AVAILABLE:CAPS"/> + <keyword type="constant" name="GSIGNOND_ERROR_INVALID_QUERY" link="gsignond-Errors.html#GSIGNOND-ERROR-INVALID-QUERY:CAPS"/> + <keyword type="constant" name="GSIGNOND_ERROR_IDENTITY_ERR" link="gsignond-Errors.html#GSIGNOND-ERROR-IDENTITY-ERR:CAPS"/> + <keyword type="constant" name="GSIGNOND_ERROR_METHOD_NOT_AVAILABLE" link="gsignond-Errors.html#GSIGNOND-ERROR-METHOD-NOT-AVAILABLE:CAPS"/> + <keyword type="constant" name="GSIGNOND_ERROR_IDENTITY_NOT_FOUND" link="gsignond-Errors.html#GSIGNOND-ERROR-IDENTITY-NOT-FOUND:CAPS"/> + <keyword type="constant" name="GSIGNOND_ERROR_STORE_FAILED" link="gsignond-Errors.html#GSIGNOND-ERROR-STORE-FAILED:CAPS"/> + <keyword type="constant" name="GSIGNOND_ERROR_REMOVE_FAILED" link="gsignond-Errors.html#GSIGNOND-ERROR-REMOVE-FAILED:CAPS"/> + <keyword type="constant" name="GSIGNOND_ERROR_SIGN_OUT_FAILED" link="gsignond-Errors.html#GSIGNOND-ERROR-SIGN-OUT-FAILED:CAPS"/> + <keyword type="constant" name="GSIGNOND_ERROR_IDENTITY_OPERATION_CANCELED" link="gsignond-Errors.html#GSIGNOND-ERROR-IDENTITY-OPERATION-CANCELED:CAPS"/> + <keyword type="constant" name="GSIGNOND_ERROR_CREDENTIALS_NOT_AVAILABLE" link="gsignond-Errors.html#GSIGNOND-ERROR-CREDENTIALS-NOT-AVAILABLE:CAPS"/> + <keyword type="constant" name="GSIGNOND_ERROR_REFERENCE_NOT_FOUND" link="gsignond-Errors.html#GSIGNOND-ERROR-REFERENCE-NOT-FOUND:CAPS"/> + <keyword type="constant" name="GSIGNOND_ERROR_AUTH_SESSION_ERR" link="gsignond-Errors.html#GSIGNOND-ERROR-AUTH-SESSION-ERR:CAPS"/> + <keyword type="constant" name="GSIGNOND_ERROR_MECHANISM_NOT_AVAILABLE" link="gsignond-Errors.html#GSIGNOND-ERROR-MECHANISM-NOT-AVAILABLE:CAPS"/> + <keyword type="constant" name="GSIGNOND_ERROR_MISSING_DATA" link="gsignond-Errors.html#GSIGNOND-ERROR-MISSING-DATA:CAPS"/> + <keyword type="constant" name="GSIGNOND_ERROR_INVALID_CREDENTIALS" link="gsignond-Errors.html#GSIGNOND-ERROR-INVALID-CREDENTIALS:CAPS"/> + <keyword type="constant" name="GSIGNOND_ERROR_NOT_AUTHORIZED" link="gsignond-Errors.html#GSIGNOND-ERROR-NOT-AUTHORIZED:CAPS"/> + <keyword type="constant" name="GSIGNOND_ERROR_WRONG_STATE" link="gsignond-Errors.html#GSIGNOND-ERROR-WRONG-STATE:CAPS"/> + <keyword type="constant" name="GSIGNOND_ERROR_OPERATION_NOT_SUPPORTED" link="gsignond-Errors.html#GSIGNOND-ERROR-OPERATION-NOT-SUPPORTED:CAPS"/> + <keyword type="constant" name="GSIGNOND_ERROR_NO_CONNECTION" link="gsignond-Errors.html#GSIGNOND-ERROR-NO-CONNECTION:CAPS"/> + <keyword type="constant" name="GSIGNOND_ERROR_NETWORK" link="gsignond-Errors.html#GSIGNOND-ERROR-NETWORK:CAPS"/> + <keyword type="constant" name="GSIGNOND_ERROR_SSL" link="gsignond-Errors.html#GSIGNOND-ERROR-SSL:CAPS"/> + <keyword type="constant" name="GSIGNOND_ERROR_RUNTIME" link="gsignond-Errors.html#GSIGNOND-ERROR-RUNTIME:CAPS"/> + <keyword type="constant" name="GSIGNOND_ERROR_SESSION_CANCELED" link="gsignond-Errors.html#GSIGNOND-ERROR-SESSION-CANCELED:CAPS"/> + <keyword type="constant" name="GSIGNOND_ERROR_TIMED_OUT" link="gsignond-Errors.html#GSIGNOND-ERROR-TIMED-OUT:CAPS"/> + <keyword type="constant" name="GSIGNOND_ERROR_USER_INTERACTION" link="gsignond-Errors.html#GSIGNOND-ERROR-USER-INTERACTION:CAPS"/> + <keyword type="constant" name="GSIGNOND_ERROR_OPERATION_FAILED" link="gsignond-Errors.html#GSIGNOND-ERROR-OPERATION-FAILED:CAPS"/> + <keyword type="constant" name="GSIGNOND_ERROR_ENCRYPTION_FAILED" link="gsignond-Errors.html#GSIGNOND-ERROR-ENCRYPTION-FAILED:CAPS"/> + <keyword type="constant" name="GSIGNOND_ERROR_TOS_NOT_ACCEPTED" link="gsignond-Errors.html#GSIGNOND-ERROR-TOS-NOT-ACCEPTED:CAPS"/> + <keyword type="constant" name="GSIGNOND_ERROR_FORGOT_PASSWORD" link="gsignond-Errors.html#GSIGNOND-ERROR-FORGOT-PASSWORD:CAPS"/> + <keyword type="constant" name="GSIGNOND_ERROR_METHOD_OR_MECHANISM_NOT_ALLOWED" link="gsignond-Errors.html#GSIGNOND-ERROR-METHOD-OR-MECHANISM-NOT-ALLOWED:CAPS"/> + <keyword type="constant" name="GSIGNOND_ERROR_INCORRECT_DATE" link="gsignond-Errors.html#GSIGNOND-ERROR-INCORRECT-DATE:CAPS"/> + <keyword type="constant" name="GSIGNOND_ERROR_USER_ERR" link="gsignond-Errors.html#GSIGNOND-ERROR-USER-ERR:CAPS"/> + </functions> +</book> diff --git a/docs/html/home.png b/docs/html/home.png Binary files differnew file mode 100644 index 0000000..9346b33 --- /dev/null +++ b/docs/html/home.png diff --git a/docs/html/index.html b/docs/html/index.html new file mode 100644 index 0000000..7f2313d --- /dev/null +++ b/docs/html/index.html @@ -0,0 +1,116 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>gsignond API Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="gsignond API Reference Manual"> +<link rel="next" href="ch01.html" title="GSignond building and installation"> +<meta name="generator" content="GTK-Doc V1.19.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<div class="book"> +<div class="titlepage"> +<div> +<div><table class="navigation" id="top" width="100%" cellpadding="2" cellspacing="0"><tr><th valign="middle"><p class="title">gsignond API Reference Manual</p></th></tr></table></div> +<div><p class="releaseinfo"> + for gsignond daemon. + The latest version of this documentation can be found on-line at + <a class="ulink" href="http://gsignon-docs.accounts-sso.googlecode.com/git/gsignond/index.html" target="_top"> + http://gsignon-docs.accounts-sso.googlecode.com/git/gsignond/index.html</a>. + </p></div> +</div> +<hr> +</div> +<div class="toc"><dl> +<dt><span class="chapter"><a href="ch01.html">GSignond building and installation</a></span></dt> +<dd><dl><dt> +<span class="refentrytitle"><a href="gsignond-building.html">Building and installing the gsignond daemon</a></span><span class="refpurpose"></span> +</dt></dl></dd> +<dt><span class="chapter"><a href="ch02.html">GSignond configuration</a></span></dt> +<dd><dl> +<dt> +<span class="refentrytitle"><a href="GSignondConfig.html">GSignondConfig</a></span><span class="refpurpose"> — gSSO configuration information</span> +</dt> +<dt> +<span class="refentrytitle"><a href="gsignond-General-configuration.html">General configuration</a></span><span class="refpurpose"> — gSSO general configuration keys</span> +</dt> +<dt> +<span class="refentrytitle"><a href="gsignond-Database-configuration.html">Database configuration</a></span><span class="refpurpose"> — gSSO database configuration keys</span> +</dt> +<dt> +<span class="refentrytitle"><a href="gsignond-DBus-configuration.html">DBus configuration</a></span><span class="refpurpose"> — gSSO dbus configuration keys</span> +</dt> +</dl></dd> +<dt><span class="chapter"><a href="ch03.html">GSignond API for writing authentication plugins</a></span></dt> +<dd><dl> +<dt> +<span class="refentrytitle"><a href="gsignond-GSignondPlugin.html">GSignondPlugin</a></span><span class="refpurpose"> — an interface for implementing authentication plugins</span> +</dt> +<dt> +<span class="refentrytitle"><a href="gsignond-GSignondDictionary.html">GSignondDictionary</a></span><span class="refpurpose"> — a dictionary container holding string keys and variant values</span> +</dt> +<dt> +<span class="refentrytitle"><a href="gsignond-GSignondSessionData.html">GSignondSessionData</a></span><span class="refpurpose"> — definitions for authentication session parameters</span> +</dt> +<dt> +<span class="refentrytitle"><a href="gsignond-GSignondSignonuiData.html">GSignondSignonuiData</a></span><span class="refpurpose"> — definitions for user interaction parameters</span> +</dt> +</dl></dd> +<dt><span class="chapter"><a href="ch04.html">Standard in-tree authentication plugins</a></span></dt> +<dd><dl> +<dt> +<span class="refentrytitle"><a href="GSignondDigestPlugin.html">GSignondDigestPlugin</a></span><span class="refpurpose"> — a plugin that performs HTTP Digest authentication</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GSignondSsoTestPlugin.html">GSignondSsoTestPlugin</a></span><span class="refpurpose"> — a plugin that is used internally in gsignond unit test</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GSignondPasswordPlugin.html">GSignondPasswordPlugin</a></span><span class="refpurpose"> — a plugin for retrieving the username/password</span> +</dt> +</dl></dd> +<dt><span class="chapter"><a href="ch05.html">GSignond API for writing platform adaptation extensions</a></span></dt> +<dd><dl> +<dt> +<span class="refentrytitle"><a href="GSignondExtension.html">GSignondExtension</a></span><span class="refpurpose"> — provides platform adaptation functionality</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GSignondAccessControlManager.html">GSignondAccessControlManager</a></span><span class="refpurpose"> — an object that performs access control checks</span> +</dt> +<dt> +<span class="refentrytitle"><a href="gsignond-GSignondSecurityContext.html">GSignondSecurityContext</a></span><span class="refpurpose"> — security context descriptor used in access control checks</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GSignondStorageManager.html">GSignondStorageManager</a></span><span class="refpurpose"> — manages encrypted disk storage for storing the secret database</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GSignondSecretStorage.html">GSignondSecretStorage</a></span><span class="refpurpose"> — provides access to the database that stores user credentials and identity/method cache</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GSignondCredentials.html">GSignondCredentials</a></span><span class="refpurpose"> — credentials (username, password) associated with an identity</span> +</dt> +</dl></dd> +<dt><span class="chapter"><a href="ch06.html">Miscellaneous</a></span></dt> +<dd><dl> +<dt> +<span class="refentrytitle"><a href="gsignond-Errors.html">Errors</a></span><span class="refpurpose"> — error definitions and utilities</span> +</dt> +<dt> +<span class="refentrytitle"><a href="gsignond-Logging.html">Logging</a></span><span class="refpurpose"> — logging facilities</span> +</dt> +<dt> +<span class="refentrytitle"><a href="gsignond-Utility-functions.html">Utility functions</a></span><span class="refpurpose"> — miscellaneous utility functions</span> +</dt> +</dl></dd> +<dt><span class="chapter"><a href="object-tree.html">Object Hierarchy</a></span></dt> +<dt><span class="index"><a href="api-index-full.html">API Index</a></span></dt> +<dt><span class="index"><a href="deprecated-api-index.html">Index of deprecated API</a></span></dt> +<dt><span class="glossary"><a href="annotation-glossary.html">Annotation Glossary</a></span></dt> +</dl></div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.19.1</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/html/index.sgml b/docs/html/index.sgml new file mode 100644 index 0000000..0a1fd7c --- /dev/null +++ b/docs/html/index.sgml @@ -0,0 +1,381 @@ +<ONLINE href="http://gsignon-docs.accounts-sso.googlecode.com/git/gsignond/index.html"> +<ANCHOR id="gsignond-building" href="gsignond/gsignond-building.html"> +<ANCHOR id="building" href="gsignond/gsignond-building.html#building"> +<ANCHOR id="dependencies" href="gsignond/gsignond-building.html#dependencies"> +<ANCHOR id="extra-configuration-options" href="gsignond/gsignond-building.html#extra-configuration-options"> +<ANCHOR id="building-packages" href="gsignond/gsignond-building.html#building-packages"> +<ANCHOR id="GSignondConfig" href="gsignond/GSignondConfig.html"> +<ANCHOR id="GSignondConfig.synopsis" href="gsignond/GSignondConfig.html#GSignondConfig.synopsis"> +<ANCHOR id="GSignondConfig.object-hierarchy" href="gsignond/GSignondConfig.html#GSignondConfig.object-hierarchy"> +<ANCHOR id="GSignondConfig.description" href="gsignond/GSignondConfig.html#GSignondConfig.description"> +<ANCHOR id="GSignondConfig.details" href="gsignond/GSignondConfig.html#GSignondConfig.details"> +<ANCHOR id="GSignondConfig-struct" href="gsignond/GSignondConfig.html#GSignondConfig-struct"> +<ANCHOR id="GSignondConfigClass" href="gsignond/GSignondConfig.html#GSignondConfigClass"> +<ANCHOR id="gsignond-config-get-integer" href="gsignond/GSignondConfig.html#gsignond-config-get-integer"> +<ANCHOR id="gsignond-config-get-string" href="gsignond/GSignondConfig.html#gsignond-config-get-string"> +<ANCHOR id="gsignond-config-new" href="gsignond/GSignondConfig.html#gsignond-config-new"> +<ANCHOR id="gsignond-config-set-integer" href="gsignond/GSignondConfig.html#gsignond-config-set-integer"> +<ANCHOR id="gsignond-config-set-string" href="gsignond/GSignondConfig.html#gsignond-config-set-string"> +<ANCHOR id="gsignond-General-configuration" href="gsignond/gsignond-General-configuration.html"> +<ANCHOR id="gsignond-General-configuration.synopsis" href="gsignond/gsignond-General-configuration.html#gsignond-General-configuration.synopsis"> +<ANCHOR id="gsignond-General-configuration.description" href="gsignond/gsignond-General-configuration.html#gsignond-General-configuration.description"> +<ANCHOR id="gsignond-General-configuration.details" href="gsignond/gsignond-General-configuration.html#gsignond-General-configuration.details"> +<ANCHOR id="GSIGNOND-CONFIG-GENERAL:CAPS" href="gsignond/gsignond-General-configuration.html#GSIGNOND-CONFIG-GENERAL:CAPS"> +<ANCHOR id="GSIGNOND-CONFIG-GENERAL-BIN-DIR:CAPS" href="gsignond/gsignond-General-configuration.html#GSIGNOND-CONFIG-GENERAL-BIN-DIR:CAPS"> +<ANCHOR id="GSIGNOND-CONFIG-GENERAL-EXTENSION:CAPS" href="gsignond/gsignond-General-configuration.html#GSIGNOND-CONFIG-GENERAL-EXTENSION:CAPS"> +<ANCHOR id="GSIGNOND-CONFIG-GENERAL-EXTENSIONS-DIR:CAPS" href="gsignond/gsignond-General-configuration.html#GSIGNOND-CONFIG-GENERAL-EXTENSIONS-DIR:CAPS"> +<ANCHOR id="GSIGNOND-CONFIG-GENERAL-PLUGINS-DIR:CAPS" href="gsignond/gsignond-General-configuration.html#GSIGNOND-CONFIG-GENERAL-PLUGINS-DIR:CAPS"> +<ANCHOR id="GSIGNOND-CONFIG-GENERAL-SECURE-DIR:CAPS" href="gsignond/gsignond-General-configuration.html#GSIGNOND-CONFIG-GENERAL-SECURE-DIR:CAPS"> +<ANCHOR id="GSIGNOND-CONFIG-GENERAL-STORAGE-PATH:CAPS" href="gsignond/gsignond-General-configuration.html#GSIGNOND-CONFIG-GENERAL-STORAGE-PATH:CAPS"> +<ANCHOR id="GSIGNOND-CONFIG-PLUGIN-TIMEOUT:CAPS" href="gsignond/gsignond-General-configuration.html#GSIGNOND-CONFIG-PLUGIN-TIMEOUT:CAPS"> +<ANCHOR id="gsignond-Database-configuration" href="gsignond/gsignond-Database-configuration.html"> +<ANCHOR id="gsignond-Database-configuration.synopsis" href="gsignond/gsignond-Database-configuration.html#gsignond-Database-configuration.synopsis"> +<ANCHOR id="gsignond-Database-configuration.description" href="gsignond/gsignond-Database-configuration.html#gsignond-Database-configuration.description"> +<ANCHOR id="gsignond-Database-configuration.details" href="gsignond/gsignond-Database-configuration.html#gsignond-Database-configuration.details"> +<ANCHOR id="GSIGNOND-CONFIG-DB-METADATA-DB-FILENAME:CAPS" href="gsignond/gsignond-Database-configuration.html#GSIGNOND-CONFIG-DB-METADATA-DB-FILENAME:CAPS"> +<ANCHOR id="GSIGNOND-CONFIG-DB-SECRET-DB-FILENAME:CAPS" href="gsignond/gsignond-Database-configuration.html#GSIGNOND-CONFIG-DB-SECRET-DB-FILENAME:CAPS"> +<ANCHOR id="GSIGNOND-CONFIG-DB-SSO:CAPS" href="gsignond/gsignond-Database-configuration.html#GSIGNOND-CONFIG-DB-SSO:CAPS"> +<ANCHOR id="gsignond-DBus-configuration" href="gsignond/gsignond-DBus-configuration.html"> +<ANCHOR id="gsignond-DBus-configuration.synopsis" href="gsignond/gsignond-DBus-configuration.html#gsignond-DBus-configuration.synopsis"> +<ANCHOR id="gsignond-DBus-configuration.description" href="gsignond/gsignond-DBus-configuration.html#gsignond-DBus-configuration.description"> +<ANCHOR id="gsignond-DBus-configuration.details" href="gsignond/gsignond-DBus-configuration.html#gsignond-DBus-configuration.details"> +<ANCHOR id="GSIGNOND-CONFIG-DBUS-AUTH-SESSION-TIMEOUT:CAPS" href="gsignond/gsignond-DBus-configuration.html#GSIGNOND-CONFIG-DBUS-AUTH-SESSION-TIMEOUT:CAPS"> +<ANCHOR id="GSIGNOND-CONFIG-DBUS-DAEMON-TIMEOUT:CAPS" href="gsignond/gsignond-DBus-configuration.html#GSIGNOND-CONFIG-DBUS-DAEMON-TIMEOUT:CAPS"> +<ANCHOR id="GSIGNOND-CONFIG-DBUS-IDENTITY-TIMEOUT:CAPS" href="gsignond/gsignond-DBus-configuration.html#GSIGNOND-CONFIG-DBUS-IDENTITY-TIMEOUT:CAPS"> +<ANCHOR id="GSIGNOND-CONFIG-DBUS-TIMEOUTS:CAPS" href="gsignond/gsignond-DBus-configuration.html#GSIGNOND-CONFIG-DBUS-TIMEOUTS:CAPS"> +<ANCHOR id="gsignond-GSignondPlugin" href="gsignond/gsignond-GSignondPlugin.html"> +<ANCHOR id="gsignond-GSignondPlugin.synopsis" href="gsignond/gsignond-GSignondPlugin.html#gsignond-GSignondPlugin.synopsis"> +<ANCHOR id="gsignond-GSignondPlugin.description" href="gsignond/gsignond-GSignondPlugin.html#gsignond-GSignondPlugin.description"> +<ANCHOR id="gsignond-GSignondPlugin.details" href="gsignond/gsignond-GSignondPlugin.html#gsignond-GSignondPlugin.details"> +<ANCHOR id="GSignondPluginInterface" href="gsignond/gsignond-GSignondPlugin.html#GSignondPluginInterface"> +<ANCHOR id="GSignondPluginState" href="gsignond/gsignond-GSignondPlugin.html#GSignondPluginState"> +<ANCHOR id="GSIGNOND-PLUGIN-STATE-NONE:CAPS" href="gsignond/gsignond-GSignondPlugin.html#GSIGNOND-PLUGIN-STATE-NONE:CAPS"> +<ANCHOR id="GSIGNOND-PLUGIN-STATE-RESOLVING:CAPS" href="gsignond/gsignond-GSignondPlugin.html#GSIGNOND-PLUGIN-STATE-RESOLVING:CAPS"> +<ANCHOR id="GSIGNOND-PLUGIN-STATE-CONNECTING:CAPS" href="gsignond/gsignond-GSignondPlugin.html#GSIGNOND-PLUGIN-STATE-CONNECTING:CAPS"> +<ANCHOR id="GSIGNOND-PLUGIN-STATE-SENDING-DATA:CAPS" href="gsignond/gsignond-GSignondPlugin.html#GSIGNOND-PLUGIN-STATE-SENDING-DATA:CAPS"> +<ANCHOR id="GSIGNOND-PLUGIN-STATE-WAITING:CAPS" href="gsignond/gsignond-GSignondPlugin.html#GSIGNOND-PLUGIN-STATE-WAITING:CAPS"> +<ANCHOR id="GSIGNOND-PLUGIN-STATE-USER-PENDING:CAPS" href="gsignond/gsignond-GSignondPlugin.html#GSIGNOND-PLUGIN-STATE-USER-PENDING:CAPS"> +<ANCHOR id="GSIGNOND-PLUGIN-STATE-REFRESHING:CAPS" href="gsignond/gsignond-GSignondPlugin.html#GSIGNOND-PLUGIN-STATE-REFRESHING:CAPS"> +<ANCHOR id="GSIGNOND-PLUGIN-STATE-PROCESS-PENDING:CAPS" href="gsignond/gsignond-GSignondPlugin.html#GSIGNOND-PLUGIN-STATE-PROCESS-PENDING:CAPS"> +<ANCHOR id="GSIGNOND-PLUGIN-STATE-STARTED:CAPS" href="gsignond/gsignond-GSignondPlugin.html#GSIGNOND-PLUGIN-STATE-STARTED:CAPS"> +<ANCHOR id="GSIGNOND-PLUGIN-STATE-CANCELING:CAPS" href="gsignond/gsignond-GSignondPlugin.html#GSIGNOND-PLUGIN-STATE-CANCELING:CAPS"> +<ANCHOR id="GSIGNOND-PLUGIN-STATE-DONE:CAPS" href="gsignond/gsignond-GSignondPlugin.html#GSIGNOND-PLUGIN-STATE-DONE:CAPS"> +<ANCHOR id="GSIGNOND-PLUGIN-STATE-HOLDING:CAPS" href="gsignond/gsignond-GSignondPlugin.html#GSIGNOND-PLUGIN-STATE-HOLDING:CAPS"> +<ANCHOR id="gsignond-plugin-cancel" href="gsignond/gsignond-GSignondPlugin.html#gsignond-plugin-cancel"> +<ANCHOR id="gsignond-plugin-error" href="gsignond/gsignond-GSignondPlugin.html#gsignond-plugin-error"> +<ANCHOR id="gsignond-plugin-refresh" href="gsignond/gsignond-GSignondPlugin.html#gsignond-plugin-refresh"> +<ANCHOR id="gsignond-plugin-refreshed" href="gsignond/gsignond-GSignondPlugin.html#gsignond-plugin-refreshed"> +<ANCHOR id="gsignond-plugin-request" href="gsignond/gsignond-GSignondPlugin.html#gsignond-plugin-request"> +<ANCHOR id="gsignond-plugin-request-initial" href="gsignond/gsignond-GSignondPlugin.html#gsignond-plugin-request-initial"> +<ANCHOR id="gsignond-plugin-response" href="gsignond/gsignond-GSignondPlugin.html#gsignond-plugin-response"> +<ANCHOR id="gsignond-plugin-response-final" href="gsignond/gsignond-GSignondPlugin.html#gsignond-plugin-response-final"> +<ANCHOR id="gsignond-plugin-status-changed" href="gsignond/gsignond-GSignondPlugin.html#gsignond-plugin-status-changed"> +<ANCHOR id="gsignond-plugin-store" href="gsignond/gsignond-GSignondPlugin.html#gsignond-plugin-store"> +<ANCHOR id="gsignond-plugin-user-action-finished" href="gsignond/gsignond-GSignondPlugin.html#gsignond-plugin-user-action-finished"> +<ANCHOR id="gsignond-plugin-user-action-required" href="gsignond/gsignond-GSignondPlugin.html#gsignond-plugin-user-action-required"> +<ANCHOR id="gsignond-GSignondDictionary" href="gsignond/gsignond-GSignondDictionary.html"> +<ANCHOR id="gsignond-GSignondDictionary.synopsis" href="gsignond/gsignond-GSignondDictionary.html#gsignond-GSignondDictionary.synopsis"> +<ANCHOR id="gsignond-GSignondDictionary.description" href="gsignond/gsignond-GSignondDictionary.html#gsignond-GSignondDictionary.description"> +<ANCHOR id="gsignond-GSignondDictionary.details" href="gsignond/gsignond-GSignondDictionary.html#gsignond-GSignondDictionary.details"> +<ANCHOR id="GSignondDictionary" href="gsignond/gsignond-GSignondDictionary.html#GSignondDictionary"> +<ANCHOR id="gsignond-dictionary-copy" href="gsignond/gsignond-GSignondDictionary.html#gsignond-dictionary-copy"> +<ANCHOR id="gsignond-dictionary-get" href="gsignond/gsignond-GSignondDictionary.html#gsignond-dictionary-get"> +<ANCHOR id="gsignond-dictionary-get-boolean" href="gsignond/gsignond-GSignondDictionary.html#gsignond-dictionary-get-boolean"> +<ANCHOR id="gsignond-dictionary-get-int32" href="gsignond/gsignond-GSignondDictionary.html#gsignond-dictionary-get-int32"> +<ANCHOR id="gsignond-dictionary-get-int64" href="gsignond/gsignond-GSignondDictionary.html#gsignond-dictionary-get-int64"> +<ANCHOR id="gsignond-dictionary-get-string" href="gsignond/gsignond-GSignondDictionary.html#gsignond-dictionary-get-string"> +<ANCHOR id="gsignond-dictionary-get-uint32" href="gsignond/gsignond-GSignondDictionary.html#gsignond-dictionary-get-uint32"> +<ANCHOR id="gsignond-dictionary-get-uint64" href="gsignond/gsignond-GSignondDictionary.html#gsignond-dictionary-get-uint64"> +<ANCHOR id="gsignond-dictionary-new" href="gsignond/gsignond-GSignondDictionary.html#gsignond-dictionary-new"> +<ANCHOR id="gsignond-dictionary-new-from-variant" href="gsignond/gsignond-GSignondDictionary.html#gsignond-dictionary-new-from-variant"> +<ANCHOR id="gsignond-dictionary-ref" href="gsignond/gsignond-GSignondDictionary.html#gsignond-dictionary-ref"> +<ANCHOR id="gsignond-dictionary-remove" href="gsignond/gsignond-GSignondDictionary.html#gsignond-dictionary-remove"> +<ANCHOR id="gsignond-dictionary-set" href="gsignond/gsignond-GSignondDictionary.html#gsignond-dictionary-set"> +<ANCHOR id="gsignond-dictionary-set-boolean" href="gsignond/gsignond-GSignondDictionary.html#gsignond-dictionary-set-boolean"> +<ANCHOR id="gsignond-dictionary-set-int32" href="gsignond/gsignond-GSignondDictionary.html#gsignond-dictionary-set-int32"> +<ANCHOR id="gsignond-dictionary-set-int64" href="gsignond/gsignond-GSignondDictionary.html#gsignond-dictionary-set-int64"> +<ANCHOR id="gsignond-dictionary-set-string" href="gsignond/gsignond-GSignondDictionary.html#gsignond-dictionary-set-string"> +<ANCHOR id="gsignond-dictionary-set-uint32" href="gsignond/gsignond-GSignondDictionary.html#gsignond-dictionary-set-uint32"> +<ANCHOR id="gsignond-dictionary-set-uint64" href="gsignond/gsignond-GSignondDictionary.html#gsignond-dictionary-set-uint64"> +<ANCHOR id="gsignond-dictionary-to-variant" href="gsignond/gsignond-GSignondDictionary.html#gsignond-dictionary-to-variant"> +<ANCHOR id="gsignond-dictionary-unref" href="gsignond/gsignond-GSignondDictionary.html#gsignond-dictionary-unref"> +<ANCHOR id="gsignond-GSignondSessionData" href="gsignond/gsignond-GSignondSessionData.html"> +<ANCHOR id="gsignond-GSignondSessionData.synopsis" href="gsignond/gsignond-GSignondSessionData.html#gsignond-GSignondSessionData.synopsis"> +<ANCHOR id="gsignond-GSignondSessionData.description" href="gsignond/gsignond-GSignondSessionData.html#gsignond-GSignondSessionData.description"> +<ANCHOR id="gsignond-GSignondSessionData.details" href="gsignond/gsignond-GSignondSessionData.html#gsignond-GSignondSessionData.details"> +<ANCHOR id="GSignondSessionData" href="gsignond/gsignond-GSignondSessionData.html#GSignondSessionData"> +<ANCHOR id="GSignondUiPolicy" href="gsignond/gsignond-GSignondSessionData.html#GSignondUiPolicy"> +<ANCHOR id="GSIGNOND-UI-POLICY-DEFAULT:CAPS" href="gsignond/gsignond-GSignondSessionData.html#GSIGNOND-UI-POLICY-DEFAULT:CAPS"> +<ANCHOR id="GSIGNOND-UI-POLICY-REQUEST-PASSWORD:CAPS" href="gsignond/gsignond-GSignondSessionData.html#GSIGNOND-UI-POLICY-REQUEST-PASSWORD:CAPS"> +<ANCHOR id="GSIGNOND-UI-POLICY-NO-USER-INTERACTION:CAPS" href="gsignond/gsignond-GSignondSessionData.html#GSIGNOND-UI-POLICY-NO-USER-INTERACTION:CAPS"> +<ANCHOR id="GSIGNOND-UI-POLICY-VALIDATION:CAPS" href="gsignond/gsignond-GSignondSessionData.html#GSIGNOND-UI-POLICY-VALIDATION:CAPS"> +<ANCHOR id="gsignond-session-data-get-caption" href="gsignond/gsignond-GSignondSessionData.html#gsignond-session-data-get-caption"> +<ANCHOR id="gsignond-session-data-get-network-proxy" href="gsignond/gsignond-GSignondSessionData.html#gsignond-session-data-get-network-proxy"> +<ANCHOR id="gsignond-session-data-get-network-timeout" href="gsignond/gsignond-GSignondSessionData.html#gsignond-session-data-get-network-timeout"> +<ANCHOR id="gsignond-session-data-get-realm" href="gsignond/gsignond-GSignondSessionData.html#gsignond-session-data-get-realm"> +<ANCHOR id="gsignond-session-data-get-renew-token" href="gsignond/gsignond-GSignondSessionData.html#gsignond-session-data-get-renew-token"> +<ANCHOR id="gsignond-session-data-get-secret" href="gsignond/gsignond-GSignondSessionData.html#gsignond-session-data-get-secret"> +<ANCHOR id="gsignond-session-data-get-ui-policy" href="gsignond/gsignond-GSignondSessionData.html#gsignond-session-data-get-ui-policy"> +<ANCHOR id="gsignond-session-data-get-username" href="gsignond/gsignond-GSignondSessionData.html#gsignond-session-data-get-username"> +<ANCHOR id="gsignond-session-data-get-window-id" href="gsignond/gsignond-GSignondSessionData.html#gsignond-session-data-get-window-id"> +<ANCHOR id="gsignond-session-data-set-caption" href="gsignond/gsignond-GSignondSessionData.html#gsignond-session-data-set-caption"> +<ANCHOR id="gsignond-session-data-set-network-proxy" href="gsignond/gsignond-GSignondSessionData.html#gsignond-session-data-set-network-proxy"> +<ANCHOR id="gsignond-session-data-set-network-timeout" href="gsignond/gsignond-GSignondSessionData.html#gsignond-session-data-set-network-timeout"> +<ANCHOR id="gsignond-session-data-set-realm" href="gsignond/gsignond-GSignondSessionData.html#gsignond-session-data-set-realm"> +<ANCHOR id="gsignond-session-data-set-renew-token" href="gsignond/gsignond-GSignondSessionData.html#gsignond-session-data-set-renew-token"> +<ANCHOR id="gsignond-session-data-set-secret" href="gsignond/gsignond-GSignondSessionData.html#gsignond-session-data-set-secret"> +<ANCHOR id="gsignond-session-data-set-ui-policy" href="gsignond/gsignond-GSignondSessionData.html#gsignond-session-data-set-ui-policy"> +<ANCHOR id="gsignond-session-data-set-username" href="gsignond/gsignond-GSignondSessionData.html#gsignond-session-data-set-username"> +<ANCHOR id="gsignond-session-data-set-window-id" href="gsignond/gsignond-GSignondSessionData.html#gsignond-session-data-set-window-id"> +<ANCHOR id="gsignond-GSignondSignonuiData" href="gsignond/gsignond-GSignondSignonuiData.html"> +<ANCHOR id="gsignond-GSignondSignonuiData.synopsis" href="gsignond/gsignond-GSignondSignonuiData.html#gsignond-GSignondSignonuiData.synopsis"> +<ANCHOR id="gsignond-GSignondSignonuiData.description" href="gsignond/gsignond-GSignondSignonuiData.html#gsignond-GSignondSignonuiData.description"> +<ANCHOR id="gsignond-GSignondSignonuiData.details" href="gsignond/gsignond-GSignondSignonuiData.html#gsignond-GSignondSignonuiData.details"> +<ANCHOR id="GSignondSignonuiData" href="gsignond/gsignond-GSignondSignonuiData.html#GSignondSignonuiData"> +<ANCHOR id="GSignondSignonuiError" href="gsignond/gsignond-GSignondSignonuiData.html#GSignondSignonuiError"> +<ANCHOR id="SIGNONUI-ERROR-NONE:CAPS" href="gsignond/gsignond-GSignondSignonuiData.html#SIGNONUI-ERROR-NONE:CAPS"> +<ANCHOR id="SIGNONUI-ERROR-GENERAL:CAPS" href="gsignond/gsignond-GSignondSignonuiData.html#SIGNONUI-ERROR-GENERAL:CAPS"> +<ANCHOR id="SIGNONUI-ERROR-NO-SIGNONUI:CAPS" href="gsignond/gsignond-GSignondSignonuiData.html#SIGNONUI-ERROR-NO-SIGNONUI:CAPS"> +<ANCHOR id="SIGNONUI-ERROR-BAD-PARAMETERS:CAPS" href="gsignond/gsignond-GSignondSignonuiData.html#SIGNONUI-ERROR-BAD-PARAMETERS:CAPS"> +<ANCHOR id="SIGNONUI-ERROR-CANCELED:CAPS" href="gsignond/gsignond-GSignondSignonuiData.html#SIGNONUI-ERROR-CANCELED:CAPS"> +<ANCHOR id="SIGNONUI-ERROR-NOT-AVAILABLE:CAPS" href="gsignond/gsignond-GSignondSignonuiData.html#SIGNONUI-ERROR-NOT-AVAILABLE:CAPS"> +<ANCHOR id="SIGNONUI-ERROR-BAD-URL:CAPS" href="gsignond/gsignond-GSignondSignonuiData.html#SIGNONUI-ERROR-BAD-URL:CAPS"> +<ANCHOR id="SIGNONUI-ERROR-BAD-CAPTCHA:CAPS" href="gsignond/gsignond-GSignondSignonuiData.html#SIGNONUI-ERROR-BAD-CAPTCHA:CAPS"> +<ANCHOR id="SIGNONUI-ERROR-BAD-CAPTCHA-URL:CAPS" href="gsignond/gsignond-GSignondSignonuiData.html#SIGNONUI-ERROR-BAD-CAPTCHA-URL:CAPS"> +<ANCHOR id="SIGNONUI-ERROR-REFRESH-FAILED:CAPS" href="gsignond/gsignond-GSignondSignonuiData.html#SIGNONUI-ERROR-REFRESH-FAILED:CAPS"> +<ANCHOR id="SIGNONUI-ERROR-FORBIDDEN:CAPS" href="gsignond/gsignond-GSignondSignonuiData.html#SIGNONUI-ERROR-FORBIDDEN:CAPS"> +<ANCHOR id="SIGNONUI-ERROR-FORGOT-PASSWORD:CAPS" href="gsignond/gsignond-GSignondSignonuiData.html#SIGNONUI-ERROR-FORGOT-PASSWORD:CAPS"> +<ANCHOR id="gsignond-signonui-data-get-captcha-response" href="gsignond/gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-captcha-response"> +<ANCHOR id="gsignond-signonui-data-get-captcha-url" href="gsignond/gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-captcha-url"> +<ANCHOR id="gsignond-signonui-data-get-caption" href="gsignond/gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-caption"> +<ANCHOR id="gsignond-signonui-data-get-confirm" href="gsignond/gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-confirm"> +<ANCHOR id="gsignond-signonui-data-get-final-url" href="gsignond/gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-final-url"> +<ANCHOR id="gsignond-signonui-data-get-forgot-password" href="gsignond/gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-forgot-password"> +<ANCHOR id="gsignond-signonui-data-get-forgot-password-url" href="gsignond/gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-forgot-password-url"> +<ANCHOR id="gsignond-signonui-data-get-message" href="gsignond/gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-message"> +<ANCHOR id="gsignond-signonui-data-get-open-url" href="gsignond/gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-open-url"> +<ANCHOR id="gsignond-signonui-data-get-password" href="gsignond/gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-password"> +<ANCHOR id="gsignond-signonui-data-get-query-error" href="gsignond/gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-query-error"> +<ANCHOR id="gsignond-signonui-data-get-query-password" href="gsignond/gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-query-password"> +<ANCHOR id="gsignond-signonui-data-get-query-username" href="gsignond/gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-query-username"> +<ANCHOR id="gsignond-signonui-data-get-remember-password" href="gsignond/gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-remember-password"> +<ANCHOR id="gsignond-signonui-data-get-request-id" href="gsignond/gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-request-id"> +<ANCHOR id="gsignond-signonui-data-get-test-reply" href="gsignond/gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-test-reply"> +<ANCHOR id="gsignond-signonui-data-get-title" href="gsignond/gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-title"> +<ANCHOR id="gsignond-signonui-data-get-url-response" href="gsignond/gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-url-response"> +<ANCHOR id="gsignond-signonui-data-get-username" href="gsignond/gsignond-GSignondSignonuiData.html#gsignond-signonui-data-get-username"> +<ANCHOR id="gsignond-signonui-data-set-captcha-response" href="gsignond/gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-captcha-response"> +<ANCHOR id="gsignond-signonui-data-set-captcha-url" href="gsignond/gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-captcha-url"> +<ANCHOR id="gsignond-signonui-data-set-caption" href="gsignond/gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-caption"> +<ANCHOR id="gsignond-signonui-data-set-confirm" href="gsignond/gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-confirm"> +<ANCHOR id="gsignond-signonui-data-set-final-url" href="gsignond/gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-final-url"> +<ANCHOR id="gsignond-signonui-data-set-forgot-password" href="gsignond/gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-forgot-password"> +<ANCHOR id="gsignond-signonui-data-set-forgot-password-url" href="gsignond/gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-forgot-password-url"> +<ANCHOR id="gsignond-signonui-data-set-message" href="gsignond/gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-message"> +<ANCHOR id="gsignond-signonui-data-set-open-url" href="gsignond/gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-open-url"> +<ANCHOR id="gsignond-signonui-data-set-password" href="gsignond/gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-password"> +<ANCHOR id="gsignond-signonui-data-set-query-error" href="gsignond/gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-query-error"> +<ANCHOR id="gsignond-signonui-data-set-query-password" href="gsignond/gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-query-password"> +<ANCHOR id="gsignond-signonui-data-set-query-username" href="gsignond/gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-query-username"> +<ANCHOR id="gsignond-signonui-data-set-remember-password" href="gsignond/gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-remember-password"> +<ANCHOR id="gsignond-signonui-data-set-request-id" href="gsignond/gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-request-id"> +<ANCHOR id="gsignond-signonui-data-set-test-reply" href="gsignond/gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-test-reply"> +<ANCHOR id="gsignond-signonui-data-set-title" href="gsignond/gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-title"> +<ANCHOR id="gsignond-signonui-data-set-url-response" href="gsignond/gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-url-response"> +<ANCHOR id="gsignond-signonui-data-set-username" href="gsignond/gsignond-GSignondSignonuiData.html#gsignond-signonui-data-set-username"> +<ANCHOR id="GSignondDigestPlugin" href="gsignond/GSignondDigestPlugin.html"> +<ANCHOR id="GSignondDigestPlugin.synopsis" href="gsignond/GSignondDigestPlugin.html#GSignondDigestPlugin.synopsis"> +<ANCHOR id="GSignondDigestPlugin.object-hierarchy" href="gsignond/GSignondDigestPlugin.html#GSignondDigestPlugin.object-hierarchy"> +<ANCHOR id="GSignondDigestPlugin.implemented-interfaces" href="gsignond/GSignondDigestPlugin.html#GSignondDigestPlugin.implemented-interfaces"> +<ANCHOR id="GSignondDigestPlugin.description" href="gsignond/GSignondDigestPlugin.html#GSignondDigestPlugin.description"> +<ANCHOR id="GSignondDigestPlugin.details" href="gsignond/GSignondDigestPlugin.html#GSignondDigestPlugin.details"> +<ANCHOR id="GSignondDigestPlugin-struct" href="gsignond/GSignondDigestPlugin.html#GSignondDigestPlugin-struct"> +<ANCHOR id="GSignondDigestPluginClass" href="gsignond/GSignondDigestPlugin.html#GSignondDigestPluginClass"> +<ANCHOR id="GSignondSsoTestPlugin" href="gsignond/GSignondSsoTestPlugin.html"> +<ANCHOR id="GSignondSsoTestPlugin.synopsis" href="gsignond/GSignondSsoTestPlugin.html#GSignondSsoTestPlugin.synopsis"> +<ANCHOR id="GSignondSsoTestPlugin.object-hierarchy" href="gsignond/GSignondSsoTestPlugin.html#GSignondSsoTestPlugin.object-hierarchy"> +<ANCHOR id="GSignondSsoTestPlugin.implemented-interfaces" href="gsignond/GSignondSsoTestPlugin.html#GSignondSsoTestPlugin.implemented-interfaces"> +<ANCHOR id="GSignondSsoTestPlugin.description" href="gsignond/GSignondSsoTestPlugin.html#GSignondSsoTestPlugin.description"> +<ANCHOR id="GSignondSsoTestPlugin.details" href="gsignond/GSignondSsoTestPlugin.html#GSignondSsoTestPlugin.details"> +<ANCHOR id="GSignondSsoTestPlugin-struct" href="gsignond/GSignondSsoTestPlugin.html#GSignondSsoTestPlugin-struct"> +<ANCHOR id="GSignondSsoTestPluginClass" href="gsignond/GSignondSsoTestPlugin.html#GSignondSsoTestPluginClass"> +<ANCHOR id="GSignondPasswordPlugin" href="gsignond/GSignondPasswordPlugin.html"> +<ANCHOR id="GSignondPasswordPlugin.synopsis" href="gsignond/GSignondPasswordPlugin.html#GSignondPasswordPlugin.synopsis"> +<ANCHOR id="GSignondPasswordPlugin.object-hierarchy" href="gsignond/GSignondPasswordPlugin.html#GSignondPasswordPlugin.object-hierarchy"> +<ANCHOR id="GSignondPasswordPlugin.implemented-interfaces" href="gsignond/GSignondPasswordPlugin.html#GSignondPasswordPlugin.implemented-interfaces"> +<ANCHOR id="GSignondPasswordPlugin.description" href="gsignond/GSignondPasswordPlugin.html#GSignondPasswordPlugin.description"> +<ANCHOR id="GSignondPasswordPlugin.details" href="gsignond/GSignondPasswordPlugin.html#GSignondPasswordPlugin.details"> +<ANCHOR id="GSignondPasswordPlugin-struct" href="gsignond/GSignondPasswordPlugin.html#GSignondPasswordPlugin-struct"> +<ANCHOR id="GSignondPasswordPluginClass" href="gsignond/GSignondPasswordPlugin.html#GSignondPasswordPluginClass"> +<ANCHOR id="GSignondExtension" href="gsignond/GSignondExtension.html"> +<ANCHOR id="GSignondExtension.synopsis" href="gsignond/GSignondExtension.html#GSignondExtension.synopsis"> +<ANCHOR id="GSignondExtension.object-hierarchy" href="gsignond/GSignondExtension.html#GSignondExtension.object-hierarchy"> +<ANCHOR id="GSignondExtension.description" href="gsignond/GSignondExtension.html#GSignondExtension.description"> +<ANCHOR id="GSignondExtension.details" href="gsignond/GSignondExtension.html#GSignondExtension.details"> +<ANCHOR id="GSignondExtension-struct" href="gsignond/GSignondExtension.html#GSignondExtension-struct"> +<ANCHOR id="GSignondExtensionClass" href="gsignond/GSignondExtension.html#GSignondExtensionClass"> +<ANCHOR id="gsignond-extension-get-access-control-manager" href="gsignond/GSignondExtension.html#gsignond-extension-get-access-control-manager"> +<ANCHOR id="gsignond-extension-get-name" href="gsignond/GSignondExtension.html#gsignond-extension-get-name"> +<ANCHOR id="gsignond-extension-get-secret-storage" href="gsignond/GSignondExtension.html#gsignond-extension-get-secret-storage"> +<ANCHOR id="gsignond-extension-get-storage-manager" href="gsignond/GSignondExtension.html#gsignond-extension-get-storage-manager"> +<ANCHOR id="gsignond-extension-get-version" href="gsignond/GSignondExtension.html#gsignond-extension-get-version"> +<ANCHOR id="GSignondAccessControlManager" href="gsignond/GSignondAccessControlManager.html"> +<ANCHOR id="GSignondAccessControlManager.synopsis" href="gsignond/GSignondAccessControlManager.html#GSignondAccessControlManager.synopsis"> +<ANCHOR id="GSignondAccessControlManager.object-hierarchy" href="gsignond/GSignondAccessControlManager.html#GSignondAccessControlManager.object-hierarchy"> +<ANCHOR id="GSignondAccessControlManager.properties" href="gsignond/GSignondAccessControlManager.html#GSignondAccessControlManager.properties"> +<ANCHOR id="GSignondAccessControlManager.description" href="gsignond/GSignondAccessControlManager.html#GSignondAccessControlManager.description"> +<ANCHOR id="GSignondAccessControlManager.details" href="gsignond/GSignondAccessControlManager.html#GSignondAccessControlManager.details"> +<ANCHOR id="GSignondAccessControlManager-struct" href="gsignond/GSignondAccessControlManager.html#GSignondAccessControlManager-struct"> +<ANCHOR id="GSignondAccessControlManagerClass" href="gsignond/GSignondAccessControlManager.html#GSignondAccessControlManagerClass"> +<ANCHOR id="gsignond-access-control-manager-acl-is-valid" href="gsignond/GSignondAccessControlManager.html#gsignond-access-control-manager-acl-is-valid"> +<ANCHOR id="gsignond-access-control-manager-peer-is-allowed-to-use-identity" href="gsignond/GSignondAccessControlManager.html#gsignond-access-control-manager-peer-is-allowed-to-use-identity"> +<ANCHOR id="gsignond-access-control-manager-peer-is-owner-of-identity" href="gsignond/GSignondAccessControlManager.html#gsignond-access-control-manager-peer-is-owner-of-identity"> +<ANCHOR id="gsignond-access-control-manager-security-context-of-keychain" href="gsignond/GSignondAccessControlManager.html#gsignond-access-control-manager-security-context-of-keychain"> +<ANCHOR id="gsignond-access-control-manager-security-context-of-peer" href="gsignond/GSignondAccessControlManager.html#gsignond-access-control-manager-security-context-of-peer"> +<ANCHOR id="GSignondAccessControlManager.property-details" href="gsignond/GSignondAccessControlManager.html#GSignondAccessControlManager.property-details"> +<ANCHOR id="GSignondAccessControlManager--config" href="gsignond/GSignondAccessControlManager.html#GSignondAccessControlManager--config"> +<ANCHOR id="gsignond-GSignondSecurityContext" href="gsignond/gsignond-GSignondSecurityContext.html"> +<ANCHOR id="gsignond-GSignondSecurityContext.synopsis" href="gsignond/gsignond-GSignondSecurityContext.html#gsignond-GSignondSecurityContext.synopsis"> +<ANCHOR id="gsignond-GSignondSecurityContext.description" href="gsignond/gsignond-GSignondSecurityContext.html#gsignond-GSignondSecurityContext.description"> +<ANCHOR id="gsignond-GSignondSecurityContext.details" href="gsignond/gsignond-GSignondSecurityContext.html#gsignond-GSignondSecurityContext.details"> +<ANCHOR id="GSignondSecurityContext" href="gsignond/gsignond-GSignondSecurityContext.html#GSignondSecurityContext"> +<ANCHOR id="GSignondSecurityContextList" href="gsignond/gsignond-GSignondSecurityContext.html#GSignondSecurityContextList"> +<ANCHOR id="gsignond-security-context-check" href="gsignond/gsignond-GSignondSecurityContext.html#gsignond-security-context-check"> +<ANCHOR id="gsignond-security-context-compare" href="gsignond/gsignond-GSignondSecurityContext.html#gsignond-security-context-compare"> +<ANCHOR id="gsignond-security-context-copy" href="gsignond/gsignond-GSignondSecurityContext.html#gsignond-security-context-copy"> +<ANCHOR id="gsignond-security-context-free" href="gsignond/gsignond-GSignondSecurityContext.html#gsignond-security-context-free"> +<ANCHOR id="gsignond-security-context-from-variant" href="gsignond/gsignond-GSignondSecurityContext.html#gsignond-security-context-from-variant"> +<ANCHOR id="gsignond-security-context-get-application-context" href="gsignond/gsignond-GSignondSecurityContext.html#gsignond-security-context-get-application-context"> +<ANCHOR id="gsignond-security-context-get-system-context" href="gsignond/gsignond-GSignondSecurityContext.html#gsignond-security-context-get-system-context"> +<ANCHOR id="gsignond-security-context-list-copy" href="gsignond/gsignond-GSignondSecurityContext.html#gsignond-security-context-list-copy"> +<ANCHOR id="gsignond-security-context-list-free" href="gsignond/gsignond-GSignondSecurityContext.html#gsignond-security-context-list-free"> +<ANCHOR id="gsignond-security-context-list-from-variant" href="gsignond/gsignond-GSignondSecurityContext.html#gsignond-security-context-list-from-variant"> +<ANCHOR id="gsignond-security-context-list-to-variant" href="gsignond/gsignond-GSignondSecurityContext.html#gsignond-security-context-list-to-variant"> +<ANCHOR id="gsignond-security-context-match" href="gsignond/gsignond-GSignondSecurityContext.html#gsignond-security-context-match"> +<ANCHOR id="gsignond-security-context-new" href="gsignond/gsignond-GSignondSecurityContext.html#gsignond-security-context-new"> +<ANCHOR id="gsignond-security-context-new-from-values" href="gsignond/gsignond-GSignondSecurityContext.html#gsignond-security-context-new-from-values"> +<ANCHOR id="gsignond-security-context-set-application-context" href="gsignond/gsignond-GSignondSecurityContext.html#gsignond-security-context-set-application-context"> +<ANCHOR id="gsignond-security-context-set-system-context" href="gsignond/gsignond-GSignondSecurityContext.html#gsignond-security-context-set-system-context"> +<ANCHOR id="gsignond-security-context-to-variant" href="gsignond/gsignond-GSignondSecurityContext.html#gsignond-security-context-to-variant"> +<ANCHOR id="GSignondStorageManager" href="gsignond/GSignondStorageManager.html"> +<ANCHOR id="GSignondStorageManager.synopsis" href="gsignond/GSignondStorageManager.html#GSignondStorageManager.synopsis"> +<ANCHOR id="GSignondStorageManager.object-hierarchy" href="gsignond/GSignondStorageManager.html#GSignondStorageManager.object-hierarchy"> +<ANCHOR id="GSignondStorageManager.properties" href="gsignond/GSignondStorageManager.html#GSignondStorageManager.properties"> +<ANCHOR id="GSignondStorageManager.description" href="gsignond/GSignondStorageManager.html#GSignondStorageManager.description"> +<ANCHOR id="GSignondStorageManager.details" href="gsignond/GSignondStorageManager.html#GSignondStorageManager.details"> +<ANCHOR id="GSignondStorageManager-struct" href="gsignond/GSignondStorageManager.html#GSignondStorageManager-struct"> +<ANCHOR id="GSignondStorageManagerClass" href="gsignond/GSignondStorageManager.html#GSignondStorageManagerClass"> +<ANCHOR id="gsignond-storage-manager-delete-storage" href="gsignond/GSignondStorageManager.html#gsignond-storage-manager-delete-storage"> +<ANCHOR id="gsignond-storage-manager-filesystem-is-mounted" href="gsignond/GSignondStorageManager.html#gsignond-storage-manager-filesystem-is-mounted"> +<ANCHOR id="gsignond-storage-manager-initialize-storage" href="gsignond/GSignondStorageManager.html#gsignond-storage-manager-initialize-storage"> +<ANCHOR id="gsignond-storage-manager-mount-filesystem" href="gsignond/GSignondStorageManager.html#gsignond-storage-manager-mount-filesystem"> +<ANCHOR id="gsignond-storage-manager-storage-is-initialized" href="gsignond/GSignondStorageManager.html#gsignond-storage-manager-storage-is-initialized"> +<ANCHOR id="gsignond-storage-manager-unmount-filesystem" href="gsignond/GSignondStorageManager.html#gsignond-storage-manager-unmount-filesystem"> +<ANCHOR id="GSignondStorageManager.property-details" href="gsignond/GSignondStorageManager.html#GSignondStorageManager.property-details"> +<ANCHOR id="GSignondStorageManager--config" href="gsignond/GSignondStorageManager.html#GSignondStorageManager--config"> +<ANCHOR id="GSignondSecretStorage" href="gsignond/GSignondSecretStorage.html"> +<ANCHOR id="GSignondSecretStorage.synopsis" href="gsignond/GSignondSecretStorage.html#GSignondSecretStorage.synopsis"> +<ANCHOR id="GSignondSecretStorage.object-hierarchy" href="gsignond/GSignondSecretStorage.html#GSignondSecretStorage.object-hierarchy"> +<ANCHOR id="GSignondSecretStorage.properties" href="gsignond/GSignondSecretStorage.html#GSignondSecretStorage.properties"> +<ANCHOR id="GSignondSecretStorage.description" href="gsignond/GSignondSecretStorage.html#GSignondSecretStorage.description"> +<ANCHOR id="GSignondSecretStorage.details" href="gsignond/GSignondSecretStorage.html#GSignondSecretStorage.details"> +<ANCHOR id="GSignondSecretStorage-struct" href="gsignond/GSignondSecretStorage.html#GSignondSecretStorage-struct"> +<ANCHOR id="GSignondSecretStorageClass" href="gsignond/GSignondSecretStorage.html#GSignondSecretStorageClass"> +<ANCHOR id="gsignond-secret-storage-check-credentials" href="gsignond/GSignondSecretStorage.html#gsignond-secret-storage-check-credentials"> +<ANCHOR id="gsignond-secret-storage-clear-db" href="gsignond/GSignondSecretStorage.html#gsignond-secret-storage-clear-db"> +<ANCHOR id="gsignond-secret-storage-close-db" href="gsignond/GSignondSecretStorage.html#gsignond-secret-storage-close-db"> +<ANCHOR id="gsignond-secret-storage-get-last-error" href="gsignond/GSignondSecretStorage.html#gsignond-secret-storage-get-last-error"> +<ANCHOR id="gsignond-secret-storage-is-open-db" href="gsignond/GSignondSecretStorage.html#gsignond-secret-storage-is-open-db"> +<ANCHOR id="gsignond-secret-storage-load-credentials" href="gsignond/GSignondSecretStorage.html#gsignond-secret-storage-load-credentials"> +<ANCHOR id="gsignond-secret-storage-load-data" href="gsignond/GSignondSecretStorage.html#gsignond-secret-storage-load-data"> +<ANCHOR id="gsignond-secret-storage-open-db" href="gsignond/GSignondSecretStorage.html#gsignond-secret-storage-open-db"> +<ANCHOR id="gsignond-secret-storage-remove-credentials" href="gsignond/GSignondSecretStorage.html#gsignond-secret-storage-remove-credentials"> +<ANCHOR id="gsignond-secret-storage-remove-data" href="gsignond/GSignondSecretStorage.html#gsignond-secret-storage-remove-data"> +<ANCHOR id="gsignond-secret-storage-update-credentials" href="gsignond/GSignondSecretStorage.html#gsignond-secret-storage-update-credentials"> +<ANCHOR id="gsignond-secret-storage-update-data" href="gsignond/GSignondSecretStorage.html#gsignond-secret-storage-update-data"> +<ANCHOR id="GSignondSecretStorage.property-details" href="gsignond/GSignondSecretStorage.html#GSignondSecretStorage.property-details"> +<ANCHOR id="GSignondSecretStorage--config" href="gsignond/GSignondSecretStorage.html#GSignondSecretStorage--config"> +<ANCHOR id="GSignondCredentials" href="gsignond/GSignondCredentials.html"> +<ANCHOR id="GSignondCredentials.synopsis" href="gsignond/GSignondCredentials.html#GSignondCredentials.synopsis"> +<ANCHOR id="GSignondCredentials.object-hierarchy" href="gsignond/GSignondCredentials.html#GSignondCredentials.object-hierarchy"> +<ANCHOR id="GSignondCredentials.description" href="gsignond/GSignondCredentials.html#GSignondCredentials.description"> +<ANCHOR id="GSignondCredentials.details" href="gsignond/GSignondCredentials.html#GSignondCredentials.details"> +<ANCHOR id="GSignondCredentials-struct" href="gsignond/GSignondCredentials.html#GSignondCredentials-struct"> +<ANCHOR id="GSignondCredentialsClass" href="gsignond/GSignondCredentials.html#GSignondCredentialsClass"> +<ANCHOR id="gsignond-credentials-equal" href="gsignond/GSignondCredentials.html#gsignond-credentials-equal"> +<ANCHOR id="gsignond-credentials-get-id" href="gsignond/GSignondCredentials.html#gsignond-credentials-get-id"> +<ANCHOR id="gsignond-credentials-get-password" href="gsignond/GSignondCredentials.html#gsignond-credentials-get-password"> +<ANCHOR id="gsignond-credentials-get-username" href="gsignond/GSignondCredentials.html#gsignond-credentials-get-username"> +<ANCHOR id="gsignond-credentials-new" href="gsignond/GSignondCredentials.html#gsignond-credentials-new"> +<ANCHOR id="gsignond-credentials-set-data" href="gsignond/GSignondCredentials.html#gsignond-credentials-set-data"> +<ANCHOR id="gsignond-credentials-set-id" href="gsignond/GSignondCredentials.html#gsignond-credentials-set-id"> +<ANCHOR id="gsignond-credentials-set-password" href="gsignond/GSignondCredentials.html#gsignond-credentials-set-password"> +<ANCHOR id="gsignond-credentials-set-username" href="gsignond/GSignondCredentials.html#gsignond-credentials-set-username"> +<ANCHOR id="gsignond-Errors" href="gsignond/gsignond-Errors.html"> +<ANCHOR id="gsignond-Errors.synopsis" href="gsignond/gsignond-Errors.html#gsignond-Errors.synopsis"> +<ANCHOR id="gsignond-Errors.description" href="gsignond/gsignond-Errors.html#gsignond-Errors.description"> +<ANCHOR id="gsignond-Errors.details" href="gsignond/gsignond-Errors.html#gsignond-Errors.details"> +<ANCHOR id="GSIGNOND-ERROR:CAPS" href="gsignond/gsignond-Errors.html#GSIGNOND-ERROR:CAPS"> +<ANCHOR id="GSignondError" href="gsignond/gsignond-Errors.html#GSignondError"> +<ANCHOR id="GSIGNOND-ERROR-NONE:CAPS" href="gsignond/gsignond-Errors.html#GSIGNOND-ERROR-NONE:CAPS"> +<ANCHOR id="GSIGNOND-ERROR-UNKNOWN:CAPS" href="gsignond/gsignond-Errors.html#GSIGNOND-ERROR-UNKNOWN:CAPS"> +<ANCHOR id="GSIGNOND-ERROR-INTERNAL-SERVER:CAPS" href="gsignond/gsignond-Errors.html#GSIGNOND-ERROR-INTERNAL-SERVER:CAPS"> +<ANCHOR id="GSIGNOND-ERROR-INTERNAL-COMMUNICATION:CAPS" href="gsignond/gsignond-Errors.html#GSIGNOND-ERROR-INTERNAL-COMMUNICATION:CAPS"> +<ANCHOR id="GSIGNOND-ERROR-PERMISSION-DENIED:CAPS" href="gsignond/gsignond-Errors.html#GSIGNOND-ERROR-PERMISSION-DENIED:CAPS"> +<ANCHOR id="GSIGNOND-ERROR-ENCRYPTION-FAILURE:CAPS" href="gsignond/gsignond-Errors.html#GSIGNOND-ERROR-ENCRYPTION-FAILURE:CAPS"> +<ANCHOR id="GSIGNOND-ERROR-AUTH-SERVICE-ERR:CAPS" href="gsignond/gsignond-Errors.html#GSIGNOND-ERROR-AUTH-SERVICE-ERR:CAPS"> +<ANCHOR id="GSIGNOND-ERROR-METHOD-NOT-KNOWN:CAPS" href="gsignond/gsignond-Errors.html#GSIGNOND-ERROR-METHOD-NOT-KNOWN:CAPS"> +<ANCHOR id="GSIGNOND-ERROR-SERVICE-NOT-AVAILABLE:CAPS" href="gsignond/gsignond-Errors.html#GSIGNOND-ERROR-SERVICE-NOT-AVAILABLE:CAPS"> +<ANCHOR id="GSIGNOND-ERROR-INVALID-QUERY:CAPS" href="gsignond/gsignond-Errors.html#GSIGNOND-ERROR-INVALID-QUERY:CAPS"> +<ANCHOR id="GSIGNOND-ERROR-IDENTITY-ERR:CAPS" href="gsignond/gsignond-Errors.html#GSIGNOND-ERROR-IDENTITY-ERR:CAPS"> +<ANCHOR id="GSIGNOND-ERROR-METHOD-NOT-AVAILABLE:CAPS" href="gsignond/gsignond-Errors.html#GSIGNOND-ERROR-METHOD-NOT-AVAILABLE:CAPS"> +<ANCHOR id="GSIGNOND-ERROR-IDENTITY-NOT-FOUND:CAPS" href="gsignond/gsignond-Errors.html#GSIGNOND-ERROR-IDENTITY-NOT-FOUND:CAPS"> +<ANCHOR id="GSIGNOND-ERROR-STORE-FAILED:CAPS" href="gsignond/gsignond-Errors.html#GSIGNOND-ERROR-STORE-FAILED:CAPS"> +<ANCHOR id="GSIGNOND-ERROR-REMOVE-FAILED:CAPS" href="gsignond/gsignond-Errors.html#GSIGNOND-ERROR-REMOVE-FAILED:CAPS"> +<ANCHOR id="GSIGNOND-ERROR-SIGN-OUT-FAILED:CAPS" href="gsignond/gsignond-Errors.html#GSIGNOND-ERROR-SIGN-OUT-FAILED:CAPS"> +<ANCHOR id="GSIGNOND-ERROR-IDENTITY-OPERATION-CANCELED:CAPS" href="gsignond/gsignond-Errors.html#GSIGNOND-ERROR-IDENTITY-OPERATION-CANCELED:CAPS"> +<ANCHOR id="GSIGNOND-ERROR-CREDENTIALS-NOT-AVAILABLE:CAPS" href="gsignond/gsignond-Errors.html#GSIGNOND-ERROR-CREDENTIALS-NOT-AVAILABLE:CAPS"> +<ANCHOR id="GSIGNOND-ERROR-REFERENCE-NOT-FOUND:CAPS" href="gsignond/gsignond-Errors.html#GSIGNOND-ERROR-REFERENCE-NOT-FOUND:CAPS"> +<ANCHOR id="GSIGNOND-ERROR-AUTH-SESSION-ERR:CAPS" href="gsignond/gsignond-Errors.html#GSIGNOND-ERROR-AUTH-SESSION-ERR:CAPS"> +<ANCHOR id="GSIGNOND-ERROR-MECHANISM-NOT-AVAILABLE:CAPS" href="gsignond/gsignond-Errors.html#GSIGNOND-ERROR-MECHANISM-NOT-AVAILABLE:CAPS"> +<ANCHOR id="GSIGNOND-ERROR-MISSING-DATA:CAPS" href="gsignond/gsignond-Errors.html#GSIGNOND-ERROR-MISSING-DATA:CAPS"> +<ANCHOR id="GSIGNOND-ERROR-INVALID-CREDENTIALS:CAPS" href="gsignond/gsignond-Errors.html#GSIGNOND-ERROR-INVALID-CREDENTIALS:CAPS"> +<ANCHOR id="GSIGNOND-ERROR-NOT-AUTHORIZED:CAPS" href="gsignond/gsignond-Errors.html#GSIGNOND-ERROR-NOT-AUTHORIZED:CAPS"> +<ANCHOR id="GSIGNOND-ERROR-WRONG-STATE:CAPS" href="gsignond/gsignond-Errors.html#GSIGNOND-ERROR-WRONG-STATE:CAPS"> +<ANCHOR id="GSIGNOND-ERROR-OPERATION-NOT-SUPPORTED:CAPS" href="gsignond/gsignond-Errors.html#GSIGNOND-ERROR-OPERATION-NOT-SUPPORTED:CAPS"> +<ANCHOR id="GSIGNOND-ERROR-NO-CONNECTION:CAPS" href="gsignond/gsignond-Errors.html#GSIGNOND-ERROR-NO-CONNECTION:CAPS"> +<ANCHOR id="GSIGNOND-ERROR-NETWORK:CAPS" href="gsignond/gsignond-Errors.html#GSIGNOND-ERROR-NETWORK:CAPS"> +<ANCHOR id="GSIGNOND-ERROR-SSL:CAPS" href="gsignond/gsignond-Errors.html#GSIGNOND-ERROR-SSL:CAPS"> +<ANCHOR id="GSIGNOND-ERROR-RUNTIME:CAPS" href="gsignond/gsignond-Errors.html#GSIGNOND-ERROR-RUNTIME:CAPS"> +<ANCHOR id="GSIGNOND-ERROR-SESSION-CANCELED:CAPS" href="gsignond/gsignond-Errors.html#GSIGNOND-ERROR-SESSION-CANCELED:CAPS"> +<ANCHOR id="GSIGNOND-ERROR-TIMED-OUT:CAPS" href="gsignond/gsignond-Errors.html#GSIGNOND-ERROR-TIMED-OUT:CAPS"> +<ANCHOR id="GSIGNOND-ERROR-USER-INTERACTION:CAPS" href="gsignond/gsignond-Errors.html#GSIGNOND-ERROR-USER-INTERACTION:CAPS"> +<ANCHOR id="GSIGNOND-ERROR-OPERATION-FAILED:CAPS" href="gsignond/gsignond-Errors.html#GSIGNOND-ERROR-OPERATION-FAILED:CAPS"> +<ANCHOR id="GSIGNOND-ERROR-ENCRYPTION-FAILED:CAPS" href="gsignond/gsignond-Errors.html#GSIGNOND-ERROR-ENCRYPTION-FAILED:CAPS"> +<ANCHOR id="GSIGNOND-ERROR-TOS-NOT-ACCEPTED:CAPS" href="gsignond/gsignond-Errors.html#GSIGNOND-ERROR-TOS-NOT-ACCEPTED:CAPS"> +<ANCHOR id="GSIGNOND-ERROR-FORGOT-PASSWORD:CAPS" href="gsignond/gsignond-Errors.html#GSIGNOND-ERROR-FORGOT-PASSWORD:CAPS"> +<ANCHOR id="GSIGNOND-ERROR-METHOD-OR-MECHANISM-NOT-ALLOWED:CAPS" href="gsignond/gsignond-Errors.html#GSIGNOND-ERROR-METHOD-OR-MECHANISM-NOT-ALLOWED:CAPS"> +<ANCHOR id="GSIGNOND-ERROR-INCORRECT-DATE:CAPS" href="gsignond/gsignond-Errors.html#GSIGNOND-ERROR-INCORRECT-DATE:CAPS"> +<ANCHOR id="GSIGNOND-ERROR-USER-ERR:CAPS" href="gsignond/gsignond-Errors.html#GSIGNOND-ERROR-USER-ERR:CAPS"> +<ANCHOR id="gsignond-error-new-from-variant" href="gsignond/gsignond-Errors.html#gsignond-error-new-from-variant"> +<ANCHOR id="gsignond-error-quark" href="gsignond/gsignond-Errors.html#gsignond-error-quark"> +<ANCHOR id="gsignond-error-to-variant" href="gsignond/gsignond-Errors.html#gsignond-error-to-variant"> +<ANCHOR id="gsignond-get-gerror-for-id" href="gsignond/gsignond-Errors.html#gsignond-get-gerror-for-id"> +<ANCHOR id="gsignond-Logging" href="gsignond/gsignond-Logging.html"> +<ANCHOR id="gsignond-Logging.synopsis" href="gsignond/gsignond-Logging.html#gsignond-Logging.synopsis"> +<ANCHOR id="gsignond-Logging.description" href="gsignond/gsignond-Logging.html#gsignond-Logging.description"> +<ANCHOR id="gsignond-Logging.details" href="gsignond/gsignond-Logging.html#gsignond-Logging.details"> +<ANCHOR id="DBG:CAPS" href="gsignond/gsignond-Logging.html#DBG:CAPS"> +<ANCHOR id="ERR:CAPS" href="gsignond/gsignond-Logging.html#ERR:CAPS"> +<ANCHOR id="INFO:CAPS" href="gsignond/gsignond-Logging.html#INFO:CAPS"> +<ANCHOR id="TRACEBACK:CAPS" href="gsignond/gsignond-Logging.html#TRACEBACK:CAPS"> +<ANCHOR id="WARN:CAPS" href="gsignond/gsignond-Logging.html#WARN:CAPS"> +<ANCHOR id="gsignond-Utility-functions" href="gsignond/gsignond-Utility-functions.html"> +<ANCHOR id="gsignond-Utility-functions.synopsis" href="gsignond/gsignond-Utility-functions.html#gsignond-Utility-functions.synopsis"> +<ANCHOR id="gsignond-Utility-functions.description" href="gsignond/gsignond-Utility-functions.html#gsignond-Utility-functions.description"> +<ANCHOR id="gsignond-Utility-functions.details" href="gsignond/gsignond-Utility-functions.html#gsignond-Utility-functions.details"> +<ANCHOR id="gsignond-generate-nonce" href="gsignond/gsignond-Utility-functions.html#gsignond-generate-nonce"> +<ANCHOR id="gsignond-wipe-directory" href="gsignond/gsignond-Utility-functions.html#gsignond-wipe-directory"> +<ANCHOR id="gsignond-wipe-file" href="gsignond/gsignond-Utility-functions.html#gsignond-wipe-file"> +<ANCHOR id="annotation-glossterm-transfer full" href="gsignond/annotation-glossary.html#annotation-glossterm-transfer full"> +<ANCHOR id="annotation-glossterm-transfer none" href="gsignond/annotation-glossary.html#annotation-glossterm-transfer none"> diff --git a/docs/html/left-insensitive.png b/docs/html/left-insensitive.png Binary files differnew file mode 100644 index 0000000..3269393 --- /dev/null +++ b/docs/html/left-insensitive.png diff --git a/docs/html/left.png b/docs/html/left.png Binary files differnew file mode 100644 index 0000000..2abde03 --- /dev/null +++ b/docs/html/left.png diff --git a/docs/html/object-tree.html b/docs/html/object-tree.html new file mode 100644 index 0000000..78b42ff --- /dev/null +++ b/docs/html/object-tree.html @@ -0,0 +1,42 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Object Hierarchy</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="gsignond API Reference Manual"> +<link rel="up" href="index.html" title="gsignond API Reference Manual"> +<link rel="prev" href="gsignond-Utility-functions.html" title="Utility functions"> +<link rel="next" href="api-index-full.html" title="API Index"> +<meta name="generator" content="GTK-Doc V1.19.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle"> +<td width="100%" align="left"></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><img src="up-insensitive.png" width="16" height="16" border="0"></td> +<td><a accesskey="p" href="gsignond-Utility-functions.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="api-index-full.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="chapter"> +<div class="titlepage"><div><div><h2 class="title"> +<a name="object-tree"></a>Object Hierarchy</h2></div></div></div> +<pre class="screen"> + <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> + <a class="link" href="GSignondAccessControlManager.html" title="GSignondAccessControlManager">GSignondAccessControlManager</a> + <a class="link" href="GSignondConfig.html" title="GSignondConfig">GSignondConfig</a> + <a class="link" href="GSignondCredentials.html" title="GSignondCredentials">GSignondCredentials</a> + <a class="link" href="GSignondDigestPlugin.html" title="GSignondDigestPlugin">GSignondDigestPlugin</a> + <a class="link" href="GSignondExtension.html" title="GSignondExtension">GSignondExtension</a> + <a class="link" href="GSignondPasswordPlugin.html" title="GSignondPasswordPlugin">GSignondPasswordPlugin</a> + <a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage">GSignondSecretStorage</a> + <a class="link" href="GSignondSsoTestPlugin.html" title="GSignondSsoTestPlugin">GSignondSsoTestPlugin</a> + <a class="link" href="GSignondStorageManager.html" title="GSignondStorageManager">GSignondStorageManager</a> +</pre> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.19.1</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/html/right-insensitive.png b/docs/html/right-insensitive.png Binary files differnew file mode 100644 index 0000000..4c95785 --- /dev/null +++ b/docs/html/right-insensitive.png diff --git a/docs/html/right.png b/docs/html/right.png Binary files differnew file mode 100644 index 0000000..76260ec --- /dev/null +++ b/docs/html/right.png diff --git a/docs/html/style.css b/docs/html/style.css new file mode 100644 index 0000000..221d1bc --- /dev/null +++ b/docs/html/style.css @@ -0,0 +1,321 @@ +body +{ + font-family: cantarell, sans-serif; +} +.synopsis, .classsynopsis +{ + /* tango:aluminium 1/2 */ + background: #eeeeec; + border: solid 1px #d3d7cf; + padding: 0.5em; +} +.programlisting +{ + /* tango:sky blue 0/1 */ + background: #e6f3ff; + border: solid 1px #729fcf; + padding: 0.5em; +} +.variablelist +{ + padding: 4px; + margin-left: 3em; +} +.variablelist td:first-child +{ + vertical-align: top; +} + +@media screen { + sup a.footnote + { + position: relative; + top: 0em ! important; + + } + /* this is needed so that the local anchors are displayed below the naviagtion */ + div.footnote a[name], div.refnamediv a[name], div.refsect1 a[name], div.refsect2 a[name], div.index a[name], div.glossary a[name], div.sect1 a[name] + { + display: inline-block; + position: relative; + top:-5em; + } + /* this seems to be a bug in the xsl style sheets when generating indexes */ + div.index div.index + { + top: 0em; + } + /* make space for the fixed navigation bar and add space at the bottom so that + * link targets appear somewhat close to top + */ + body + { + padding-top: 3.2em; + padding-bottom: 20em; + } + /* style and size the navigation bar */ + table.navigation#top + { + position: fixed; + /* tango:aluminum 2 */ + background: #d3d7cf; + border: solid 1px #babdb6; + margin-top: 0; + margin-bottom: 0; + top: 0; + left: 0; + height: 3em; + z-index: 10; + } + .navigation a, .navigation a:visited + { + /* tango:sky blue 3 */ + color: #204a87; + } + .navigation a:hover + { + /* tango:sky blue 2 */ + color: #3465a4; + } + td.shortcuts + { + /* tango:sky blue 2 */ + color: #3465a4; + font-size: 80%; + white-space: nowrap; + } +} +@media print { + table.navigation { + visibility: collapse; + display: none; + } + div.titlepage table.navigation { + visibility: visible; + display: table; + /* tango:aluminum 2 */ + background: #d3d7cf; + border: solid 1px #babdb6; + margin-top: 0; + margin-bottom: 0; + top: 0; + left: 0; + height: 3em; + } +} + +.navigation .title +{ + font-size: 120%; +} + +div.gallery-float +{ + float: left; + padding: 10px; +} +div.gallery-float img +{ + border-style: none; +} +div.gallery-spacer +{ + clear: both; +} + +a, a:visited +{ + text-decoration: none; + /* tango:sky blue 2 */ + color: #3465a4; +} +a:hover +{ + text-decoration: underline; + /* tango:sky blue 1 */ + color: #729fcf; +} + +div.table table +{ + border-collapse: collapse; + border-spacing: 0px; + /* tango:aluminium 3 */ + border: solid 1px #babdb6; +} + +div.table table td, div.table table th +{ + /* tango:aluminium 3 */ + border: solid 1px #babdb6; + padding: 3px; + vertical-align: top; +} + +div.table table th +{ + /* tango:aluminium 2 */ + background-color: #d3d7cf; +} + +hr +{ + /* tango:aluminium 1 */ + color: #d3d7cf; + background: #d3d7cf; + border: none 0px; + height: 1px; + clear: both; +} + +dl.toc dt +{ + padding-bottom: 0.25em; +} + +dl.toc > dd > dl > dt +{ + padding-top: 0.25em; + padding-bottom: 0.25em; +} + +dl.toc > dt +{ + padding-top: 1em; + padding-bottom: 0.5em; + font-weight: bold; +} + +.parameter +{ + font-style: normal; +} + +.footer +{ + padding-top: 3.5em; + /* tango:aluminium 3 */ + color: #babdb6; + text-align: center; + font-size: 80%; +} + +.informalfigure, +.figure +{ + margin: 2em; +} + +.informalexample, +.example +{ + margin: 2em; +} + +.warning +{ + /* tango:orange 0/1 */ + background: #ffeed9; + border-color: #ffb04f; +} +.note +{ + /* tango:chameleon 0/0.5 */ + background: #d8ffb2; + border-color: #abf562; +} +.note, .warning +{ + padding: 0.5em; + border-width: 1px; + border-style: solid; + margin: 2em; +} +.note h3, .warning h3 +{ + margin-top: 0.0em +} +.note p, .warning p +{ + margin-bottom: 0.0em +} + +p + div.section +{ + margin-top: 2.5em; +} + +div.refnamediv, +div.refsynopsisdiv, +div.refsect1, +div.refsect2, +div.toc, +div.section +{ + margin-bottom: 2.5em; +} + +/* blob links */ +h2 .extralinks, h3 .extralinks +{ + float: right; + /* tango:aluminium 3 */ + color: #babdb6; + font-size: 80%; + font-weight: normal; +} + +.annotation +{ + /* tango:aluminium 5 */ + color: #555753; + font-size: 80%; + font-weight: normal; +} + +/* code listings */ + +.listing_code .programlisting .cbracket { color: #a40000; } /* tango: scarlet red 3 */ +.listing_code .programlisting .comment { color: #a1a39d; } /* tango: aluminium 4 */ +.listing_code .programlisting .function { color: #000000; font-weight: bold; } +.listing_code .programlisting .function a { color: #11326b; font-weight: bold; } /* tango: sky blue 4 */ +.listing_code .programlisting .keyword { color: #4e9a06; } /* tango: chameleon 3 */ +.listing_code .programlisting .linenum { color: #babdb6; } /* tango: aluminium 3 */ +.listing_code .programlisting .normal { color: #000000; } +.listing_code .programlisting .number { color: #75507b; } /* tango: plum 2 */ +.listing_code .programlisting .preproc { color: #204a87; } /* tango: sky blue 3 */ +.listing_code .programlisting .string { color: #c17d11; } /* tango: chocolate 2 */ +.listing_code .programlisting .type { color: #000000; } +.listing_code .programlisting .type a { color: #11326b; } /* tango: sky blue 4 */ +.listing_code .programlisting .symbol { color: #ce5c00; } /* tango: orange 3 */ + +.listing_frame { + /* tango:sky blue 1 */ + border: solid 1px #729fcf; + padding: 0px; +} + +.listing_lines, .listing_code { + margin-top: 0px; + margin-bottom: 0px; + padding: 0.5em; +} +.listing_lines { + /* tango:sky blue 0.5 */ + background: #a6c5e3; + /* tango:aluminium 6 */ + color: #2e3436; +} +.listing_code { + /* tango:sky blue 0 */ + background: #e6f3ff; +} +.listing_code .programlisting { + /* override from previous */ + border: none 0px; + padding: 0px; +} +.listing_lines pre, .listing_code pre { + margin: 0px; +} + diff --git a/docs/html/up-insensitive.png b/docs/html/up-insensitive.png Binary files differnew file mode 100644 index 0000000..f404986 --- /dev/null +++ b/docs/html/up-insensitive.png diff --git a/docs/html/up.png b/docs/html/up.png Binary files differnew file mode 100644 index 0000000..80b4b37 --- /dev/null +++ b/docs/html/up.png diff --git a/docs/tmpl/gsignond-access-control-manager.sgml b/docs/tmpl/gsignond-access-control-manager.sgml new file mode 100644 index 0000000..bfa562a --- /dev/null +++ b/docs/tmpl/gsignond-access-control-manager.sgml @@ -0,0 +1,102 @@ +<!-- ##### SECTION Title ##### --> +GSignondAccessControlManager + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GSignondAccessControlManager ##### --> +<para> + +</para> + + +<!-- ##### ARG GSignondAccessControlManager:config ##### --> +<para> + +</para> + +<!-- ##### STRUCT GSignondAccessControlManagerClass ##### --> +<para> + +</para> + +@parent_class: +@security_context_of_peer: +@peer_is_allowed_to_use_identity: +@peer_is_owner_of_identity: +@acl_is_valid: +@security_context_of_keychain: + +<!-- ##### FUNCTION gsignond_access_control_manager_acl_is_valid ##### --> +<para> + +</para> + +@self: +@peer_ctx: +@identity_acl: +@Returns: + + +<!-- ##### FUNCTION gsignond_access_control_manager_peer_is_allowed_to_use_identity ##### --> +<para> + +</para> + +@self: +@peer_ctx: +@owner_ctx: +@identity_acl: +@Returns: + + +<!-- ##### FUNCTION gsignond_access_control_manager_peer_is_owner_of_identity ##### --> +<para> + +</para> + +@self: +@peer_ctx: +@owner_ctx: +@Returns: + + +<!-- ##### FUNCTION gsignond_access_control_manager_security_context_of_keychain ##### --> +<para> + +</para> + +@self: +@Returns: + + +<!-- ##### FUNCTION gsignond_access_control_manager_security_context_of_peer ##### --> +<para> + +</para> + +@self: +@peer_ctx: +@peer_fd: +@peer_service: +@peer_app_ctx: + + diff --git a/docs/tmpl/gsignond-config-db.sgml b/docs/tmpl/gsignond-config-db.sgml new file mode 100644 index 0000000..7d280e2 --- /dev/null +++ b/docs/tmpl/gsignond-config-db.sgml @@ -0,0 +1,45 @@ +<!-- ##### SECTION Title ##### --> +gsignond-config-db + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO GSIGNOND_CONFIG_DB_METADATA_DB_FILENAME ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GSIGNOND_CONFIG_DB_SECRET_DB_FILENAME ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GSIGNOND_CONFIG_DB_SSO ##### --> +<para> + +</para> + + + diff --git a/docs/tmpl/gsignond-config-dbus.sgml b/docs/tmpl/gsignond-config-dbus.sgml new file mode 100644 index 0000000..acadcf1 --- /dev/null +++ b/docs/tmpl/gsignond-config-dbus.sgml @@ -0,0 +1,52 @@ +<!-- ##### SECTION Title ##### --> +gsignond-config-dbus + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO GSIGNOND_CONFIG_DBUS_AUTH_SESSION_TIMEOUT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GSIGNOND_CONFIG_DBUS_DAEMON_TIMEOUT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GSIGNOND_CONFIG_DBUS_IDENTITY_TIMEOUT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GSIGNOND_CONFIG_DBUS_TIMEOUTS ##### --> +<para> + +</para> + + + diff --git a/docs/tmpl/gsignond-config-general.sgml b/docs/tmpl/gsignond-config-general.sgml new file mode 100644 index 0000000..0f4bc08 --- /dev/null +++ b/docs/tmpl/gsignond-config-general.sgml @@ -0,0 +1,80 @@ +<!-- ##### SECTION Title ##### --> +gsignond-config-general + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO GSIGNOND_CONFIG_GENERAL ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GSIGNOND_CONFIG_GENERAL_BIN_DIR ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GSIGNOND_CONFIG_GENERAL_EXTENSION ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GSIGNOND_CONFIG_GENERAL_EXTENSIONS_DIR ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GSIGNOND_CONFIG_GENERAL_PLUGINS_DIR ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GSIGNOND_CONFIG_GENERAL_SECURE_DIR ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GSIGNOND_CONFIG_GENERAL_STORAGE_PATH ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GSIGNOND_CONFIG_PLUGIN_TIMEOUT ##### --> +<para> + +</para> + + + diff --git a/docs/tmpl/gsignond-config.sgml b/docs/tmpl/gsignond-config.sgml new file mode 100644 index 0000000..8699ceb --- /dev/null +++ b/docs/tmpl/gsignond-config.sgml @@ -0,0 +1,84 @@ +<!-- ##### SECTION Title ##### --> +GSignondConfig + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GSignondConfig ##### --> +<para> + +</para> + + +<!-- ##### STRUCT GSignondConfigClass ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION gsignond_config_get_integer ##### --> +<para> + +</para> + +@self: +@key: +@Returns: + + +<!-- ##### FUNCTION gsignond_config_get_string ##### --> +<para> + +</para> + +@self: +@key: +@Returns: + + +<!-- ##### FUNCTION gsignond_config_new ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION gsignond_config_set_integer ##### --> +<para> + +</para> + +@self: +@key: +@value: + + +<!-- ##### FUNCTION gsignond_config_set_string ##### --> +<para> + +</para> + +@self: +@key: +@value: + + diff --git a/docs/tmpl/gsignond-credentials.sgml b/docs/tmpl/gsignond-credentials.sgml new file mode 100644 index 0000000..ea69e95 --- /dev/null +++ b/docs/tmpl/gsignond-credentials.sgml @@ -0,0 +1,123 @@ +<!-- ##### SECTION Title ##### --> +GSignondCredentials + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GSignondCredentials ##### --> +<para> + +</para> + + +<!-- ##### STRUCT GSignondCredentialsClass ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION gsignond_credentials_equal ##### --> +<para> + +</para> + +@one: +@two: +@Returns: + + +<!-- ##### FUNCTION gsignond_credentials_get_id ##### --> +<para> + +</para> + +@self: +@Returns: + + +<!-- ##### FUNCTION gsignond_credentials_get_password ##### --> +<para> + +</para> + +@self: +@Returns: + + +<!-- ##### FUNCTION gsignond_credentials_get_username ##### --> +<para> + +</para> + +@self: +@Returns: + + +<!-- ##### FUNCTION gsignond_credentials_new ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION gsignond_credentials_set_data ##### --> +<para> + +</para> + +@self: +@id: +@username: +@password: +@Returns: + + +<!-- ##### FUNCTION gsignond_credentials_set_id ##### --> +<para> + +</para> + +@self: +@id: +@Returns: + + +<!-- ##### FUNCTION gsignond_credentials_set_password ##### --> +<para> + +</para> + +@self: +@password: +@Returns: + + +<!-- ##### FUNCTION gsignond_credentials_set_username ##### --> +<para> + +</para> + +@self: +@username: +@Returns: + + diff --git a/docs/tmpl/gsignond-dictionary.sgml b/docs/tmpl/gsignond-dictionary.sgml new file mode 100644 index 0000000..14dc8b7 --- /dev/null +++ b/docs/tmpl/gsignond-dictionary.sgml @@ -0,0 +1,245 @@ +<!-- ##### SECTION Title ##### --> +gsignond-dictionary + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### TYPEDEF GSignondDictionary ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION gsignond_dictionary_copy ##### --> +<para> + +</para> + +@other: +@Returns: + + +<!-- ##### FUNCTION gsignond_dictionary_get ##### --> +<para> + +</para> + +@dict: +@key: +@Returns: + + +<!-- ##### FUNCTION gsignond_dictionary_get_boolean ##### --> +<para> + +</para> + +@dict: +@key: +@value: +@Returns: + + +<!-- ##### FUNCTION gsignond_dictionary_get_int32 ##### --> +<para> + +</para> + +@dict: +@key: +@value: +@Returns: + + +<!-- ##### FUNCTION gsignond_dictionary_get_int64 ##### --> +<para> + +</para> + +@dict: +@key: +@value: +@Returns: + + +<!-- ##### FUNCTION gsignond_dictionary_get_string ##### --> +<para> + +</para> + +@dict: +@key: +@Returns: + + +<!-- ##### FUNCTION gsignond_dictionary_get_uint32 ##### --> +<para> + +</para> + +@dict: +@key: +@value: +@Returns: + + +<!-- ##### FUNCTION gsignond_dictionary_get_uint64 ##### --> +<para> + +</para> + +@dict: +@key: +@value: +@Returns: + + +<!-- ##### FUNCTION gsignond_dictionary_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION gsignond_dictionary_new_from_variant ##### --> +<para> + +</para> + +@variant: +@Returns: + + +<!-- ##### FUNCTION gsignond_dictionary_ref ##### --> +<para> + +</para> + +@dict: +@Returns: + + +<!-- ##### FUNCTION gsignond_dictionary_remove ##### --> +<para> + +</para> + +@dict: +@key: +@Returns: + + +<!-- ##### FUNCTION gsignond_dictionary_set ##### --> +<para> + +</para> + +@dict: +@key: +@value: +@Returns: + + +<!-- ##### FUNCTION gsignond_dictionary_set_boolean ##### --> +<para> + +</para> + +@dict: +@key: +@value: +@Returns: + + +<!-- ##### FUNCTION gsignond_dictionary_set_int32 ##### --> +<para> + +</para> + +@dict: +@key: +@value: +@Returns: + + +<!-- ##### FUNCTION gsignond_dictionary_set_int64 ##### --> +<para> + +</para> + +@dict: +@key: +@value: +@Returns: + + +<!-- ##### FUNCTION gsignond_dictionary_set_string ##### --> +<para> + +</para> + +@dict: +@key: +@value: +@Returns: + + +<!-- ##### FUNCTION gsignond_dictionary_set_uint32 ##### --> +<para> + +</para> + +@dict: +@key: +@value: +@Returns: + + +<!-- ##### FUNCTION gsignond_dictionary_set_uint64 ##### --> +<para> + +</para> + +@dict: +@key: +@value: +@Returns: + + +<!-- ##### FUNCTION gsignond_dictionary_to_variant ##### --> +<para> + +</para> + +@dict: +@Returns: + + +<!-- ##### FUNCTION gsignond_dictionary_unref ##### --> +<para> + +</para> + +@dict: + + diff --git a/docs/tmpl/gsignond-digest-plugin.sgml b/docs/tmpl/gsignond-digest-plugin.sgml new file mode 100644 index 0000000..c8d0d76 --- /dev/null +++ b/docs/tmpl/gsignond-digest-plugin.sgml @@ -0,0 +1,37 @@ +<!-- ##### SECTION Title ##### --> +GSignondDigestPlugin + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GSignondDigestPlugin ##### --> +<para> + +</para> + + +<!-- ##### STRUCT GSignondDigestPluginClass ##### --> +<para> + +</para> + +@parent_class: + diff --git a/docs/tmpl/gsignond-error.sgml b/docs/tmpl/gsignond-error.sgml new file mode 100644 index 0000000..2c5f232 --- /dev/null +++ b/docs/tmpl/gsignond-error.sgml @@ -0,0 +1,114 @@ +<!-- ##### SECTION Title ##### --> +gsignond-error + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO GSIGNOND_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### ENUM GSignondError ##### --> +<para> + +</para> + +@GSIGNOND_ERROR_NONE: +@GSIGNOND_ERROR_UNKNOWN: +@GSIGNOND_ERROR_INTERNAL_SERVER: +@GSIGNOND_ERROR_INTERNAL_COMMUNICATION: +@GSIGNOND_ERROR_PERMISSION_DENIED: +@GSIGNOND_ERROR_ENCRYPTION_FAILURE: +@GSIGNOND_ERROR_AUTH_SERVICE_ERR: +@GSIGNOND_ERROR_METHOD_NOT_KNOWN: +@GSIGNOND_ERROR_SERVICE_NOT_AVAILABLE: +@GSIGNOND_ERROR_INVALID_QUERY: +@GSIGNOND_ERROR_IDENTITY_ERR: +@GSIGNOND_ERROR_METHOD_NOT_AVAILABLE: +@GSIGNOND_ERROR_IDENTITY_NOT_FOUND: +@GSIGNOND_ERROR_STORE_FAILED: +@GSIGNOND_ERROR_REMOVE_FAILED: +@GSIGNOND_ERROR_SIGN_OUT_FAILED: +@GSIGNOND_ERROR_IDENTITY_OPERATION_CANCELED: +@GSIGNOND_ERROR_CREDENTIALS_NOT_AVAILABLE: +@GSIGNOND_ERROR_REFERENCE_NOT_FOUND: +@GSIGNOND_ERROR_AUTH_SESSION_ERR: +@GSIGNOND_ERROR_MECHANISM_NOT_AVAILABLE: +@GSIGNOND_ERROR_MISSING_DATA: +@GSIGNOND_ERROR_INVALID_CREDENTIALS: +@GSIGNOND_ERROR_NOT_AUTHORIZED: +@GSIGNOND_ERROR_WRONG_STATE: +@GSIGNOND_ERROR_OPERATION_NOT_SUPPORTED: +@GSIGNOND_ERROR_NO_CONNECTION: +@GSIGNOND_ERROR_NETWORK: +@GSIGNOND_ERROR_SSL: +@GSIGNOND_ERROR_RUNTIME: +@GSIGNOND_ERROR_SESSION_CANCELED: +@GSIGNOND_ERROR_TIMED_OUT: +@GSIGNOND_ERROR_USER_INTERACTION: +@GSIGNOND_ERROR_OPERATION_FAILED: +@GSIGNOND_ERROR_ENCRYPTION_FAILED: +@GSIGNOND_ERROR_TOS_NOT_ACCEPTED: +@GSIGNOND_ERROR_FORGOT_PASSWORD: +@GSIGNOND_ERROR_METHOD_OR_MECHANISM_NOT_ALLOWED: +@GSIGNOND_ERROR_INCORRECT_DATE: +@GSIGNOND_ERROR_USER_ERR: + +<!-- ##### FUNCTION gsignond_error_new_from_variant ##### --> +<para> + +</para> + +@var: +@Returns: + + +<!-- ##### FUNCTION gsignond_error_quark ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION gsignond_error_to_variant ##### --> +<para> + +</para> + +@error: +@Returns: + + +<!-- ##### MACRO gsignond_get_gerror_for_id ##### --> +<para> + +</para> + +@err: +@message: +@...: + + diff --git a/docs/tmpl/gsignond-extension-interface.sgml b/docs/tmpl/gsignond-extension-interface.sgml new file mode 100644 index 0000000..215d44f --- /dev/null +++ b/docs/tmpl/gsignond-extension-interface.sgml @@ -0,0 +1,90 @@ +<!-- ##### SECTION Title ##### --> +GSignondExtension + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GSignondExtension ##### --> +<para> + +</para> + + +<!-- ##### STRUCT GSignondExtensionClass ##### --> +<para> + +</para> + +@parent_class: +@get_extension_name: +@get_extension_version: +@get_storage_manager: +@get_secret_storage: +@get_access_control_manager: + +<!-- ##### FUNCTION gsignond_extension_get_access_control_manager ##### --> +<para> + +</para> + +@self: +@config: +@Returns: + + +<!-- ##### FUNCTION gsignond_extension_get_name ##### --> +<para> + +</para> + +@self: +@Returns: + + +<!-- ##### FUNCTION gsignond_extension_get_secret_storage ##### --> +<para> + +</para> + +@self: +@config: +@Returns: + + +<!-- ##### FUNCTION gsignond_extension_get_storage_manager ##### --> +<para> + +</para> + +@self: +@config: +@Returns: + + +<!-- ##### FUNCTION gsignond_extension_get_version ##### --> +<para> + +</para> + +@self: +@Returns: + + diff --git a/docs/tmpl/gsignond-log.sgml b/docs/tmpl/gsignond-log.sgml new file mode 100644 index 0000000..a31bbc6 --- /dev/null +++ b/docs/tmpl/gsignond-log.sgml @@ -0,0 +1,67 @@ +<!-- ##### SECTION Title ##### --> +gsignond-log + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO DBG ##### --> +<para> + +</para> + +@frmt: +@...: + + +<!-- ##### MACRO ERR ##### --> +<para> + +</para> + +@frmt: +@...: + + +<!-- ##### MACRO INFO ##### --> +<para> + +</para> + +@frmt: +@...: + + +<!-- ##### MACRO TRACEBACK ##### --> +<para> + +</para> + + + +<!-- ##### MACRO WARN ##### --> +<para> + +</para> + +@frmt: +@...: + + diff --git a/docs/tmpl/gsignond-password-plugin.sgml b/docs/tmpl/gsignond-password-plugin.sgml new file mode 100644 index 0000000..edf3bd9 --- /dev/null +++ b/docs/tmpl/gsignond-password-plugin.sgml @@ -0,0 +1,37 @@ +<!-- ##### SECTION Title ##### --> +GSignondPasswordPlugin + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GSignondPasswordPlugin ##### --> +<para> + +</para> + + +<!-- ##### STRUCT GSignondPasswordPluginClass ##### --> +<para> + +</para> + +@parent_class: + diff --git a/docs/tmpl/gsignond-plugin-interface.sgml b/docs/tmpl/gsignond-plugin-interface.sgml new file mode 100644 index 0000000..1cfbef6 --- /dev/null +++ b/docs/tmpl/gsignond-plugin-interface.sgml @@ -0,0 +1,164 @@ +<!-- ##### SECTION Title ##### --> +GSignondPlugin + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GSignondPluginInterface ##### --> +<para> + +</para> + +@parent: +@cancel: +@request_initial: +@request: +@user_action_finished: +@refresh: + +<!-- ##### ENUM GSignondPluginState ##### --> +<para> + +</para> + +@GSIGNOND_PLUGIN_STATE_NONE: +@GSIGNOND_PLUGIN_STATE_RESOLVING: +@GSIGNOND_PLUGIN_STATE_CONNECTING: +@GSIGNOND_PLUGIN_STATE_SENDING_DATA: +@GSIGNOND_PLUGIN_STATE_WAITING: +@GSIGNOND_PLUGIN_STATE_USER_PENDING: +@GSIGNOND_PLUGIN_STATE_REFRESHING: +@GSIGNOND_PLUGIN_STATE_PROCESS_PENDING: +@GSIGNOND_PLUGIN_STATE_STARTED: +@GSIGNOND_PLUGIN_STATE_CANCELING: +@GSIGNOND_PLUGIN_STATE_DONE: +@GSIGNOND_PLUGIN_STATE_HOLDING: + +<!-- ##### FUNCTION gsignond_plugin_cancel ##### --> +<para> + +</para> + +@self: + + +<!-- ##### FUNCTION gsignond_plugin_error ##### --> +<para> + +</para> + +@self: +@error: + + +<!-- ##### FUNCTION gsignond_plugin_refresh ##### --> +<para> + +</para> + +@self: +@ui_data: + + +<!-- ##### FUNCTION gsignond_plugin_refreshed ##### --> +<para> + +</para> + +@self: +@ui_data: + + +<!-- ##### FUNCTION gsignond_plugin_request ##### --> +<para> + +</para> + +@self: +@session_data: + + +<!-- ##### FUNCTION gsignond_plugin_request_initial ##### --> +<para> + +</para> + +@self: +@session_data: +@identity_method_cache: +@mechanism: + + +<!-- ##### FUNCTION gsignond_plugin_response ##### --> +<para> + +</para> + +@self: +@session_data: + + +<!-- ##### FUNCTION gsignond_plugin_response_final ##### --> +<para> + +</para> + +@self: +@session_data: + + +<!-- ##### FUNCTION gsignond_plugin_status_changed ##### --> +<para> + +</para> + +@self: +@state: +@message: + + +<!-- ##### FUNCTION gsignond_plugin_store ##### --> +<para> + +</para> + +@self: +@identity_method_cache: + + +<!-- ##### FUNCTION gsignond_plugin_user_action_finished ##### --> +<para> + +</para> + +@self: +@ui_data: + + +<!-- ##### FUNCTION gsignond_plugin_user_action_required ##### --> +<para> + +</para> + +@self: +@ui_data: + + diff --git a/docs/tmpl/gsignond-secret-storage.sgml b/docs/tmpl/gsignond-secret-storage.sgml new file mode 100644 index 0000000..d33c891 --- /dev/null +++ b/docs/tmpl/gsignond-secret-storage.sgml @@ -0,0 +1,173 @@ +<!-- ##### SECTION Title ##### --> +GSignondSecretStorage + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GSignondSecretStorage ##### --> +<para> + +</para> + + +<!-- ##### ARG GSignondSecretStorage:config ##### --> +<para> + +</para> + +<!-- ##### STRUCT GSignondSecretStorageClass ##### --> +<para> + +</para> + +@parent_class: +@open_db: +@close_db: +@clear_db: +@is_open_db: +@load_credentials: +@update_credentials: +@remove_credentials: +@check_credentials: +@load_data: +@update_data: +@remove_data: +@get_last_error: + +<!-- ##### FUNCTION gsignond_secret_storage_check_credentials ##### --> +<para> + +</para> + +@self: +@creds: +@Returns: + + +<!-- ##### FUNCTION gsignond_secret_storage_clear_db ##### --> +<para> + +</para> + +@self: +@Returns: + + +<!-- ##### FUNCTION gsignond_secret_storage_close_db ##### --> +<para> + +</para> + +@self: +@Returns: + + +<!-- ##### FUNCTION gsignond_secret_storage_get_last_error ##### --> +<para> + +</para> + +@self: +@Returns: + + +<!-- ##### FUNCTION gsignond_secret_storage_is_open_db ##### --> +<para> + +</para> + +@self: +@Returns: + + +<!-- ##### FUNCTION gsignond_secret_storage_load_credentials ##### --> +<para> + +</para> + +@self: +@id: +@Returns: + + +<!-- ##### FUNCTION gsignond_secret_storage_load_data ##### --> +<para> + +</para> + +@self: +@id: +@method: +@Returns: + + +<!-- ##### FUNCTION gsignond_secret_storage_open_db ##### --> +<para> + +</para> + +@self: +@Returns: + + +<!-- ##### FUNCTION gsignond_secret_storage_remove_credentials ##### --> +<para> + +</para> + +@self: +@id: +@Returns: + + +<!-- ##### FUNCTION gsignond_secret_storage_remove_data ##### --> +<para> + +</para> + +@self: +@id: +@method: +@Returns: + + +<!-- ##### FUNCTION gsignond_secret_storage_update_credentials ##### --> +<para> + +</para> + +@self: +@creds: +@Returns: + + +<!-- ##### FUNCTION gsignond_secret_storage_update_data ##### --> +<para> + +</para> + +@self: +@id: +@method: +@data: +@Returns: + + diff --git a/docs/tmpl/gsignond-security-context.sgml b/docs/tmpl/gsignond-security-context.sgml new file mode 100644 index 0000000..717b7d2 --- /dev/null +++ b/docs/tmpl/gsignond-security-context.sgml @@ -0,0 +1,192 @@ +<!-- ##### SECTION Title ##### --> +gsignond-security-context + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GSignondSecurityContext ##### --> +<para> + +</para> + +@sys_ctx: +@app_ctx: + +<!-- ##### TYPEDEF GSignondSecurityContextList ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION gsignond_security_context_check ##### --> +<para> + +</para> + +@reference: +@test: +@Returns: + + +<!-- ##### FUNCTION gsignond_security_context_compare ##### --> +<para> + +</para> + +@ctx1: +@ctx2: +@Returns: + + +<!-- ##### FUNCTION gsignond_security_context_copy ##### --> +<para> + +</para> + +@src_ctx: +@Returns: + + +<!-- ##### FUNCTION gsignond_security_context_free ##### --> +<para> + +</para> + +@ctx: + + +<!-- ##### FUNCTION gsignond_security_context_from_variant ##### --> +<para> + +</para> + +@variant: +@Returns: + + +<!-- ##### FUNCTION gsignond_security_context_get_application_context ##### --> +<para> + +</para> + +@ctx: +@Returns: + + +<!-- ##### FUNCTION gsignond_security_context_get_system_context ##### --> +<para> + +</para> + +@ctx: +@Returns: + + +<!-- ##### FUNCTION gsignond_security_context_list_copy ##### --> +<para> + +</para> + +@src_list: +@Returns: + + +<!-- ##### FUNCTION gsignond_security_context_list_free ##### --> +<para> + +</para> + +@seclist: + + +<!-- ##### FUNCTION gsignond_security_context_list_from_variant ##### --> +<para> + +</para> + +@variant: +@Returns: + + +<!-- ##### FUNCTION gsignond_security_context_list_to_variant ##### --> +<para> + +</para> + +@list: +@Returns: + + +<!-- ##### FUNCTION gsignond_security_context_match ##### --> +<para> + +</para> + +@ctx1: +@ctx2: +@Returns: + + +<!-- ##### FUNCTION gsignond_security_context_new ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION gsignond_security_context_new_from_values ##### --> +<para> + +</para> + +@system_context: +@application_context: +@Returns: + + +<!-- ##### FUNCTION gsignond_security_context_set_application_context ##### --> +<para> + +</para> + +@ctx: +@application_context: + + +<!-- ##### FUNCTION gsignond_security_context_set_system_context ##### --> +<para> + +</para> + +@ctx: +@system_context: + + +<!-- ##### FUNCTION gsignond_security_context_to_variant ##### --> +<para> + +</para> + +@ctx: +@Returns: + + diff --git a/docs/tmpl/gsignond-session-data.sgml b/docs/tmpl/gsignond-session-data.sgml new file mode 100644 index 0000000..d37ccb7 --- /dev/null +++ b/docs/tmpl/gsignond-session-data.sgml @@ -0,0 +1,206 @@ +<!-- ##### SECTION Title ##### --> +gsignond-session-data + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### TYPEDEF GSignondSessionData ##### --> +<para> + +</para> + + +<!-- ##### ENUM GSignondUiPolicy ##### --> +<para> + +</para> + +@GSIGNOND_UI_POLICY_DEFAULT: +@GSIGNOND_UI_POLICY_REQUEST_PASSWORD: +@GSIGNOND_UI_POLICY_NO_USER_INTERACTION: +@GSIGNOND_UI_POLICY_VALIDATION: + +<!-- ##### FUNCTION gsignond_session_data_get_caption ##### --> +<para> + +</para> + +@data: +@Returns: + + +<!-- ##### FUNCTION gsignond_session_data_get_network_proxy ##### --> +<para> + +</para> + +@data: +@Returns: + + +<!-- ##### FUNCTION gsignond_session_data_get_network_timeout ##### --> +<para> + +</para> + +@data: +@network_timeout: +@Returns: + + +<!-- ##### FUNCTION gsignond_session_data_get_realm ##### --> +<para> + +</para> + +@data: +@Returns: + + +<!-- ##### FUNCTION gsignond_session_data_get_renew_token ##### --> +<para> + +</para> + +@data: +@renew_token: +@Returns: + + +<!-- ##### FUNCTION gsignond_session_data_get_secret ##### --> +<para> + +</para> + +@data: +@Returns: + + +<!-- ##### FUNCTION gsignond_session_data_get_ui_policy ##### --> +<para> + +</para> + +@data: +@ui_policy: +@Returns: + + +<!-- ##### FUNCTION gsignond_session_data_get_username ##### --> +<para> + +</para> + +@data: +@Returns: + + +<!-- ##### FUNCTION gsignond_session_data_get_window_id ##### --> +<para> + +</para> + +@data: +@window_id: +@Returns: + + +<!-- ##### FUNCTION gsignond_session_data_set_caption ##### --> +<para> + +</para> + +@data: +@caption: + + +<!-- ##### FUNCTION gsignond_session_data_set_network_proxy ##### --> +<para> + +</para> + +@data: +@network_proxy: + + +<!-- ##### FUNCTION gsignond_session_data_set_network_timeout ##### --> +<para> + +</para> + +@data: +@network_timeout: + + +<!-- ##### FUNCTION gsignond_session_data_set_realm ##### --> +<para> + +</para> + +@data: +@realm: + + +<!-- ##### FUNCTION gsignond_session_data_set_renew_token ##### --> +<para> + +</para> + +@data: +@renew_token: + + +<!-- ##### FUNCTION gsignond_session_data_set_secret ##### --> +<para> + +</para> + +@data: +@secret: + + +<!-- ##### FUNCTION gsignond_session_data_set_ui_policy ##### --> +<para> + +</para> + +@data: +@ui_policy: + + +<!-- ##### FUNCTION gsignond_session_data_set_username ##### --> +<para> + +</para> + +@data: +@username: + + +<!-- ##### FUNCTION gsignond_session_data_set_window_id ##### --> +<para> + +</para> + +@data: +@window_id: + + diff --git a/docs/tmpl/gsignond-signonui-data.sgml b/docs/tmpl/gsignond-signonui-data.sgml new file mode 100644 index 0000000..9c8f234 --- /dev/null +++ b/docs/tmpl/gsignond-signonui-data.sgml @@ -0,0 +1,395 @@ +<!-- ##### SECTION Title ##### --> +gsignond-signonui-data + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### TYPEDEF GSignondSignonuiData ##### --> +<para> + +</para> + + +<!-- ##### ENUM GSignondSignonuiError ##### --> +<para> + +</para> + +@SIGNONUI_ERROR_NONE: +@SIGNONUI_ERROR_GENERAL: +@SIGNONUI_ERROR_NO_SIGNONUI: +@SIGNONUI_ERROR_BAD_PARAMETERS: +@SIGNONUI_ERROR_CANCELED: +@SIGNONUI_ERROR_NOT_AVAILABLE: +@SIGNONUI_ERROR_BAD_URL: +@SIGNONUI_ERROR_BAD_CAPTCHA: +@SIGNONUI_ERROR_BAD_CAPTCHA_URL: +@SIGNONUI_ERROR_REFRESH_FAILED: +@SIGNONUI_ERROR_FORBIDDEN: +@SIGNONUI_ERROR_FORGOT_PASSWORD: + +<!-- ##### FUNCTION gsignond_signonui_data_get_captcha_response ##### --> +<para> + +</para> + +@data: +@Returns: + + +<!-- ##### FUNCTION gsignond_signonui_data_get_captcha_url ##### --> +<para> + +</para> + +@data: +@Returns: + + +<!-- ##### FUNCTION gsignond_signonui_data_get_caption ##### --> +<para> + +</para> + +@data: +@Returns: + + +<!-- ##### FUNCTION gsignond_signonui_data_get_confirm ##### --> +<para> + +</para> + +@data: +@confirm: +@Returns: + + +<!-- ##### FUNCTION gsignond_signonui_data_get_final_url ##### --> +<para> + +</para> + +@data: +@Returns: + + +<!-- ##### FUNCTION gsignond_signonui_data_get_forgot_password ##### --> +<para> + +</para> + +@data: +@Returns: + + +<!-- ##### FUNCTION gsignond_signonui_data_get_forgot_password_url ##### --> +<para> + +</para> + +@data: +@Returns: + + +<!-- ##### FUNCTION gsignond_signonui_data_get_message ##### --> +<para> + +</para> + +@data: +@Returns: + + +<!-- ##### FUNCTION gsignond_signonui_data_get_open_url ##### --> +<para> + +</para> + +@data: +@Returns: + + +<!-- ##### FUNCTION gsignond_signonui_data_get_password ##### --> +<para> + +</para> + +@data: +@Returns: + + +<!-- ##### FUNCTION gsignond_signonui_data_get_query_error ##### --> +<para> + +</para> + +@data: +@error: +@Returns: + + +<!-- ##### FUNCTION gsignond_signonui_data_get_query_password ##### --> +<para> + +</para> + +@data: +@query_password: +@Returns: + + +<!-- ##### FUNCTION gsignond_signonui_data_get_query_username ##### --> +<para> + +</para> + +@data: +@query_username: +@Returns: + + +<!-- ##### FUNCTION gsignond_signonui_data_get_remember_password ##### --> +<para> + +</para> + +@data: +@remember_password: +@Returns: + + +<!-- ##### FUNCTION gsignond_signonui_data_get_request_id ##### --> +<para> + +</para> + +@data: +@Returns: + + +<!-- ##### FUNCTION gsignond_signonui_data_get_test_reply ##### --> +<para> + +</para> + +@data: +@Returns: + + +<!-- ##### FUNCTION gsignond_signonui_data_get_title ##### --> +<para> + +</para> + +@data: +@Returns: + + +<!-- ##### FUNCTION gsignond_signonui_data_get_url_response ##### --> +<para> + +</para> + +@data: +@Returns: + + +<!-- ##### FUNCTION gsignond_signonui_data_get_username ##### --> +<para> + +</para> + +@data: +@Returns: + + +<!-- ##### FUNCTION gsignond_signonui_data_set_captcha_response ##### --> +<para> + +</para> + +@data: +@response: + + +<!-- ##### FUNCTION gsignond_signonui_data_set_captcha_url ##### --> +<para> + +</para> + +@data: +@url: + + +<!-- ##### FUNCTION gsignond_signonui_data_set_caption ##### --> +<para> + +</para> + +@data: +@caption: + + +<!-- ##### FUNCTION gsignond_signonui_data_set_confirm ##### --> +<para> + +</para> + +@data: +@confirm: + + +<!-- ##### FUNCTION gsignond_signonui_data_set_final_url ##### --> +<para> + +</para> + +@data: +@url: + + +<!-- ##### FUNCTION gsignond_signonui_data_set_forgot_password ##### --> +<para> + +</para> + +@data: +@forgot: + + +<!-- ##### FUNCTION gsignond_signonui_data_set_forgot_password_url ##### --> +<para> + +</para> + +@data: +@url: + + +<!-- ##### FUNCTION gsignond_signonui_data_set_message ##### --> +<para> + +</para> + +@data: +@message: + + +<!-- ##### FUNCTION gsignond_signonui_data_set_open_url ##### --> +<para> + +</para> + +@data: +@url: + + +<!-- ##### FUNCTION gsignond_signonui_data_set_password ##### --> +<para> + +</para> + +@data: +@password: + + +<!-- ##### FUNCTION gsignond_signonui_data_set_query_error ##### --> +<para> + +</para> + +@data: +@error: + + +<!-- ##### FUNCTION gsignond_signonui_data_set_query_password ##### --> +<para> + +</para> + +@data: +@query: + + +<!-- ##### FUNCTION gsignond_signonui_data_set_query_username ##### --> +<para> + +</para> + +@data: +@query: + + +<!-- ##### FUNCTION gsignond_signonui_data_set_remember_password ##### --> +<para> + +</para> + +@data: +@remember: + + +<!-- ##### FUNCTION gsignond_signonui_data_set_request_id ##### --> +<para> + +</para> + +@data: +@id: + + +<!-- ##### FUNCTION gsignond_signonui_data_set_test_reply ##### --> +<para> + +</para> + +@data: +@reply: + + +<!-- ##### FUNCTION gsignond_signonui_data_set_title ##### --> +<para> + +</para> + +@data: +@title: + + +<!-- ##### FUNCTION gsignond_signonui_data_set_url_response ##### --> +<para> + +</para> + +@data: +@response: + + +<!-- ##### FUNCTION gsignond_signonui_data_set_username ##### --> +<para> + +</para> + +@data: +@username: + + diff --git a/docs/tmpl/gsignond-ssotest-plugin.sgml b/docs/tmpl/gsignond-ssotest-plugin.sgml new file mode 100644 index 0000000..814f309 --- /dev/null +++ b/docs/tmpl/gsignond-ssotest-plugin.sgml @@ -0,0 +1,37 @@ +<!-- ##### SECTION Title ##### --> +GSignondSsoTestPlugin + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GSignondSsoTestPlugin ##### --> +<para> + +</para> + + +<!-- ##### STRUCT GSignondSsoTestPluginClass ##### --> +<para> + +</para> + +@parent_class: + diff --git a/docs/tmpl/gsignond-storage-manager.sgml b/docs/tmpl/gsignond-storage-manager.sgml new file mode 100644 index 0000000..0592e59 --- /dev/null +++ b/docs/tmpl/gsignond-storage-manager.sgml @@ -0,0 +1,102 @@ +<!-- ##### SECTION Title ##### --> +GSignondStorageManager + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GSignondStorageManager ##### --> +<para> + +</para> + + +<!-- ##### ARG GSignondStorageManager:config ##### --> +<para> + +</para> + +<!-- ##### STRUCT GSignondStorageManagerClass ##### --> +<para> + +</para> + +@parent_class: +@initialize_storage: +@delete_storage: +@storage_is_initialized: +@mount_filesystem: +@unmount_filesystem: +@filesystem_is_mounted: + +<!-- ##### FUNCTION gsignond_storage_manager_delete_storage ##### --> +<para> + +</para> + +@self: +@Returns: + + +<!-- ##### FUNCTION gsignond_storage_manager_filesystem_is_mounted ##### --> +<para> + +</para> + +@self: +@Returns: + + +<!-- ##### FUNCTION gsignond_storage_manager_initialize_storage ##### --> +<para> + +</para> + +@self: +@Returns: + + +<!-- ##### FUNCTION gsignond_storage_manager_mount_filesystem ##### --> +<para> + +</para> + +@self: +@Returns: + + +<!-- ##### FUNCTION gsignond_storage_manager_storage_is_initialized ##### --> +<para> + +</para> + +@self: +@Returns: + + +<!-- ##### FUNCTION gsignond_storage_manager_unmount_filesystem ##### --> +<para> + +</para> + +@self: +@Returns: + + diff --git a/docs/tmpl/gsignond-unused.sgml b/docs/tmpl/gsignond-unused.sgml new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/docs/tmpl/gsignond-unused.sgml diff --git a/docs/tmpl/gsignond-utils.sgml b/docs/tmpl/gsignond-utils.sgml new file mode 100644 index 0000000..ef2226d --- /dev/null +++ b/docs/tmpl/gsignond-utils.sgml @@ -0,0 +1,50 @@ +<!-- ##### SECTION Title ##### --> +gsignond-utils + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### FUNCTION gsignond_generate_nonce ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION gsignond_wipe_directory ##### --> +<para> + +</para> + +@dirname: +@Returns: + + +<!-- ##### FUNCTION gsignond_wipe_file ##### --> +<para> + +</para> + +@filename: +@Returns: + + |
