From 9436ed6857cba4ad6b019bbe601118168b9a140e Mon Sep 17 00:00:00 2001 From: Alexandra Ellwood Date: Wed, 3 Oct 2007 16:03:59 +0000 Subject: [PATCH] Add documentation for error codes used for flow control ticket: new git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@20084 dc483132-0cff-0310-8789-dd5450dbe970 --- doc/ccapi/Doxyfile | 12 +- doc/ccapi/html/doxygen.css | 80 +- ...roup__cc__ccache__iterator__reference.html | 103 +- .../html/group__cc__ccache__reference.html | 100 +- .../html/group__cc__context__reference.html | 168 +- ..._cc__credentials__iterator__reference.html | 135 +- .../group__cc__credentials__reference.html | 226 +- .../html/group__cc__string__reference.html | 100 +- .../group__ccapi__constants__reference.html | 208 +- .../html/group__ccapi__types__reference.html | 150 +- doc/ccapi/html/group__helper__macros.html | 1888 ++++++++++------- doc/ccapi/html/index.html | 16 +- doc/ccapi/html/structcc__ccache__d.html | 38 +- doc/ccapi/html/structcc__ccache__f.html | 636 +++--- .../html/structcc__ccache__iterator__d.html | 41 +- .../html/structcc__ccache__iterator__f.html | 104 +- doc/ccapi/html/structcc__context__d.html | 38 +- doc/ccapi/html/structcc__context__f.html | 422 ++-- doc/ccapi/html/structcc__credentials__d.html | 69 +- doc/ccapi/html/structcc__credentials__f.html | 74 +- .../structcc__credentials__iterator__d.html | 41 +- .../structcc__credentials__iterator__f.html | 74 +- .../html/structcc__credentials__union.html | 122 +- .../html/structcc__credentials__v4__t.html | 406 ++-- .../html/structcc__credentials__v5__t.html | 378 ++-- doc/ccapi/html/structcc__data.html | 98 +- doc/ccapi/html/structcc__string__d.html | 66 +- doc/ccapi/html/structcc__string__f.html | 44 +- src/include/CredentialsCache.h | 34 +- 29 files changed, 3559 insertions(+), 2312 deletions(-) diff --git a/doc/ccapi/Doxyfile b/doc/ccapi/Doxyfile index 338c9beab..734c29c90 100644 --- a/doc/ccapi/Doxyfile +++ b/doc/ccapi/Doxyfile @@ -4,16 +4,16 @@ # Project related configuration options #--------------------------------------------------------------------------- DOXYFILE_ENCODING = UTF-8 -PROJECT_NAME = "Credentials Cache API " +PROJECT_NAME = "Credentials Cache API " PROJECT_NUMBER = OUTPUT_DIRECTORY = . CREATE_SUBDIRS = NO OUTPUT_LANGUAGE = English BRIEF_MEMBER_DESC = YES REPEAT_BRIEF = YES -ABBREVIATE_BRIEF = "The $name class " \ - "The $name widget " \ - "The $name file " \ +ABBREVIATE_BRIEF = "The $name class " \ + "The $name widget " \ + "The $name file " \ is \ provides \ specifies \ @@ -80,12 +80,12 @@ WARNINGS = YES WARN_IF_UNDOCUMENTED = YES WARN_IF_DOC_ERROR = YES WARN_NO_PARAMDOC = YES -WARN_FORMAT = "$file:$line: $text " +WARN_FORMAT = "$file:$line: $text " WARN_LOGFILE = #--------------------------------------------------------------------------- # configuration options related to the input files #--------------------------------------------------------------------------- -INPUT = ../../src/include/CredentialsCache.h +INPUT = ../../Sources/include/CredentialsCache.h INPUT_ENCODING = UTF-8 FILE_PATTERNS = *.c \ *.cc \ diff --git a/doc/ccapi/html/doxygen.css b/doc/ccapi/html/doxygen.css index c7db1a8a0..05615b2e6 100644 --- a/doc/ccapi/html/doxygen.css +++ b/doc/ccapi/html/doxygen.css @@ -80,7 +80,7 @@ A.codeRef:visited { font-weight: normal; color: #0000FF} A:hover { text-decoration: none; background-color: #f2f2ff } DL.el { margin-left: -1cm } .fragment { - font-family: monospace, fixed; + font-family: Fixed, monospace; font-size: 95%; } PRE.fragment { @@ -96,7 +96,14 @@ PRE.fragment { padding-bottom: 4px; } DIV.ah { background-color: black; font-weight: bold; color: #ffffff; margin-bottom: 3px; margin-top: 3px } - +TD.md { background-color: #F4F4FB; font-weight: bold; } +TD.mdPrefix { + background-color: #F4F4FB; + color: #606060; + font-size: 80%; +} +TD.mdname1 { background-color: #F4F4FB; font-weight: bold; color: #602020; } +TD.mdname { background-color: #F4F4FB; font-weight: bold; color: #602020; width: 600px; } DIV.groupHeader { margin-left: 16px; margin-top: 12px; @@ -149,6 +156,13 @@ SPAN.comment { color: #800000 } SPAN.preprocessor { color: #806020 } SPAN.stringliteral { color: #002080 } SPAN.charliteral { color: #008080 } +.mdTable { + border: 1px solid #868686; + background-color: #F4F4FB; +} +.mdRow { + padding: 8px 10px; +} .mdescLeft { padding: 0px 8px 4px 8px; font-size: 80%; @@ -294,65 +308,3 @@ HR { height: 1px; border-top: 1px solid black; } -/* Style for detailed member documentation */ -.memtemplate { - font-size: 80%; - color: #606060; - font-weight: normal; -} -.memnav { - background-color: #e8eef2; - border: 1px solid #84b0c7; - text-align: center; - margin: 2px; - margin-right: 15px; - padding: 2px; -} -.memitem { - padding: 4px; - background-color: #eef3f5; - border-width: 1px; - border-style: solid; - border-color: #dedeee; - -moz-border-radius: 8px 8px 8px 8px; -} -.memname { - white-space: nowrap; - font-weight: bold; -} -.memdoc{ - padding-left: 10px; -} -.memproto { - background-color: #d5e1e8; - width: 100%; - border-width: 1px; - border-style: solid; - border-color: #84b0c7; - font-weight: bold; - -moz-border-radius: 8px 8px 8px 8px; -} -.paramkey { - text-align: right; -} -.paramtype { - white-space: nowrap; -} -.paramname { - color: #602020; - font-style: italic; - white-space: nowrap; -} -/* End Styling for detailed member documentation */ - -/* for the tree view */ -.ftvtree { - font-family: sans-serif; - margin:0.5em; -} -.directory { font-size: 9pt; font-weight: bold; } -.directory h3 { margin: 0px; margin-top: 1em; font-size: 11pt; } -.directory > h3 { margin-top: 0; } -.directory p { margin: 0px; white-space: nowrap; } -.directory div { display: none; margin: 0px; } -.directory img { vertical-align: -30%; } diff --git a/doc/ccapi/html/group__cc__ccache__iterator__reference.html b/doc/ccapi/html/group__cc__ccache__iterator__reference.html index c01b39e3a..2c8bfe27b 100644 --- a/doc/ccapi/html/group__cc__ccache__iterator__reference.html +++ b/doc/ccapi/html/group__cc__ccache__iterator__reference.html @@ -1,10 +1,10 @@ - -Credentials Cache API: cc_ccache_iterator_t Overview + +Credentials Cache API : cc_ccache_iterator_t Overview - +

cc_ccache_iterator_t Overview

Detailed Description

The cc_ccache_iterator_t type represents an iterator that iterates over a set of ccaches and returns them in all in some order. A new instance of this type can be obtained by calling cc_context_new_ccache_iterator().

For API function documentation see cc_ccache_iterator_f. @@ -15,61 +15,82 @@ For API function documentation see cc_ccache_iterator_f cc_ccache_iterator_f -

  • typedef struct
    -cc_ccache_iterator_d cc_ccache_iterator_d -
  • typedef
    -cc_ccache_iterator_d * cc_ccache_iterator_t +
  • typedef cc_ccache_iterator_f cc_ccache_iterator_f +
  • typedef cc_ccache_iterator_d cc_ccache_iterator_d +
  • typedef cc_ccache_iterator_d * cc_ccache_iterator_t

    Typedef Documentation

    - -
    -
    - +

    +

    + + + +
    + - +
    typedef struct cc_ccache_iterator_f cc_ccache_iterator_f typedef struct cc_ccache_iterator_f cc_ccache_iterator_f
    - -
    +
    + + + +
    +   +

    - - -

    - -

    -
    - + + +
    +

    + + + + +
    + - +
    typedef struct cc_ccache_iterator_d cc_ccache_iterator_d typedef struct cc_ccache_iterator_d cc_ccache_iterator_d
    - -
    +
    + + + +
    +   +

    - - -

    - -

    -
    - + + +
    +

    + + + + +
    + - +
    typedef cc_ccache_iterator_d* cc_ccache_iterator_t typedef cc_ccache_iterator_d* cc_ccache_iterator_t
    - -
    +
    + + + + + +
    +   +

    - - -

    -

    Generated on Mon Sep 10 17:00:32 2007 for Credentials Cache API by  +
    +

    Generated on Tue Oct 2 17:16:06 2007 for Credentials Cache API by  -doxygen 1.5.3
    +doxygen 1.4.6 diff --git a/doc/ccapi/html/group__cc__ccache__reference.html b/doc/ccapi/html/group__cc__ccache__reference.html index 40764ed90..ce47b73c6 100644 --- a/doc/ccapi/html/group__cc__ccache__reference.html +++ b/doc/ccapi/html/group__cc__ccache__reference.html @@ -1,10 +1,10 @@ - -Credentials Cache API: cc_ccache_t Overview + +Credentials Cache API : cc_ccache_t Overview - +

    cc_ccache_t Overview

    Detailed Description

    The cc_ccache_t type represents a reference to a ccache. Callers can access a ccache and the credentials stored in it via a cc_ccache_t. A cc_ccache_t can be acquired via cc_context_open_ccache(), cc_context_open_default_ccache(), or cc_ccache_iterator_next().

    For API function documentation see cc_ccache_f. @@ -15,60 +15,82 @@ For API function documentation see

    Typedefs

    Typedef Documentation

    - -
    -
    - +

    +

    + + + +
    + - +
    typedef struct cc_ccache_f cc_ccache_f typedef struct cc_ccache_f cc_ccache_f
    - -
    +
    + + + +
    +   +

    - - -

    - -

    -
    - + + +
    +

    + + + + +
    + - +
    typedef struct cc_ccache_d cc_ccache_d typedef struct cc_ccache_d cc_ccache_d
    - -
    +
    + + + +
    +   +

    - - -

    - -

    -
    - + + +
    +

    + + + + +
    + - +
    typedef cc_ccache_d* cc_ccache_t typedef cc_ccache_d* cc_ccache_t
    - -
    +
    + + + + + +
    +   +

    - - -

    -

    Generated on Mon Sep 10 17:00:32 2007 for Credentials Cache API by  +
    +

    Generated on Tue Oct 2 17:16:06 2007 for Credentials Cache API by  -doxygen 1.5.3
    +doxygen 1.4.6 diff --git a/doc/ccapi/html/group__cc__context__reference.html b/doc/ccapi/html/group__cc__context__reference.html index 3465ca216..cd7e6be3d 100644 --- a/doc/ccapi/html/group__cc__context__reference.html +++ b/doc/ccapi/html/group__cc__context__reference.html @@ -1,12 +1,12 @@ - -Credentials Cache API: cc_context_t Overview + +Credentials Cache API : cc_context_t Overview - +

    cc_context_t Overview

    Detailed Description

    -The cc_context_t type gives the caller access to a ccache collection. Before being able to call any functions in the CCache API, the caller needs to acquire an instance of cc_context_t by calling cc_initialize().

    +The cc_context_t type gives the caller access to a ccache collection. Before being able to call any functions in the CCache API, the caller needs to acquire an instance of cc_context_t by calling cc_initialize().

    For API function documentation see cc_context_f.

    Data Structures

    @@ -15,10 +15,8 @@ For API function documentation see cc_context_f cc_context_f -
  • typedef struct
    -cc_context_d cc_context_d +
  • typedef cc_context_f cc_context_f +
  • typedef cc_context_d cc_context_d
  • typedef cc_context_d * cc_context_t

    Functions

    @@ -26,88 +24,120 @@ For API function documentation see cc_int32 cc_initialize (cc_context_t *out_context, cc_int32 in_version, cc_int32 *out_supported_version, char const **out_vendor)
    Initialize a new cc_context.

    Typedef Documentation

    - -
    -
    - +

    +

    + + + +
    + - +
    typedef struct cc_context_f cc_context_f typedef struct cc_context_f cc_context_f
    - -
    +
    + + + +
    +   +

    - - -

    - -

    -
    - + + +
    +

    + + + + +
    + - +
    typedef struct cc_context_d cc_context_d typedef struct cc_context_d cc_context_d
    - -
    +
    + + + + + +
    +   +

    - - -

    - -

    -
    - + + +
    +

    + + + + +
    + - +
    typedef cc_context_d* cc_context_t typedef cc_context_d* cc_context_t
    - -
    +
    + + + + + +
    +   +

    - - -

    +

    Function Documentation

    - -
    -
    - +

    +

    + + + +
    + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - + + +
    CCACHE_API cc_int32 cc_initialize (cc_context_t *  out_context, CCACHE_API cc_int32 cc_initialize ( cc_context_t *  out_context,
    cc_int32  in_version, cc_int32  in_version,
    cc_int32 *  out_supported_version, cc_int32 *  out_supported_version,
    char const **  out_vendor char const **  out_vendor
    )) 
    - -
    +
    + + + +
    +   +

    Initialize a new cc_context. @@ -120,12 +150,12 @@ Initialize a new cc_context.

    out_vendor if non-NULL, on exit contains a pointer to a read-only C string which contains a string describing the vendor which implemented the credentials cache API.
    -
    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    - -
    -

    -

    Generated on Mon Sep 10 17:00:32 2007 for Credentials Cache API by  +
    Returns:
    On success, ccNoError. On failure, an error code representing the failure. May return CCAPI v2 error CC_BAD_API_VERSION if ccapi_version_2 is passed in.
    +
    +

    Generated on Tue Oct 2 17:16:06 2007 for Credentials Cache API by  -doxygen 1.5.3
    +doxygen 1.4.6 diff --git a/doc/ccapi/html/group__cc__credentials__iterator__reference.html b/doc/ccapi/html/group__cc__credentials__iterator__reference.html index 3ed6b68c8..41ba42f86 100644 --- a/doc/ccapi/html/group__cc__credentials__iterator__reference.html +++ b/doc/ccapi/html/group__cc__credentials__iterator__reference.html @@ -1,10 +1,10 @@ - -Credentials Cache API: cc_credentials_iterator_t + +Credentials Cache API : cc_credentials_iterator_t - +

    cc_credentials_iterator_t

    Detailed Description

    The cc_credentials_iterator_t type represents an iterator that iterates over a set of credentials. A new instance of this type can be obtained by calling cc_ccache_new_credentials_iterator().

    For API function documentation see cc_credentials_iterator_f. @@ -15,74 +15,103 @@ For API function documentation see cc_credentials_iterator_f cc_credentials_iterator_f -

  • typedef struct
    -cc_credentials_iterator_d cc_credentials_iterator_d -
  • typedef
    -cc_credentials_iterator_d * cc_credentials_iterator_t +
  • typedef cc_credentials_iterator_f cc_credentials_iterator_f +
  • typedef cc_credentials_iterator_d cc_credentials_iterator_d +
  • typedef cc_credentials_iterator_d * cc_credentials_iterator_t

    Variables

    Typedef Documentation

    - -
    -
    - +

    +

    + + + +
    + - +
    typedef struct cc_credentials_iterator_f cc_credentials_iterator_f typedef struct cc_credentials_iterator_f cc_credentials_iterator_f
    - -
    +
    + + + +
    +   +

    - - -

    - -

    -
    - + + +
    +

    + + + + +
    + - +
    typedef struct cc_credentials_iterator_d cc_credentials_iterator_d typedef struct cc_credentials_iterator_d cc_credentials_iterator_d
    - -
    +
    + + + + + +
    +   +

    - - -

    - -

    -
    - + + +
    +

    + + + + +
    + - +
    typedef cc_credentials_iterator_d* cc_credentials_iterator_t typedef cc_credentials_iterator_d* cc_credentials_iterator_t
    - -
    +
    + + + + + +
    +   +

    - - -

    +

    Variable Documentation

    - -
    -
    - +

    +

    + + + +
    + - +
    cc_int32(* clone)(cc_credentials_iterator_t in_credentials_iterator, cc_credentials_iterator_t *out_credentials_iterator) [inherited] cc_int32(* clone)(cc_credentials_iterator_t in_credentials_iterator, cc_credentials_iterator_t *out_credentials_iterator) [inherited]
    - -
    +
    + + + +
    +   +

    cc_credentials_iterator_clone(): Make a copy of a credentials iterator. @@ -93,12 +122,12 @@ For API function documentation see

    		out_credentials_iterator on exit, a copy of in_credentials_iterator.
    -
    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    - -
    -

    -

    Generated on Mon Sep 10 17:00:32 2007 for Credentials Cache API by  +
    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    +
    +

    Generated on Tue Oct 2 17:16:06 2007 for Credentials Cache API by  -doxygen 1.5.3
    +doxygen 1.4.6 diff --git a/doc/ccapi/html/group__cc__credentials__reference.html b/doc/ccapi/html/group__cc__credentials__reference.html index 90376def1..d083e6c07 100644 --- a/doc/ccapi/html/group__cc__credentials__reference.html +++ b/doc/ccapi/html/group__cc__credentials__reference.html @@ -1,10 +1,10 @@ - -Credentials Cache API: cc_credentials_t Overview + +Credentials Cache API : cc_credentials_t Overview - +

    cc_credentials_t Overview

    Detailed Description

    The cc_credentials_t type is used to store a single set of credentials for either Kerberos v4 or Kerberos v5. In addition to its only function, release(), it contains a pointer to a cc_credentials_union structure. A cc_credentials_union structure contains an integer of the enumerator type cc_credentials_version, which is either cc_credentials_v4 or cc_credentials_v5, and a pointer union, which contains either a cc_credentials_v4_t pointer or a cc_credentials_v5_t pointer, depending on the value in version.

    Variables of the type cc_credentials_t are allocated by the CCAPI implementation, and should be released with their release() function. API functions which receive credentials structures from the caller always accept cc_credentials_union, which is allocated by the caller, and accordingly disposed by the caller.

    @@ -20,128 +20,178 @@ For API functions see cc_cred

    Typedefs

    Typedef Documentation

    - -
    -
    - +

    +

    + + + +
    + - +
    typedef struct cc_credentials_v4_t cc_credentials_v4_t typedef struct cc_credentials_v4_t cc_credentials_v4_t
    - -
    +
    + + + +
    +   +

    - - -

    - -

    -
    - + + +
    +

    + + + + +
    + - +
    typedef struct cc_data cc_data typedef struct cc_data cc_data
    - -
    +
    + + + +
    +   +

    - - -

    - -

    -
    - + + +
    +

    + + + + +
    + - +
    typedef struct cc_credentials_v5_t cc_credentials_v5_t typedef struct cc_credentials_v5_t cc_credentials_v5_t
    - -
    +
    + + + +
    +   +

    - - -

    - -

    -
    - + + +
    +

    + + + + +
    + - +
    typedef struct cc_credentials_union cc_credentials_union typedef struct cc_credentials_union cc_credentials_union
    - -
    +
    + + + +
    +   +

    - - -

    - -

    -
    - + + +
    +

    + + + + +
    + - +
    typedef struct cc_credentials_f cc_credentials_f typedef struct cc_credentials_f cc_credentials_f
    - -
    +
    + + + +
    +   +

    - - -

    - -

    -
    - + + +
    +

    + + + + +
    + - +
    typedef struct cc_credentials_d cc_credentials_d typedef struct cc_credentials_d cc_credentials_d
    - -
    +
    + + + +
    +   +

    - - -

    - -

    -
    - + + +
    +

    + + + + +
    + - +
    typedef cc_credentials_d* cc_credentials_t typedef cc_credentials_d* cc_credentials_t
    - -
    +
    + + + + + +
    +   +

    - - -

    -

    Generated on Mon Sep 10 17:00:32 2007 for Credentials Cache API by  +
    +

    Generated on Tue Oct 2 17:16:06 2007 for Credentials Cache API by  -doxygen 1.5.3
    +doxygen 1.4.6 diff --git a/doc/ccapi/html/group__cc__string__reference.html b/doc/ccapi/html/group__cc__string__reference.html index 4a17dde2d..9ce3b7195 100644 --- a/doc/ccapi/html/group__cc__string__reference.html +++ b/doc/ccapi/html/group__cc__string__reference.html @@ -1,10 +1,10 @@ - -Credentials Cache API: cc_string_t Overview + +Credentials Cache API : cc_string_t Overview - +

    cc_string_t Overview

    Detailed Description

    The cc_string_t represents a C string returned by the API. It has a pointer to the string data and a release() function. This type is used for both principal names and ccache names returned by the API. Principal names may contain UTF-8 encoded strings for internationalization purposes.

    For API function documentation see cc_string_f. @@ -15,60 +15,82 @@ For API function documentation see

    Typedefs

    Typedef Documentation

    - -
    -
    - +

    +

    + + + +
    + - +
    typedef struct cc_string_f cc_string_f typedef struct cc_string_f cc_string_f
    - -
    +
    + + + +
    +   +

    - - -

    - -

    -
    - + + +
    +

    + + + + +
    + - +
    typedef struct cc_string_d cc_string_d typedef struct cc_string_d cc_string_d
    - -
    +
    + + + +
    +   +

    - - -

    - -

    -
    - + + +
    +

    + + + + +
    + - +
    typedef cc_string_d* cc_string_t typedef cc_string_d* cc_string_t
    - -
    +
    + + + + + +
    +   +

    - - -

    -

    Generated on Mon Sep 10 17:00:32 2007 for Credentials Cache API by  +
    +

    Generated on Tue Oct 2 17:16:06 2007 for Credentials Cache API by  -doxygen 1.5.3
    +doxygen 1.4.6 diff --git a/doc/ccapi/html/group__ccapi__constants__reference.html b/doc/ccapi/html/group__ccapi__constants__reference.html index 84cc317f1..87ec30b83 100644 --- a/doc/ccapi/html/group__ccapi__constants__reference.html +++ b/doc/ccapi/html/group__ccapi__constants__reference.html @@ -1,10 +1,10 @@ - -Credentials Cache API: Constants + +Credentials Cache API : Constants - +

    Constants

    Enumerations

    @@ -92,20 +92,28 @@ }

    Enumeration Type Documentation

    - -
    -
    - +

    +

    + + + +
    + - +
    anonymous enum anonymous enum
    - -
    +
    + + + + + +
    +   +

    API version numbers

    -These constants are passed into cc_initialize() to indicate the version of the API the caller wants to use.

    +These constants are passed into cc_initialize() to indicate the version of the API the caller wants to use.

    CCAPI v1 and v2 are deprecated and should not be used.

    Enumerator:
    ccapi_version_2  @@ -124,19 +132,27 @@ CCAPI v1 and v2 are deprecated and should not be used.
    Enumer
    - - -

    - -

    -
    - + + +
    +

    + + + + +
    + - +
    anonymous enum anonymous enum
    - -
    +
    + + + + CCacheServer has no record of the caller's process (e.g., the server crashed).
    +   +

    Error codes

    Enumerator:
    @@ -203,19 +219,27 @@ API function not supported by this implementation.
    - -

    -

    - -

    -
    - + + +
    +

    + + + + +
    + - +
    enum cc_credential_versions enum cc_credential_versions
    - -
    +
    + + + +
    +   +

    Credentials versions

    @@ -231,19 +255,27 @@ if ((ccacheVersion & cc_credentials_v5) != 0)

    Enumerator:
    - -

    -

    - -

    -
    - + + +
    +

    + + + + +
    + - +
    enum cc_lock_types enum cc_lock_types
    - -
    +
    + + + +
    +   +

    Lock types

    @@ -259,19 +291,27 @@ These constants are used in the locking functions to describe the type of lock r

    - -

    -

    - -

    -
    - + + +
    +

    + + + + +
    + - +
    enum cc_lock_modes enum cc_lock_modes
    - -
    +
    + + + +
    +   +

    Locking Modes

    @@ -283,19 +323,27 @@ These constants are used in the advisory locking functions to describe whether o

    - -

    -

    - -

    -
    - + + +
    +

    + + + + +
    + - +
    anonymous enum anonymous enum
    - -
    +
    + + + +
    +   +

    Sizes of fields in cc_credentials_v4_t.

    Enumerator:
    @@ -312,19 +360,27 @@ Sizes of fields in cc_cre
    - -

    -

    - -

    -
    - + + +
    +

    + + + + +
    + - +
    enum cc_string_to_key_type enum cc_string_to_key_type
    - -
    +
    + + + +
    +   +

    String to key type (Kerberos v4 only)

    Enumerator:
    @@ -341,11 +397,11 @@ String to key type (Kerberos v4 only)
    Enumerator:
    - -

    -

    -

    Generated on Mon Sep 10 17:00:32 2007 for Credentials Cache API by  +
    +
    Generated on Tue Oct 2 17:16:06 2007 for Credentials Cache API by  -doxygen 1.5.3
    +doxygen 1.4.6 diff --git a/doc/ccapi/html/group__ccapi__types__reference.html b/doc/ccapi/html/group__ccapi__types__reference.html index a9da54d21..9c646b8d9 100644 --- a/doc/ccapi/html/group__ccapi__types__reference.html +++ b/doc/ccapi/html/group__ccapi__types__reference.html @@ -1,10 +1,10 @@ - -Credentials Cache API: Basic Types + +Credentials Cache API : Basic Types - +

    Basic Types

    Typedefs

    @@ -16,83 +16,123 @@
  • typedef cc_uint32 cc_time_t

    Typedef Documentation

    - -
    -
    - +

    +

    + + + +
    + - +
    typedef uint32_t cc_uint32 typedef uint32_t cc_uint32
    - -
    +
    + + + +
    +   +

    -Unsigned 32-bit integer type - -

    - -

    -
    - +Unsigned 32-bit integer type + +
    +

    + + + + +
    + - +
    typedef int32_t cc_int32 typedef int32_t cc_int32
    - -
    +
    + + + +
    +   +

    -Signed 32-bit integer type - -

    - -

    -
    - +Signed 32-bit integer type + +
    +

    + + + + +
    + - +
    typedef int64_t cc_int64 typedef int64_t cc_int64
    - -
    +
    + + + +
    +   +

    -Unsigned 64-bit integer type - -

    - -

    -
    - +Unsigned 64-bit integer type + +
    +

    + + + + +
    + - +
    typedef uint64_t cc_uint64 typedef uint64_t cc_uint64
    - -
    +
    + + + +
    +   +

    -Signed 64-bit integer type - -

    - -

    -
    - +Signed 64-bit integer type + +
    +

    + + + + +
    + - +
    typedef cc_uint32 cc_time_t typedef cc_uint32 cc_time_t
    - -
    +
    + + + + + +
    +   +

    -The cc_time_t type is used to represent a time in seconds. The time must be stored as the number of seconds since midnight GMT on January 1, 1970. - -

    -

    Generated on Mon Sep 10 17:00:32 2007 for Credentials Cache API by  +The cc_time_t type is used to represent a time in seconds. The time must be stored as the number of seconds since midnight GMT on January 1, 1970.
    +

    Generated on Tue Oct 2 17:16:06 2007 for Credentials Cache API by  -doxygen 1.5.3
    +doxygen 1.4.6 diff --git a/doc/ccapi/html/group__helper__macros.html b/doc/ccapi/html/group__helper__macros.html index 30f19568c..cf1c681dc 100644 --- a/doc/ccapi/html/group__helper__macros.html +++ b/doc/ccapi/html/group__helper__macros.html @@ -1,10 +1,10 @@ - -Credentials Cache API: CCAPI Function Helper Macros + +Credentials Cache API : CCAPI Function Helper Macros - +

    CCAPI Function Helper Macros

    Defines

    @@ -53,989 +53,1325 @@
  • #define cc_credentials_iterator_clone(iterator, new_iterator)   ((iterator) -> functions -> clone (iterator, new_iterator))

    Define Documentation

    - -
    -
    - +

    +

    + + + +
    + - - - - - - + + + + + +
    #define cc_context_release (context   )    ((context) -> functions -> release (context))#define cc_context_release ( context   )    ((context) -> functions -> release (context))
    - -
    +
    + + + +
    +   +

    -Helper macro for cc_context_f release() - -

    - -

    -
    - +Helper macro for cc_context_f release() + +
    +

    + + + + +
    + - - - - - - - - - + + + + + + + + +
    #define cc_context_get_change_time (context,
    change_time   )    ((context) -> functions -> get_change_time (context, change_time))#define cc_context_get_change_time ( context,
    change_time   )    ((context) -> functions -> get_change_time (context, change_time))
    - -
    +
    + + + +
    +   +

    -Helper macro for cc_context_f get_change_time() - -

    - -

    -
    - +Helper macro for cc_context_f get_change_time() + +
    +

    + + + + +
    + - - - - - - - - - + + + + + + + + +
    #define cc_context_get_default_ccache_name (context,
    name   )    ((context) -> functions -> get_default_ccache_name (context, name))#define cc_context_get_default_ccache_name ( context,
    name   )    ((context) -> functions -> get_default_ccache_name (context, name))
    - -
    +
    + + + +
    +   +

    -Helper macro for cc_context_f get_default_ccache_name() - -

    - -

    -
    - +Helper macro for cc_context_f get_default_ccache_name() + +
    +

    + + + + +
    + - - - - - - - - - - - - + + + + + + + + + + + +
    #define cc_context_open_ccache (context,
    name,
    ccache   )    ((context) -> functions -> open_ccache (context, name, ccache))#define cc_context_open_ccache ( context,
    name,
    ccache   )    ((context) -> functions -> open_ccache (context, name, ccache))
    - -
    +
    + + + +
    +   +

    -Helper macro for cc_context_f open_ccache() - -

    - -

    -
    - +Helper macro for cc_context_f open_ccache() + +
    +

    + + + + +
    + - - - - - - - - - + + + + + + + + +
    #define cc_context_open_default_ccache (context,
    ccache   )    ((context) -> functions -> open_default_ccache (context, ccache))#define cc_context_open_default_ccache ( context,
    ccache   )    ((context) -> functions -> open_default_ccache (context, ccache))
    - -
    +
    + + + +
    +   +

    -Helper macro for cc_context_f open_default_ccache() - -

    - -

    -
    - +Helper macro for cc_context_f open_default_ccache() + +
    +

    + + + + +
    + - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + +
    #define cc_context_create_ccache (context,
    name,
    version,
    principal,
    ccache   )    ((context) -> functions -> create_ccache (context, name, version, principal, ccache))#define cc_context_create_ccache ( context,
    name,
    version,
    principal,
    ccache   )    ((context) -> functions -> create_ccache (context, name, version, principal, ccache))
    - -
    +
    + + + +
    +   +

    -Helper macro for cc_context_f create_ccache() - -

    - -

    -
    - +Helper macro for cc_context_f create_ccache() + +
    +

    + + + + +
    + - - - - - - - - - - - - - - - + + + + + + + + + + + + + + +
    #define cc_context_create_default_ccache (context,
    version,
    principal,
    ccache   )    ((context) -> functions -> create_default_ccache (context, version, principal, ccache))#define cc_context_create_default_ccache ( context,
    version,
    principal,
    ccache   )    ((context) -> functions -> create_default_ccache (context, version, principal, ccache))
    - -
    +
    + + + +
    +   +

    -Helper macro for cc_context_f create_default_ccache() - -

    - -

    -
    - +Helper macro for cc_context_f create_default_ccache() + +
    +

    + + + + +
    + - - - - - - - - - - - - - - - + + + + + + + + + + + + + + +
    #define cc_context_create_new_ccache (context,
    version,
    principal,
    ccache   )    ((context) -> functions -> create_new_ccache (context, version, principal, ccache))#define cc_context_create_new_ccache ( context,
    version,
    principal,
    ccache   )    ((context) -> functions -> create_new_ccache (context, version, principal, ccache))
    - -
    +
    + + + +
    +   +

    -Helper macro for cc_context_f create_new_ccache() - -

    - -

    -
    - +Helper macro for cc_context_f create_new_ccache() + +
    +

    + + + + +
    + - - - - - - - - - + + + + + + + + +
    #define cc_context_new_ccache_iterator (context,
    iterator   )    ((context) -> functions -> new_ccache_iterator (context, iterator))#define cc_context_new_ccache_iterator ( context,
    iterator   )    ((context) -> functions -> new_ccache_iterator (context, iterator))
    - -
    +
    + + + +
    +   +

    -Helper macro for cc_context_f new_ccache_iterator() - -

    - -

    -
    - +Helper macro for cc_context_f new_ccache_iterator() + +
    +

    + + + + +
    + - - - - - - - - - - - - + + + + + + + + + + + +
    #define cc_context_lock (context,
    type,
    block   )    ((context) -> functions -> lock (context, type, block))#define cc_context_lock ( context,
    type,
    block   )    ((context) -> functions -> lock (context, type, block))
    - -
    +
    + + + +
    +   +

    -Helper macro for cc_context_f lock() - -

    - -

    -
    - +Helper macro for cc_context_f lock() + +
    +

    + + + + +
    + - - - - - - + + + + + +
    #define cc_context_unlock (context   )    ((context) -> functions -> unlock (context))#define cc_context_unlock ( context   )    ((context) -> functions -> unlock (context))
    - -
    +
    + + + +
    +   +

    -Helper macro for cc_context_f unlock() - -

    - -

    -
    - +Helper macro for cc_context_f unlock() + +
    +

    + + + + +
    + - - - - - - - - - - - - + + + + + + + + + + + +
    #define cc_context_compare (context,
    compare_to,
    equal   )    ((context) -> functions -> compare (context, compare_to, equal))#define cc_context_compare ( context,
    compare_to,
    equal   )    ((context) -> functions -> compare (context, compare_to, equal))
    - -
    +
    + + + +
    +   +

    -Helper macro for cc_context_f compare() - -

    - -

    -
    - +Helper macro for cc_context_f compare() + +
    +

    + + + + +
    + - - - - - - + + + + + +
    #define cc_context_wait_for_change (context   )    ((context) -> functions -> wait_for_change (context))#define cc_context_wait_for_change ( context   )    ((context) -> functions -> wait_for_change (context))
    - -
    +
    + + + +
    +   +

    -Helper macro for cc_context_f wait_for_change() - -

    - -

    -
    - +Helper macro for cc_context_f wait_for_change() + +
    +

    + + + + +
    + - - - - - - + + + + + +
    #define cc_ccache_release (ccache   )    ((ccache) -> functions -> release (ccache))#define cc_ccache_release ( ccache   )    ((ccache) -> functions -> release (ccache))
    - -
    +
    + + + +
    +   +

    -Helper macro for cc_ccache_f release() - -

    - -

    -
    - +Helper macro for cc_ccache_f release() + +
    +

    + + + + +
    + - - - - - - + + + + + +
    #define cc_ccache_destroy (ccache   )    ((ccache) -> functions -> destroy (ccache))#define cc_ccache_destroy ( ccache   )    ((ccache) -> functions -> destroy (ccache))
    - -
    +
    + + + +
    +   +

    -Helper macro for cc_ccache_f destroy() - -

    - -

    -
    - +Helper macro for cc_ccache_f destroy() + +
    +

    + + + + +
    + - - - - - - + + + + + +
    #define cc_ccache_set_default (ccache   )    ((ccache) -> functions -> set_default (ccache))#define cc_ccache_set_default ( ccache   )    ((ccache) -> functions -> set_default (ccache))
    - -
    +
    + + + +
    +   +

    -Helper macro for cc_ccache_f set_default() - -

    - -

    -
    - +Helper macro for cc_ccache_f set_default() + +
    +

    + + + + +
    + - - - - - - - - - + + + + + + + + +
    #define cc_ccache_get_credentials_version (ccache,
    version   )    ((ccache) -> functions -> get_credentials_version (ccache, version))#define cc_ccache_get_credentials_version ( ccache,
    version   )    ((ccache) -> functions -> get_credentials_version (ccache, version))
    - -
    +
    + + + +
    +   +

    -Helper macro for cc_ccache_f get_credentials_version() - -

    - -

    -
    - +Helper macro for cc_ccache_f get_credentials_version() + +
    +

    + + + + +
    + - - - - - - - - - + + + + + + + + +
    #define cc_ccache_get_name (ccache,
    name   )    ((ccache) -> functions -> get_name (ccache, name))#define cc_ccache_get_name ( ccache,
    name   )    ((ccache) -> functions -> get_name (ccache, name))
    - -
    +
    + + + +
    +   +

    -Helper macro for cc_ccache_f get_name() - -

    - -

    -
    - +Helper macro for cc_ccache_f get_name() + +
    +

    + + + + +
    + - - - - - - - - - - - - + + + + + + + + + + + +
    #define cc_ccache_get_principal (ccache,
    version,
    principal   )    ((ccache) -> functions -> get_principal (ccache, version, principal))#define cc_ccache_get_principal ( ccache,
    version,
    principal   )    ((ccache) -> functions -> get_principal (ccache, version, principal))
    - -
    +
    + + + +
    +   +

    -Helper macro for cc_ccache_f get_principal() - -

    - -

    -
    - +Helper macro for cc_ccache_f get_principal() + +
    +

    + + + + +
    + - - - - - - - - - - - - + + + + + + + + + + + +
    #define cc_ccache_set_principal (ccache,
    version,
    principal   )    ((ccache) -> functions -> set_principal (ccache, version, principal))#define cc_ccache_set_principal ( ccache,
    version,
    principal   )    ((ccache) -> functions -> set_principal (ccache, version, principal))
    - -
    +
    + + + +
    +   +

    -Helper macro for cc_ccache_f set_principal() - -

    - -

    -
    - +Helper macro for cc_ccache_f set_principal() + +
    +

    + + + + +
    + - - - - - - - - - + + + + + + + + +
    #define cc_ccache_store_credentials (ccache,
    credentials   )    ((ccache) -> functions -> store_credentials (ccache, credentials))#define cc_ccache_store_credentials ( ccache,
    credentials   )    ((ccache) -> functions -> store_credentials (ccache, credentials))
    - -
    +
    + + + +
    +   +

    -Helper macro for cc_ccache_f store_credentials() - -

    - -

    -
    - +Helper macro for cc_ccache_f store_credentials() + +
    +

    + + + + +
    + - - - - - - - - - + + + + + + + + +
    #define cc_ccache_remove_credentials (ccache,
    credentials   )    ((ccache) -> functions -> remove_credentials (ccache, credentials))#define cc_ccache_remove_credentials ( ccache,
    credentials   )    ((ccache) -> functions -> remove_credentials (ccache, credentials))
    - -
    +
    + + + +
    +   +

    -Helper macro for cc_ccache_f remove_credentials() - -

    - -

    -
    - +Helper macro for cc_ccache_f remove_credentials() + +
    +

    + + + + +
    + - - - - - - - - - + + + + + + + + +
    #define cc_ccache_new_credentials_iterator (ccache,
    iterator   )    ((ccache) -> functions -> new_credentials_iterator (ccache, iterator))#define cc_ccache_new_credentials_iterator ( ccache,
    iterator   )    ((ccache) -> functions -> new_credentials_iterator (ccache, iterator))
    - -
    +
    + + + +
    +   +

    -Helper macro for cc_ccache_f new_credentials_iterator() - -

    - -

    -
    - +Helper macro for cc_ccache_f new_credentials_iterator() + +
    +

    + + + + +
    + - - - - - - - - - - - - + + + + + + + + + + + +
    #define cc_ccache_lock (ccache,
    type,
    block   )    ((ccache) -> functions -> lock (ccache, type, block))#define cc_ccache_lock ( ccache,
    type,
    block   )    ((ccache) -> functions -> lock (ccache, type, block))
    - -
    +
    + + + +
    +   +

    -Helper macro for cc_ccache_f lock() - -

    - -

    -
    - +Helper macro for cc_ccache_f lock() + +
    +

    + + + + +
    + - - - - - - + + + + + +
    #define cc_ccache_unlock (ccache   )    ((ccache) -> functions -> unlock (ccache))#define cc_ccache_unlock ( ccache   )    ((ccache) -> functions -> unlock (ccache))
    - -
    +
    + + + +
    +   +

    -Helper macro for cc_ccache_f unlock() - -

    - -

    -
    - +Helper macro for cc_ccache_f unlock() + +
    +

    + + + + +
    + - - - - - - - - - + + + + + + + + +
    #define cc_ccache_get_last_default_time (ccache,
    last_default_time   )    ((ccache) -> functions -> get_last_default_time (ccache, last_default_time))#define cc_ccache_get_last_default_time ( ccache,
    last_default_time   )    ((ccache) -> functions -> get_last_default_time (ccache, last_default_time))
    - -
    +
    + + + +
    +   +

    -Helper macro for cc_ccache_f get_last_default_time() - -

    - -

    -
    - +Helper macro for cc_ccache_f get_last_default_time() + +
    +

    + + + + +
    + - - - - - - - - - + + + + + + + + +
    #define cc_ccache_get_change_time (ccache,
    change_time   )    ((ccache) -> functions -> get_change_time (ccache, change_time))#define cc_ccache_get_change_time ( ccache,
    change_time   )    ((ccache) -> functions -> get_change_time (ccache, change_time))
    - -
    +
    + + + +
    +   +

    -Helper macro for cc_ccache_f get_change_time() - -

    - -

    -
    - +Helper macro for cc_ccache_f get_change_time() + +
    +

    + + + + +
    + - - - - - - - - - + + + + + + + + +
    #define cc_ccache_move (source,
    destination   )    ((source) -> functions -> move (source, destination))#define cc_ccache_move ( source,
    destination   )    ((source) -> functions -> move (source, destination))
    - -
    +
    + + + +
    +   +

    -Helper macro for cc_ccache_f move() - -

    - -

    -
    - +Helper macro for cc_ccache_f move() + +
    +

    + + + + +
    + - - - - - - - - - - - - + + + + + + + + + + + +
    #define cc_ccache_compare (ccache,
    compare_to,
    equal   )    ((ccache) -> functions -> compare (ccache, compare_to, equal))#define cc_ccache_compare ( ccache,
    compare_to,
    equal   )    ((ccache) -> functions -> compare (ccache, compare_to, equal))
    - -
    +
    + + + +
    +   +

    -Helper macro for cc_ccache_f compare() - -

    - -

    -
    - +Helper macro for cc_ccache_f compare() + +
    +

    + + + + +
    + - - - - - - - - - - - - + + + + + + + + + + + +
    #define cc_ccache_get_kdc_time_offset (ccache,
    version,
    time_offset   )    ((ccache) -> functions -> get_kdc_time_offset (ccache, version, time_offset))#define cc_ccache_get_kdc_time_offset ( ccache,
    version,
    time_offset   )    ((ccache) -> functions -> get_kdc_time_offset (ccache, version, time_offset))
    - -
    +
    + + + +
    +   +

    -Helper macro for cc_ccache_f get_kdc_time_offset() - -

    - -

    -
    - +Helper macro for cc_ccache_f get_kdc_time_offset() + +
    +

    + + + + +
    + - - - - - - - - - - - - + + + + + + + + + + + +
    #define cc_ccache_set_kdc_time_offset (ccache,
    version,
    time_offset   )    ((ccache) -> functions -> set_kdc_time_offset (ccache, version, time_offset))#define cc_ccache_set_kdc_time_offset ( ccache,
    version,
    time_offset   )    ((ccache) -> functions -> set_kdc_time_offset (ccache, version, time_offset))
    - -
    +
    + + + +
    +   +

    -Helper macro for cc_ccache_f set_kdc_time_offset() - -

    - -

    -
    - +Helper macro for cc_ccache_f set_kdc_time_offset() + +
    +

    + + + + +
    + - - - - - - - - - + + + + + + + + +
    #define cc_ccache_clear_kdc_time_offset (ccache,
    version   )    ((ccache) -> functions -> clear_kdc_time_offset (ccache, version))#define cc_ccache_clear_kdc_time_offset ( ccache,
    version   )    ((ccache) -> functions -> clear_kdc_time_offset (ccache, version))
    - -
    +
    + + + +
    +   +

    -Helper macro for cc_ccache_f clear_kdc_time_offset() - -

    - -

    -
    - +Helper macro for cc_ccache_f clear_kdc_time_offset() + +
    +

    + + + + +
    + - - - - - - + + + + + +
    #define cc_ccache_wait_for_change (ccache   )    ((ccache) -> functions -> wait_for_change (ccache))#define cc_ccache_wait_for_change ( ccache   )    ((ccache) -> functions -> wait_for_change (ccache))
    - -
    +
    + + + +
    +   +

    -Helper macro for cc_ccache_f wait_for_change() - -

    - -

    -
    - +Helper macro for cc_ccache_f wait_for_change() + +
    +

    + + + + +
    + - - - - - - + + + + + +
    #define cc_string_release (string   )    ((string) -> functions -> release (string))#define cc_string_release ( string   )    ((string) -> functions -> release (string))
    - -
    +
    + + + +
    +   +

    -Helper macro for cc_string_f release() - -

    - -

    -
    - +Helper macro for cc_string_f release() + +
    +

    + + + + +
    + - - - - - - + + + + + +
    #define cc_credentials_release (credentials   )    ((credentials) -> functions -> release (credentials))#define cc_credentials_release ( credentials   )    ((credentials) -> functions -> release (credentials))
    - -
    +
    + + + +
    +   +

    -Helper macro for cc_credentials_f release() - -

    - -

    -
    - +Helper macro for cc_credentials_f release() + +
    +

    + + + + +
    + - - - - - - - - - - - - + + + + + + + + + + + +
    #define cc_credentials_compare (credentials,
    compare_to,
    equal   )    ((credentials) -> functions -> compare (credentials, compare_to, equal))#define cc_credentials_compare ( credentials,
    compare_to,
    equal   )    ((credentials) -> functions -> compare (credentials, compare_to, equal))
    - -
    +
    + + + +
    +   +

    -Helper macro for cc_credentials_f compare() - -

    - -

    -
    - +Helper macro for cc_credentials_f compare() + +
    +

    + + + + +
    + - - - - - - + + + + + +
    #define cc_ccache_iterator_release (iterator   )    ((iterator) -> functions -> release (iterator))#define cc_ccache_iterator_release ( iterator   )    ((iterator) -> functions -> release (iterator))
    - -
    +
    + + + +
    +   +

    -Helper macro for cc_ccache_iterator_f release() - -

    - -

    -
    - +Helper macro for cc_ccache_iterator_f release() + +
    +

    + + + + +
    + - - - - - - - - - + + + + + + + + +
    #define cc_ccache_iterator_next (iterator,
    ccache   )    ((iterator) -> functions -> next (iterator, ccache))#define cc_ccache_iterator_next ( iterator,
    ccache   )    ((iterator) -> functions -> next (iterator, ccache))
    - -
    +
    + + + + + +
    +   +

    -Helper macro for cc_ccache_iterator_f next() - -

    - -

    -
    - +Helper macro for cc_ccache_iterator_f next() + +
    +

    + + + + +
    + - - - - - - - - - + + + + + + + + +
    #define cc_ccache_iterator_clone (iterator,
    new_iterator   )    ((iterator) -> functions -> clone (iterator, new_iterator))#define cc_ccache_iterator_clone ( iterator,
    new_iterator   )    ((iterator) -> functions -> clone (iterator, new_iterator))
    - -
    +
    + + + + + +
    +   +

    -Helper macro for cc_ccache_iterator_f clone() - -

    - -

    -
    - +Helper macro for cc_ccache_iterator_f clone() + +
    +

    + + + + +
    + - - - - - - + + + + + +
    #define cc_credentials_iterator_release (iterator   )    ((iterator) -> functions -> release (iterator))#define cc_credentials_iterator_release ( iterator   )    ((iterator) -> functions -> release (iterator))
    - -
    +
    + + + + + +
    +   +

    -Helper macro for cc_credentials_iterator_f release() - -

    - -

    -
    - +Helper macro for cc_credentials_iterator_f release() + +
    +

    + + + + +
    + - - - - - - - - - + + + + + + + + +
    #define cc_credentials_iterator_next (iterator,
    credentials   )    ((iterator) -> functions -> next (iterator, credentials))#define cc_credentials_iterator_next ( iterator,
    credentials   )    ((iterator) -> functions -> next (iterator, credentials))
    - -
    +
    + + + + + +
    +   +

    -Helper macro for cc_credentials_iterator_f next() - -

    - -

    -
    - +Helper macro for cc_credentials_iterator_f next() + +
    +

    + + + + +
    + - - - - - - - - - + + + + + + + + +
    #define cc_credentials_iterator_clone (iterator,
    new_iterator   )    ((iterator) -> functions -> clone (iterator, new_iterator))#define cc_credentials_iterator_clone ( iterator,
    new_iterator   )    ((iterator) -> functions -> clone (iterator, new_iterator))
    - -
    +
    + + + + + +
    +   +

    -Helper macro for cc_credentials_iterator_f clone() - -

    -

    Generated on Mon Sep 10 17:00:32 2007 for Credentials Cache API by  +Helper macro for cc_credentials_iterator_f clone()
    +

    Generated on Tue Oct 2 17:16:06 2007 for Credentials Cache API by  -doxygen 1.5.3
    +doxygen 1.4.6 diff --git a/doc/ccapi/html/index.html b/doc/ccapi/html/index.html index 47f5e07c2..bf920052f 100644 --- a/doc/ccapi/html/index.html +++ b/doc/ccapi/html/index.html @@ -1,10 +1,10 @@ - -Credentials Cache API: Credentials Cache API (CCAPI) Documentation + +Credentials Cache API : Credentials Cache API (CCAPI) Documentation - +

    Credentials Cache API (CCAPI) Documentation

    @@ -62,11 +62,11 @@ Object Memory Management

    The lifetime of an object returned by the API is until release() is called for it. Releasing one object has no effect on existence of any other object. For example, a ccache obtained within a context continue to exist when the context is released.

    Every object returned by the API (cc_context_t, cc_ccache_t, cc_ccache_iterator_t, cc_credentials_t, cc_credentials_iterator_t, cc_string_t) is owned by the caller of the API, and it is the responsibility of the caller to call release() for every object to prevent memory leaks.

    Opaque Types

    -All of the opaque high-level types in CCache API are implemented as structures of function pointers and private data. To perform some operation on a type, the caller of the API has to first obtain an instance of that type, and then call the appropriate function pointer from that instance. For example, to call get_change_time() on a cc_context_t, one would call cc_initialize() which creates a new cc_context_t and then call its get_change_time(), like this:

    +All of the opaque high-level types in CCache API are implemented as structures of function pointers and private data. To perform some operation on a type, the caller of the API has to first obtain an instance of that type, and then call the appropriate function pointer from that instance. For example, to call get_change_time() on a cc_context_t, one would call cc_initialize() which creates a new cc_context_t and then call its get_change_time(), like this:

     cc_context_t context;
- cc_int32 err = cc_initialize (&context, ccapi_version_3, nil, nil);
+ cc_int32 err = cc_initialize (&context, ccapi_version_3, nil, nil);
  if (err == ccNoError)
- time = context->functions->get_change_time (context)
+ time = context->functions->get_change_time (context)

    All API functions also have convenience preprocessor macros, which make the API seem completely function-based. For example, cc_context_get_change_time (context, time) is equivalent to context->functions->get_change_time (context, time). The convenience macros follow the following naming convention:

    The API function some_function() 

     cc_type_t an_object;
@@ -78,8 +78,8 @@ has an equivalent convenience macro of the form cc_type_some_function(): 
    
 Implementing the API in this manner allows us to extend and change the interface in the future, while preserving compatibility with older clients.
    
 For example, consider the case when the signature or the semantics of a cc_ccache_t function is changed. The API version number is incremented. The library implementation contains both a function with the old signature and semantics and a function with the new signature and semantics. When a context is created, the API version number used in that context is stored in the context, and therefore it can be used whenever a ccache is created in that context. When a ccache is created in a context with the old API version number, the function pointer structure for the ccache is filled with pointers to functions implementing the old semantics; when a ccache is created in a context with the new API version number, the function pointer structure for the ccache is filled with poitners to functions implementing the new semantics.
    
-Similarly, if a function is added to the API, the version number in the context can be used to decide whether to include the implementation of the new function in the appropriate function pointer structure or not. 
    Generated on Mon Sep 10 17:00:32 2007 for Credentials Cache API by 
+Similarly, if a function is added to the API, the version number in the context can be used to decide whether to include the implementation of the new function in the appropriate function pointer structure or not. 
    Generated on Tue Oct 2 17:16:05 2007 for Credentials Cache API    by 
 
-doxygen 1.5.3 
    
+doxygen 1.4.6 
    
 
 
diff --git a/doc/ccapi/html/structcc__ccache__d.html b/doc/ccapi/html/structcc__ccache__d.html
index 255367dd9..c19aa2b59 100644
--- a/doc/ccapi/html/structcc__ccache__d.html
+++ b/doc/ccapi/html/structcc__ccache__d.html
@@ -1,10 +1,10 @@
 
-
-Credentials Cache API: cc_ccache_d Struct Reference
+
+Credentials Cache API   : cc_ccache_d Struct Reference
 
 
 
-
+
 
    cc_ccache_d Struct Reference
    
 
 [cc_ccache_t Overview]
@@ -13,23 +13,31 @@
 
  • const cc_ccache_f * functions
 
 
    Field Documentation
    
-
-
    
-
    
-      
+
    
+
    
+  
+    
+  
+
    
+      
-          
+          
    
         
    const cc_ccache_f* functions          const cc_ccache_f* functions          
         
    
       
    
-
-
    
+    
    
+
+  
+    
+    
+  
+
    
+       
+    
 
 
    
-
-
-
    
-
    Generated on Mon Sep 10 17:00:32 2007 for Credentials Cache API by 
+    
    
+
    Generated on Tue Oct 2 17:16:05 2007 for Credentials Cache API    by 
 
-doxygen 1.5.3 
    
+doxygen 1.4.6 
 
 
diff --git a/doc/ccapi/html/structcc__ccache__f.html b/doc/ccapi/html/structcc__ccache__f.html
index 480c630ca..ddab94ff9 100644
--- a/doc/ccapi/html/structcc__ccache__f.html
+++ b/doc/ccapi/html/structcc__ccache__f.html
@@ -1,12 +1,14 @@
 
-
-Credentials Cache API: cc_ccache_f Struct Reference
+
+Credentials Cache API   : cc_ccache_f Struct Reference
 
 
 
-
+
 
    cc_ccache_f Struct Reference
    Detailed Description
    
-Function pointer table for cc_ccache_t. For more information see cc_ccache_t Overview. 
    Data Fields
    
+Function pointer table for cc_ccache_t. For more information see cc_ccache_t Overview. 
+
    
+
    Data Fields
    
 
 
    Field Documentation
    
-
-
    
-
    
-      
+
    
+
    
+  
+    
+  
+
    
+      
-          
+          
    
         
    cc_int32(* release)(cc_ccache_t io_ccache)          cc_int32(* release)(cc_ccache_t io_ccache)          
         
    
       
    
-
-
    
+    
    
+
+  
+    
+    
    
+       
+    
 
 
    
 cc_ccache_release(): Release memory associated with a cc_ccache_t object. 
@@ -49,21 +59,29 @@ Function pointer table for cc_ccache_t. For more information see 
    		io_ccache the ccache object to release. 
    
   
    
 
-
    Returns:
    On success, ccNoError. On failure, an error code representing the failure. 
    
-
    Note:
    Does not modify the ccache. If you wish to remove the ccache see cc_ccache_destroy(). 
    
-
-
    
-
    
-
-
    
-
    
-      
+
    Returns:
    On success, ccNoError. On failure, an error code representing the failure. 
    
+
    Note:
    Does not modify the ccache. If you wish to remove the ccache see cc_ccache_destroy(). 
    
+    
+  
+
    
+
    
+
+  
+    
+  
+
    
+      
-          
+          
    
         
    cc_int32(* destroy)(cc_ccache_t io_ccache)          cc_int32(* destroy)(cc_ccache_t io_ccache)          
         
    
       
    
-
-
    
+    
    
+
+  
+    
+    
    
+       
+    
 
 
    
 cc_ccache_destroy(): Destroy a ccache. 
@@ -73,20 +91,28 @@ Function pointer table for cc_ccache_t. For more information see 
    		io_ccache the ccache object to destroy and release. 
    
   
    
 
-
    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    
-Destroy the ccache referred to by io_ccache and releases memory associated with the io_ccache object. After this call io_ccache becomes invalid. If io_ccache was the default ccache, the next ccache in the cache collection (if any) becomes the new default. 
-
    
-
    
-
-
    
-
    
-      
+
    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    
+Destroy the ccache referred to by io_ccache and releases memory associated with the io_ccache object. After this call io_ccache becomes invalid. If io_ccache was the default ccache, the next ccache in the cache collection (if any) becomes the new default.     
+  
+
    
+
    
+
+  
+    
+  
+
    
+      
-          
+          
    
         
    cc_int32(* set_default)(cc_ccache_t io_ccache)          cc_int32(* set_default)(cc_ccache_t io_ccache)          
         
    
       
    
-
-
    
+    
    
+
+  
+    
+    
    
+       
+    
 
 
    
 cc_ccache_set_default(): Make a ccache the default ccache. 
@@ -96,20 +122,28 @@ Destroy the ccache referred to by io_ccache and releases memory associa
     
    io_ccache a ccache object to make the new default ccache. 
    
   
    
 
-
    Returns:
    On success, ccNoError. On failure, an error code representing the failure. 
    
-
-
    
-
    
-
-
    
-
    
-      
+
    Returns:
    On success, ccNoError. On failure, an error code representing the failure. 
    
+    
+  
+
    
+
    
+
+  
+    
+  
+
    
+      
-          
+          
    
         
    cc_int32(* get_credentials_version)(cc_ccache_t in_ccache, cc_uint32 *out_credentials_version)          cc_int32(* get_credentials_version)(cc_ccache_t in_ccache, cc_uint32 *out_credentials_version)          
         
    
       
    
-
-
    
+    
    
+
+  
+    
+    
    
+       
+    
 
 
    
 cc_ccache_get_credentials_version(): Get the credentials version of a ccache. 
@@ -120,20 +154,28 @@ Destroy the ccache referred to by io_ccache and releases memory associa
     
    out_credentials_version on exit, the credentials version of in_ccache. 
    
   
    
 
-
    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    
-cc_ccache_get_credentials_version() returns one value of the enumerated type cc_credentials_vers. The possible return values are cc_credentials_v4 (if ccache's v4 principal has been set), cc_credentials_v5 (if ccache's v5 principal has been set), or cc_credentials_v4_v5 (if both ccache's v4 and v5 principals have been set). A ccache's principal is set with one of cc_context_create_ccache(), cc_context_create_new_ccache(), cc_context_create_default_ccache(), or cc_ccache_set_principal(). 
-
    
-
    
-
-
    
-
    
-      
+
    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    
+cc_ccache_get_credentials_version() returns one value of the enumerated type cc_credentials_vers. The possible return values are cc_credentials_v4 (if ccache's v4 principal has been set), cc_credentials_v5 (if ccache's v5 principal has been set), or cc_credentials_v4_v5 (if both ccache's v4 and v5 principals have been set). A ccache's principal is set with one of cc_context_create_ccache(), cc_context_create_new_ccache(), cc_context_create_default_ccache(), or cc_ccache_set_principal().     
+  
+
    
+
    
+
+  
+    
+  
+
    
+      
-          
+          
    
         
    cc_int32(* get_name)(cc_ccache_t in_ccache, cc_string_t *out_name)          cc_int32(* get_name)(cc_ccache_t in_ccache, cc_string_t *out_name)          
         
    
       
    
-
-
    
+    
    
+
+  
+    
+    
    
+       
+    
 
 
    
 cc_ccache_get_name(): Get the name of a ccache. 
@@ -144,20 +186,28 @@ Destroy the ccache referred to by io_ccache and releases memory associa
     
    out_name on exit, a cc_string_t representing the name of in_ccache. out_name must be released with cc_string_release(). 
    
   
    
 
-
    Returns:
    On success, ccNoError. On failure, an error code representing the failure. 
    
-
-
    
-
    
-
-
    
-
    
-      
+
    Returns:
    On success, ccNoError. On failure, an error code representing the failure. 
    
+    
+  
+
    
+
    
+
+  
+    
+  
+
    
+      
-          
+          
    
         
    cc_int32(* get_principal)(cc_ccache_t in_ccache, cc_uint32 in_credentials_version, cc_string_t *out_principal)          cc_int32(* get_principal)(cc_ccache_t in_ccache, cc_uint32 in_credentials_version, cc_string_t *out_principal)          
         
    
       
    
-
-
    
+    
    
+
+  
+    
+    
    
+       
+    
 
 
    
 cc_ccache_get_principal(): Get the principal of a ccache. 
@@ -169,20 +219,28 @@ Destroy the ccache referred to by io_ccache and releases memory associa
     
    out_principal on exit, a cc_string_t representing the principal of in_ccache. out_principal must be released with cc_string_release(). 
    
   
    
 
-
    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    
-Return the principal for the ccache that was set via cc_context_create_ccache(), cc_context_create_default_ccache(), cc_context_create_new_ccache(), or cc_ccache_set_principal(). Principals for v4 and v5 are separate, but should be kept synchronized for each ccache; they can be retrieved by passing cc_credentials_v4 or cc_credentials_v5 in cred_vers. Passing cc_credentials_v4_v5 will result in the error ccErrBadCredentialsVersion. 
-
    
-
    
-
-
    
-
    
-      
+
    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    
+Return the principal for the ccache that was set via cc_context_create_ccache(), cc_context_create_default_ccache(), cc_context_create_new_ccache(), or cc_ccache_set_principal(). Principals for v4 and v5 are separate, but should be kept synchronized for each ccache; they can be retrieved by passing cc_credentials_v4 or cc_credentials_v5 in cred_vers. Passing cc_credentials_v4_v5 will result in the error ccErrBadCredentialsVersion.     
+  
+
    
+
    
+
+  
+    
+  
+
    
+      
-          
+          
    
         
    cc_int32(* set_principal)(cc_ccache_t io_ccache, cc_uint32 in_credentials_version, const char *in_principal)          cc_int32(* set_principal)(cc_ccache_t io_ccache, cc_uint32 in_credentials_version, const char *in_principal)          
         
    
       
    
-
-
    
+    
    
+
+  
+    
+    
    
+       
+    
 
 
    
 cc_ccache_set_principal(): Set the principal of a ccache. 
@@ -194,20 +252,28 @@ Return the principal for the ccache that was set via 
    		in_principal a C string representing the new principal of in_ccache. 
    
   
    
 
-
    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    
-Set the a principal for ccache. The v4 and v5 principals can be set independently, but they should always be kept equal, up to differences in string representation between v4 and v5. Passing cc_credentials_v4_v5 in cred_vers will result in the error ccErrBadCredentialsVersion. 
-
    
-
    
-
-
    
-
    
-      
+
    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    
+Set the a principal for ccache. The v4 and v5 principals can be set independently, but they should always be kept equal, up to differences in string representation between v4 and v5. Passing cc_credentials_v4_v5 in cred_vers will result in the error ccErrBadCredentialsVersion.     
+  
+
    
+
    
+
+  
+    
+  
+
    
+      
-          
+          
    
         
    cc_int32(* store_credentials)(cc_ccache_t io_ccache, const cc_credentials_union *in_credentials_union)          cc_int32(* store_credentials)(cc_ccache_t io_ccache, const cc_credentials_union *in_credentials_union)          
         
    
       
    
-
-
    
+    
    
+
+  
+    
+    
    
+       
+    
 
 
    
 cc_ccache_store_credentials(): Store credentials in a ccache. 
@@ -218,22 +284,30 @@ Set the a principal for ccache. The v4 and v5 principals can be set independentl
     
    in_credentials_union the credentials to store in io_ccache. 
    
   
    
 
-
    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    
+
    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    
 Store a copy of credentials in the ccache.
    
 See the description of the credentials types for the meaning of cc_credentials_union fields.
    
-Before credentials of a specific credential type can be stored in a ccache, the corresponding principal version has to be set. For example, before you can store Kerberos v4 credentials in a ccache, the Kerberos v4 principal has to be set either by cc_context_create_ccache(), cc_context_create_default_ccache(), cc_context_create_new_ccache(), or cc_ccache_set_principal(); likewise for Kerberos v5. Otherwise, ccErrBadCredentialsVersion is returned. 
-
    
-
    
-
-
    
-
    
-      
+Before credentials of a specific credential type can be stored in a ccache, the corresponding principal version has to be set. For example, before you can store Kerberos v4 credentials in a ccache, the Kerberos v4 principal has to be set either by cc_context_create_ccache(), cc_context_create_default_ccache(), cc_context_create_new_ccache(), or cc_ccache_set_principal(); likewise for Kerberos v5. Otherwise, ccErrBadCredentialsVersion is returned.     
+  
+
    
+
    
+
+  
+    
+  
+
    
+      
-          
+          
    
         
    cc_int32(* remove_credentials)(cc_ccache_t io_ccache, cc_credentials_t in_credentials)          cc_int32(* remove_credentials)(cc_ccache_t io_ccache, cc_credentials_t in_credentials)          
         
    
       
    
-
-
    
+    
    
+
+  
+    
+    
    
+       
+    
 
 
    
 cc_ccache_remove_credentials(): Remove credentials from a ccache. 
@@ -244,21 +318,29 @@ Before credentials of a specific credential type can be stored in a ccache, the
     
    in_credentials the credentials to remove from io_ccache. 
    
   
    
 
-
    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    
+
    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    
 Removes credentials from a ccache. Note that credentials must be previously acquired from the CCache API; only exactly matching credentials will be removed. (This places the burden of determining exactly which credentials to remove on the caller, but ensures there is no ambigity about which credentials will be removed.) cc_credentials_t objects can be obtained by iterating over the ccache's credentials with cc_ccache_new_credentials_iterator().
    
-If found, the credentials are removed from the ccache. The credentials parameter is not modified and should be freed by the caller. It is legitimate to call this function while an iterator is traversing the ccache, and the deletion of a credential already returned by cc_credentials_iterator_next() will not disturb sequence of credentials returned by cc_credentials_iterator_next(). 
-
    
-
    
-
-
    
-
    
-      
+If found, the credentials are removed from the ccache. The credentials parameter is not modified and should be freed by the caller. It is legitimate to call this function while an iterator is traversing the ccache, and the deletion of a credential already returned by cc_credentials_iterator_next() will not disturb sequence of credentials returned by cc_credentials_iterator_next().     
+  
+
    
+
    
+
+  
+    
+  
+
    
+      
-          
+          
    
         
    cc_int32(* new_credentials_iterator)(cc_ccache_t in_ccache, cc_credentials_iterator_t *out_credentials_iterator)          cc_int32(* new_credentials_iterator)(cc_ccache_t in_ccache, cc_credentials_iterator_t *out_credentials_iterator)          
         
    
       
    
-
-
    
+    
    
+
+  
+    
+    
    
+       
+    
 
 
    
 cc_ccache_new_credentials_iterator(): Iterate over credentials in a ccache. 
@@ -269,21 +351,29 @@ If found, the credentials are removed from the ccache. The credentials parameter
     
    out_credentials_iterator a credentials iterator for io_ccache. 
    
   
    
 
-
    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    
+
    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    
 Allocates memory for iterator and initializes it. Successive calls to cc_credentials_iterator_next() will return credentials from the ccache.
    
-If changes are made to the ccache while an iterator is being used on it, the iterator must return at least the intersection, and at most the union, of the set of credentials that were in the ccache when the iteration began and the set of credentials that are in the ccache when it ends. 
-
    
-
    
-
-
    
-
    
-      
+If changes are made to the ccache while an iterator is being used on it, the iterator must return at least the intersection, and at most the union, of the set of credentials that were in the ccache when the iteration began and the set of credentials that are in the ccache when it ends.     
+  
+
    
+
    
+
+  
+    
+  
+
    
+      
-          
+          
    
         
    cc_int32(* move)(cc_ccache_t io_source_ccache, cc_ccache_t io_destination_ccache)          cc_int32(* move)(cc_ccache_t io_source_ccache, cc_ccache_t io_destination_ccache)          
         
    
       
    
-
-
    
+    
    
+
+  
+    
+    
    
+       
+    
 
 
    
 cc_ccache_move(): Move the contents of one ccache into another, destroying the source. 
@@ -294,21 +384,29 @@ If changes are made to the ccache while an iterator is being used on it, the ite
     
    io_destination_ccache a ccache object replace with the contents of io_source_ccache. 
    
   
    
 
-
    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    
+
    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    
 cc_ccache_move() atomically copies the credentials, credential versions and principals from one ccache to another. On successful completion io_source_ccache will be released and the ccache it points to will be destroyed. Any credentials previously in io_destination_ccache will be replaced with credentials from io_source_ccache. The only part of io_destination_ccache which remains constant is the name. Any other callers referring to io_destination_ccache will suddenly see new data in it.
    
-Typically cc_ccache_move() is used when the caller wishes to safely overwrite the contents of a ccache with new data which requires several steps to generate. cc_ccache_move() allows the caller to create a temporary ccache (which can be destroyed if any intermediate step fails) and the atomically copy the temporary cache into the destination. 
-
    
-
    
-
-
    
-
    
-      
+Typically cc_ccache_move() is used when the caller wishes to safely overwrite the contents of a ccache with new data which requires several steps to generate. cc_ccache_move() allows the caller to create a temporary ccache (which can be destroyed if any intermediate step fails) and the atomically copy the temporary cache into the destination.     
+  
+
    
+
    
+
+  
+    
+  
+
    
+      
-          
+          
    
         
    cc_int32(* lock)(cc_ccache_t io_ccache, cc_uint32 in_lock_type, cc_uint32 in_block)          cc_int32(* lock)(cc_ccache_t io_ccache, cc_uint32 in_lock_type, cc_uint32 in_block)          
         
    
       
    
-
-
    
+    
    
+
+  
+    
+    
    
+       
+    
 
 
    
 cc_ccache_lock(): Lock a ccache. 
@@ -320,31 +418,39 @@ Typically 
    		in_block whether or not the function should block if the lock cannot be obtained immediately. 
    
   
    
 
-
    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    
-Attempts to acquire a lock for a ccache. Allowed values for lock_type are:
    
+
    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    
+Attempts to acquire an advisory lock for a ccache. Allowed values for lock_type are:
    
 
      
 
    • cc_lock_read: a read lock. 
      • 
 
    • cc_lock_write: a write lock 
      • 
 
    • cc_lock_upgrade: upgrade an already-obtained read lock to a write lock 
      • 
 
    • cc_lock_downgrade: downgrade an already-obtained write lock to a read lock
      • 
 
    
-If block is cc_lock_block, lock() will not return until the lock is acquired. If block is cc_lock_noblock, lock() will return immediately, either acquiring the lock and returning ccNoError, or failing to acquire the lock and returning an error explaining why.
    
+If block is cc_lock_block, lock() will not return until the lock is acquired. If block is cc_lock_noblock, lock() will return immediately, either acquiring the lock and returning ccNoError, or failing to acquire the lock and returning an error explaining why.
    
 To avoid having to deal with differences between thread semantics on different platforms, locks are granted per ccache, rather than per thread or per process. That means that different threads of execution have to acquire separate contexts in order to be able to synchronize with each other.
    
 The lock should be unlocked by using cc_ccache_unlock().
    
-
    Note:
    All locks are advisory. For example, callers which do not call cc_ccache_lock() and cc_ccache_unlock() will not be prevented from writing to the ccache when you have a read lock. This is because the CCAPI locking was added later and thus adding mandatory locks would have changed the user experience and performance of existing applications. 
    
-
-
    
-
    
-
-
    
-
    
-      
+
    Note:
    All locks are advisory. For example, callers which do not call cc_ccache_lock() and cc_ccache_unlock() will not be prevented from writing to the ccache when you have a read lock. This is because the CCAPI locking was added after the first release and thus adding mandatory locks would have changed the user experience and performance of existing applications. 
    
+    
+  
+
    
+
    
+
+  
+    
+  
+
    
+      
-          
+          
    
         
    cc_int32(* unlock)(cc_ccache_t io_ccache)          cc_int32(* unlock)(cc_ccache_t io_ccache)          
         
    
       
    
-
-
    
+    
    
+
+  
+    
+    
    
+       
+    
 
 
    
 cc_ccache_unlock(): Unlock a ccache. 
@@ -354,20 +460,28 @@ The lock should be unlocked by using 
    		io_ccache a ccache object. 
    
   
    
 
-
    Returns:
    On success, ccNoError. On failure, an error code representing the failure. 
    
-
-
    
-
    
-
-
    
-
    
-      
+
    Returns:
    On success, ccNoError. On failure, an error code representing the failure. 
    
+    
+  
+
    
+
    
+
+  
+    
+  
+
    
+      
-          
+          
    
         
    cc_int32(* get_last_default_time)(cc_ccache_t in_ccache, cc_time_t *out_last_default_time)          cc_int32(* get_last_default_time)(cc_ccache_t in_ccache, cc_time_t *out_last_default_time)          
         
    
       
    
-
-
    
+    
    
+
+  
+    
+    
    
+       
+    
 
 
    
 cc_ccache_get_change_time(): Get the last time a ccache was the default ccache. 
@@ -378,20 +492,28 @@ The lock should be unlocked by using 
    		out_last_default_time on exit, the last time the ccache was default. 
    
   
    
 
-
    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    
-This function returns the last time when the ccache was made the default ccache. This allows clients to sort the ccaches by how recently they were default, which is useful for user listing of ccaches. If the ccache was never default, ccErrNeverDefault is returned. 
-
    
-
    
-
-
    
-
    
-      
+
    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    
+This function returns the last time when the ccache was made the default ccache. This allows clients to sort the ccaches by how recently they were default, which is useful for user listing of ccaches. If the ccache was never default, ccErrNeverDefault is returned.     
+  
+
    
+
    
+
+  
+    
+  
+
    
+      
-          
+          
    
         
    cc_int32(* get_change_time)(cc_ccache_t in_ccache, cc_time_t *out_change_time)          cc_int32(* get_change_time)(cc_ccache_t in_ccache, cc_time_t *out_change_time)          
         
    
       
    
-
-
    
+    
    
+
+  
+    
+    
    
+       
+    
 
 
    
 cc_ccache_get_change_time(): Get the last time a ccache changed. 
@@ -402,7 +524,7 @@ This function returns the last time when the ccache was made the default ccache.
     
    out_change_time on exit, the last time the ccache changed. 
    
   
    
 
-
    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    
+
    Returns:
    On success, ccNoError. If the ccache was never the default ccache, ccErrNeverDefault. Otherwise, an error code representing the failure.
    
 This function returns the time of the most recent change made to a ccache. By maintaining a local copy the caller can deduce whether or not the ccache has been modified since the previous call to cc_ccache_get_change_time().
    
 The time returned by cc_ccache_get_change_time() increases whenever:
    
 
    
-
    
-
-
    
-
    
-      
+
    Note:
    In order to be able to compare two values returned by cc_ccache_get_change_time(), the caller must use the same ccache object to acquire them. Callers should maintain a single ccache object in memory for cc_ccache_get_change_time() calls rather than creating a new ccache object for every call.
    
+
    See also:
    wait_for_change 
    
+    
+  
+
    
+
    
+
+  
+    
+  
+
    
+      
-          
+          
    
         
    cc_int32(* compare)(cc_ccache_t in_ccache, cc_ccache_t in_compare_to_ccache, cc_uint32 *out_equal)          cc_int32(* compare)(cc_ccache_t in_ccache, cc_ccache_t in_compare_to_ccache, cc_uint32 *out_equal)          
         
    
       
    
-
-
    
+    
    
+
+  
+    
+    
    
+       
+    
 
 
    
 cc_ccache_compare(): Compare two ccache objects. 
@@ -438,20 +568,28 @@ The time returned by 
    		out_equal on exit, whether or not the two ccaches refer to the same ccache. 
    
   
    
 
-
    Returns:
    On success, ccNoError. On failure, an error code representing the failure. 
    
-
-
    
-
    
-
-
    
-
    
-      
+
    Returns:
    On success, ccNoError. On failure, an error code representing the failure. 
    
+    
+  
+
    
+
    
+
+  
+    
+  
+
    
+      
-          
+          
    
         
    cc_int32(* get_kdc_time_offset)(cc_ccache_t in_ccache, cc_uint32 in_credentials_version, cc_time_t *out_time_offset)          cc_int32(* get_kdc_time_offset)(cc_ccache_t in_ccache, cc_uint32 in_credentials_version, cc_time_t *out_time_offset)          
         
    
       
    
-
-
    
+    
    
+
+  
+    
+    
    
+       
+    
 
 
    
 cc_ccache_get_kdc_time_offset(): Get the KDC time offset for credentials in a ccache. 
@@ -463,21 +601,29 @@ The time returned by 
    		out_time_offset on exit, the KDC time offset for in_ccache for credentials version in_credentials_version. 
    
   
    
 
-
    Returns:
    On success, ccNoError. On failure, an error code representing the failure. 
    
-
    See also:
    set_kdc_time_offset, clear_kdc_time_offset
    
-Sometimes the KDC and client's clocks get out of sync. cc_ccache_get_kdc_time_offset() returns the difference between the KDC and client's clocks at the time credentials were acquired. This offset allows callers to figure out how much time is left on a given credential even though the end_time is based on the KDC's clock not the client's clock. 
-
    
-
    
-
-
    
-
    
-      
+
    Returns:
    On success, ccNoError if a time offset was obtained or ccErrTimeOffsetNotSet if a time offset has not been set. On failure, an error code representing the failure. 
    
+
    See also:
    set_kdc_time_offset, clear_kdc_time_offset
    
+Sometimes the KDC and client's clocks get out of sync. cc_ccache_get_kdc_time_offset() returns the difference between the KDC and client's clocks at the time credentials were acquired. This offset allows callers to figure out how much time is left on a given credential even though the end_time is based on the KDC's clock not the client's clock.     
+  
+
    
+
    
+
+  
+    
+  
+
    
+      
-          
+          
    
         
    cc_int32(* set_kdc_time_offset)(cc_ccache_t io_ccache, cc_uint32 in_credentials_version, cc_time_t in_time_offset)          cc_int32(* set_kdc_time_offset)(cc_ccache_t io_ccache, cc_uint32 in_credentials_version, cc_time_t in_time_offset)          
         
    
       
    
-
-
    
+    
    
+
+  
+    
+    
    
+       
+    
 
 
    
 cc_ccache_set_kdc_time_offset(): Set the KDC time offset for credentials in a ccache. 
@@ -489,21 +635,29 @@ Sometimes the KDC and client's clocks get out of sync. 
    		in_time_offset the new KDC time offset for in_ccache for credentials version in_credentials_version. 
    
   
    
 
-
    Returns:
    On success, ccNoError. On failure, an error code representing the failure. 
    
-
    See also:
    get_kdc_time_offset, clear_kdc_time_offset
    
-Sometimes the KDC and client's clocks get out of sync. cc_ccache_set_kdc_time_offset() sets the difference between the KDC and client's clocks at the time credentials were acquired. This offset allows callers to figure out how much time is left on a given credential even though the end_time is based on the KDC's clock not the client's clock. 
-
    
-
    
-
-
    
-
    
-      
+
    Returns:
    On success, ccNoError. On failure, an error code representing the failure. 
    
+
    See also:
    get_kdc_time_offset, clear_kdc_time_offset
    
+Sometimes the KDC and client's clocks get out of sync. cc_ccache_set_kdc_time_offset() sets the difference between the KDC and client's clocks at the time credentials were acquired. This offset allows callers to figure out how much time is left on a given credential even though the end_time is based on the KDC's clock not the client's clock.     
+  
+
    
+
    
+
+  
+    
+  
+
    
+      
-          
+          
    
         
    cc_int32(* clear_kdc_time_offset)(cc_ccache_t io_ccache, cc_uint32 in_credentials_version)          cc_int32(* clear_kdc_time_offset)(cc_ccache_t io_ccache, cc_uint32 in_credentials_version)          
         
    
       
    
-
-
    
+    
    
+
+  
+    
+    
    
+       
+    
 
 
    
 cc_ccache_clear_kdc_time_offset(): Clear the KDC time offset for credentials in a ccache. 
@@ -514,21 +668,29 @@ Sometimes the KDC and client's clocks get out of sync. 
    		in_credentials_version the credentials version to get the time offset for. 
    
   
    
 
-
    Returns:
    On success, ccNoError. On failure, an error code representing the failure. 
    
-
    See also:
    get_kdc_time_offset, set_kdc_time_offset
    
-Sometimes the KDC and client's clocks get out of sync. cc_ccache_clear_kdc_time_offset() clears the difference between the KDC and client's clocks at the time credentials were acquired. This offset allows callers to figure out how much time is left on a given credential even though the end_time is based on the KDC's clock not the client's clock. 
-
    
-
    
-
-
    
-
    
-      
+
    Returns:
    On success, ccNoError. On failure, an error code representing the failure. 
    
+
    See also:
    get_kdc_time_offset, set_kdc_time_offset
    
+Sometimes the KDC and client's clocks get out of sync. cc_ccache_clear_kdc_time_offset() clears the difference between the KDC and client's clocks at the time credentials were acquired. This offset allows callers to figure out how much time is left on a given credential even though the end_time is based on the KDC's clock not the client's clock.     
+  
+
    
+
    
+
+  
+    
+  
+
    
+      
-          
+          
    
         
    cc_int32(* wait_for_change)(cc_ccache_t in_ccache)          cc_int32(* wait_for_change)(cc_ccache_t in_ccache)          
         
    
       
    
-
-
    
+    
    
+
+  
+    
+    
    
+       
+    
 
 
    
 cc_ccache_wait_for_change(): Wait for the next change to a ccache. 
@@ -538,7 +700,7 @@ Sometimes the KDC and client's clocks get out of sync. 
    		in_ccache a ccache object. 
    
   
    
 
-
    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    
+
    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    
 This function blocks until the next change is made to the ccache referenced by in_ccache. By repeatedly calling cc_ccache_wait_for_change() from a worker thread the caller can effectively receive callbacks whenever the ccache changes. This is considerably more efficient than polling with cc_ccache_get_change_time().
    
 cc_ccache_wait_for_change() will return whenever:
    
 
      
@@ -548,13 +710,13 @@ This function blocks until the next change is made to the ccache referenced by <
 
    • the ccache becomes the default ccache 
      • 
 
    • the ccache is no longer the default ccache
      • 
 
    
-
    Note:
    In order to make sure that the caller doesn't miss any changes, cc_ccache_wait_for_change() always returns immediately after the first time it is called on a new ccache object. Callers must use the same ccache object for successive calls to cc_ccache_wait_for_change() rather than creating a new ccache object for every call.
    
-
    See also:
    get_change_time 
    
-
-
    
-
    
-
    Generated on Mon Sep 10 17:00:32 2007 for Credentials Cache API by 
+
    Note:
    In order to make sure that the caller doesn't miss any changes, cc_ccache_wait_for_change() always returns immediately after the first time it is called on a new ccache object. Callers must use the same ccache object for successive calls to cc_ccache_wait_for_change() rather than creating a new ccache object for every call.
    
+
    See also:
    get_change_time 
    
+
    • +

    Generated on Tue Oct 2 17:16:05 2007 for Credentials Cache API by  -doxygen 1.5.3
    +doxygen 1.4.6 diff --git a/doc/ccapi/html/structcc__ccache__iterator__d.html b/doc/ccapi/html/structcc__ccache__iterator__d.html index 696aa6aff..5e85ee2da 100644 --- a/doc/ccapi/html/structcc__ccache__iterator__d.html +++ b/doc/ccapi/html/structcc__ccache__iterator__d.html @@ -1,36 +1,43 @@ - -Credentials Cache API: cc_ccache_iterator_d Struct Reference + +Credentials Cache API : cc_ccache_iterator_d Struct Reference - +

    cc_ccache_iterator_d Struct Reference
    [cc_ccache_iterator_t Overview]

    Data Fields

    Field Documentation

    - -
    -
    - +

    +

    + + + +
    + - +
    const cc_ccache_iterator_f* functions const cc_ccache_iterator_f* functions
    - -
    +
    + + + + + +
    +   +

    - - -

    -

    Generated on Mon Sep 10 17:00:32 2007 for Credentials Cache API by  +
    +
    Generated on Tue Oct 2 17:16:05 2007 for Credentials Cache API by  -doxygen 1.5.3
    +doxygen 1.4.6 diff --git a/doc/ccapi/html/structcc__ccache__iterator__f.html b/doc/ccapi/html/structcc__ccache__iterator__f.html index af0643ab2..333aab8f4 100644 --- a/doc/ccapi/html/structcc__ccache__iterator__f.html +++ b/doc/ccapi/html/structcc__ccache__iterator__f.html @@ -1,28 +1,38 @@ - -Credentials Cache API: cc_ccache_iterator_f Struct Reference + +Credentials Cache API : cc_ccache_iterator_f Struct Reference - +

    cc_ccache_iterator_f Struct Reference

    Detailed Description

    -Function pointer table for cc_ccache_iterator_t. For more information see cc_ccache_iterator_t Overview.

    Data Fields

    +Function pointer table for cc_ccache_iterator_t. For more information see cc_ccache_iterator_t Overview. +

    +

    Data Fields

    Field Documentation

    - -
    -
    - +

    +

    + + + +
    + - +
    cc_int32(* release)(cc_ccache_iterator_t io_ccache_iterator) cc_int32(* release)(cc_ccache_iterator_t io_ccache_iterator)
    - -
    +
    + + + +
    +   +

    cc_ccache_iterator_release(): Release memory associated with a cc_ccache_iterator_t object. @@ -32,20 +42,28 @@ Function pointer table for cc_ccache_iterator_t. For more information see

    		io_ccache_iterator the ccache iterator object to release.
    -
    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    - -
    -

    - -

    -
    - +
    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    + + +
    +

    + + + + +
    + - +
    cc_int32(* next)(cc_ccache_iterator_t in_ccache_iterator, cc_ccache_t *out_ccache) cc_int32(* next)(cc_ccache_iterator_t in_ccache_iterator, cc_ccache_t *out_ccache)
    - -
    +
    + + + +
    +   +

    cc_ccache_iterator_next(): Get the next ccache in the cache collection. @@ -56,20 +74,28 @@ Function pointer table for cc_ccache_iterator_t. For more information see

    		out_ccache on exit, the next ccache in the cache collection.
    -

    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    - -
    -

    - -

    -
    - +
    Returns:
    On success, ccNoError if the next ccache in the cache collection was obtained or ccIteratorEnd if there are no more ccaches. On failure, an error code representing the failure.
    + + +
    +

    + + + + +
    + - +
    cc_int32(* clone)(cc_ccache_iterator_t in_ccache_iterator, cc_ccache_iterator_t *out_ccache_iterator) cc_int32(* clone)(cc_ccache_iterator_t in_ccache_iterator, cc_ccache_iterator_t *out_ccache_iterator)
    - -
    +
    + + + +
    +   +

    cc_ccache_iterator_clone(): Make a copy of a ccache iterator. @@ -80,12 +106,12 @@ Function pointer table for cc_ccache_iterator_t. For more information see

    		out_ccache_iterator on exit, a copy of in_ccache_iterator.
    -

    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    - -
    -

    -

    Generated on Mon Sep 10 17:00:32 2007 for Credentials Cache API by  +
    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    +
    +

    Generated on Tue Oct 2 17:16:05 2007 for Credentials Cache API by  -doxygen 1.5.3
    +doxygen 1.4.6 diff --git a/doc/ccapi/html/structcc__context__d.html b/doc/ccapi/html/structcc__context__d.html index 6f2dc456a..d3904a2a1 100644 --- a/doc/ccapi/html/structcc__context__d.html +++ b/doc/ccapi/html/structcc__context__d.html @@ -1,10 +1,10 @@ - -Credentials Cache API: cc_context_d Struct Reference + +Credentials Cache API : cc_context_d Struct Reference - +

    cc_context_d Struct Reference
    [cc_context_t Overview] @@ -13,23 +13,31 @@
  • const cc_context_f * functions

    Field Documentation

    - -
    -
    - +

    +

    + + + +
    + - +
    const cc_context_f* functions const cc_context_f* functions
    - -
    +
    + + + + + +
    +   +

    - - -

    -

    Generated on Mon Sep 10 17:00:32 2007 for Credentials Cache API by  +
    +
    Generated on Tue Oct 2 17:16:05 2007 for Credentials Cache API by  -doxygen 1.5.3
    +doxygen 1.4.6 diff --git a/doc/ccapi/html/structcc__context__f.html b/doc/ccapi/html/structcc__context__f.html index c5a182c63..fe310518a 100644 --- a/doc/ccapi/html/structcc__context__f.html +++ b/doc/ccapi/html/structcc__context__f.html @@ -1,12 +1,14 @@ - -Credentials Cache API: cc_context_f Struct Reference + +Credentials Cache API : cc_context_f Struct Reference - +

    cc_context_f Struct Reference

    Detailed Description

    -Function pointer table for cc_context_t. For more information see cc_context_t Overview.

    Data Fields

    +Function pointer table for cc_context_t. For more information see cc_context_t Overview. +

    +

    Data Fields

    Field Documentation

    - -
    -
    - +

    +

    + + + +
    + - +
    cc_int32(* release)(cc_context_t io_context) cc_int32(* release)(cc_context_t io_context)
    - -
    +
    + + + +
    +   +

    cc_context_release(): Release memory associated with a cc_context_t. @@ -42,20 +52,28 @@ Function pointer table for cc_context_t. For more information see

    		io_context the context object to free.
    -
    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    - -
    -

    - -

    -
    - +
    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    + + +
    +

    + + + + +
    + - +
    cc_int32(* get_change_time)(cc_context_t in_context, cc_time_t *out_time) cc_int32(* get_change_time)(cc_context_t in_context, cc_time_t *out_time)
    - -
    +
    + + + +
    +   +

    cc_context_get_change_time(): Get the last time the cache collection changed. @@ -66,7 +84,7 @@ Function pointer table for cc_context_t. For more information see

    		out_time on exit, the time of the most recent change for the entire ccache collection.
    -

    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    +
    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    This function returns the time of the most recent change for the entire ccache collection. By maintaining a local copy the caller can deduce whether or not the ccache collection has been modified since the previous call to cc_context_get_change_time().

    The time returned by cc_context_get_changed_time() increases whenever:

      @@ -77,21 +95,29 @@ The time returned by cc_context_get_changed_time() increases whenever:

    • a ccache principal is changed
    • the default ccache is changed
    -
    Note:
    In order to be able to compare two values returned by cc_context_get_change_time(), the caller must use the same context to acquire them. Callers should maintain a single context in memory for cc_context_get_change_time() calls rather than creating a new context for every call.
    -
    See also:
    wait_for_change
    - -
    -

    - -

    -
    - +
    Note:
    In order to be able to compare two values returned by cc_context_get_change_time(), the caller must use the same context to acquire them. Callers should maintain a single context in memory for cc_context_get_change_time() calls rather than creating a new context for every call.
    +
    See also:
    wait_for_change
    + + +
    +

    + + + + +
    + - +
    cc_int32(* get_default_ccache_name)(cc_context_t in_context, cc_string_t *out_name) cc_int32(* get_default_ccache_name)(cc_context_t in_context, cc_string_t *out_name)
    - -
    +
    + + + +
    +   +

    cc_context_get_default_ccache_name(): Get the name of the default ccache. @@ -102,22 +128,30 @@ The time returned by cc_context_get_changed_time() increases whenever:

    out_name on exit, the name of the default ccache.
    -

    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    +
    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    This function returns the name of the default ccache. When the default ccache exists, its name is returned. If there are no ccaches in the collection, and thus there is no default ccache, the name that the default ccache should have is returned. The ccache with that name will be used as the default ccache by all processes which initialized Kerberos libraries before the ccache was created.

    -If there is no default ccache, and the client is creating a new ccache, it should be created with the default name. If there already is a default ccache, and the client wants to create a new ccache (as opposed to reusing an existing ccache), it should be created with any unique name; create_new_ccache() can be used to accomplish that more easily.

    -If the first ccache is created with a name other than the default name, then the processes already running will not notice the credentials stored in the new ccache, which is normally undesirable. -

    -

    - -

    -
    - +If there is no default ccache, and the client is creating a new ccache, it should be created with the default name. If there already is a default ccache, and the client wants to create a new ccache (as opposed to reusing an existing ccache), it should be created with any unique name; create_new_ccache() can be used to accomplish that more easily.

    +If the first ccache is created with a name other than the default name, then the processes already running will not notice the credentials stored in the new ccache, which is normally undesirable. + +

    +

    + + + + +
    + - +
    cc_int32(* open_ccache)(cc_context_t in_context, const char *in_name, cc_ccache_t *out_ccache) cc_int32(* open_ccache)(cc_context_t in_context, const char *in_name, cc_ccache_t *out_ccache)
    - -
    +
    + + + +
    +   +

    cc_context_open_ccache(): Open a ccache. @@ -129,21 +163,29 @@ If the first ccache is created with a name other than the default name, then the

    out_ccache on exit, a ccache object for the ccache
    -

    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    +
    Returns:
    On success, ccNoError. If no ccache named in_name exists, ccErrCCacheNotFound. On failure, an error code representing the failure.
    Opens an already existing ccache identified by its name. It returns a reference to the ccache in out_ccache.

    -The list of all ccache names, principals, and credentials versions may be retrieved by calling cc_context_new_cache_iterator(), cc_ccache_get_name(), cc_ccache_get_principal(), and cc_ccache_get_cred_version(). -

    -

    - -

    -
    - +The list of all ccache names, principals, and credentials versions may be retrieved by calling cc_context_new_cache_iterator(), cc_ccache_get_name(), cc_ccache_get_principal(), and cc_ccache_get_cred_version(). + +
    +

    + + + + +
    + - +
    cc_int32(* open_default_ccache)(cc_context_t in_context, cc_ccache_t *out_ccache) cc_int32(* open_default_ccache)(cc_context_t in_context, cc_ccache_t *out_ccache)
    - -
    +
    + + + +
    +   +

    cc_context_open_default_ccache(): Open the default ccache. @@ -154,21 +196,29 @@ The list of all ccache names, principals, and credentials versions may be retrie

    out_ccache on exit, a ccache object for the default ccache
    -

    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    +
    Returns:
    On success, ccNoError. If no default ccache exists, ccErrCCacheNotFound. On failure, an error code representing the failure.
    Opens the default ccache. It returns a reference to the ccache in *ccache.

    -This function performs the same function as calling cc_context_get_default_ccache_name followed by cc_context_open_ccache, but it performs it atomically. -

    -

    - -

    -
    - +This function performs the same function as calling cc_context_get_default_ccache_name followed by cc_context_open_ccache, but it performs it atomically. + +
    +

    + + + + +
    + - +
    cc_int32(* create_ccache)(cc_context_t in_context, const char *in_name, cc_uint32 in_cred_vers, const char *in_principal, cc_ccache_t *out_ccache) cc_int32(* create_ccache)(cc_context_t in_context, const char *in_name, cc_uint32 in_cred_vers, const char *in_principal, cc_ccache_t *out_ccache)
    - -
    +
    + + + +
    +   +

    cc_context_create_ccache(): Create a new ccache. @@ -182,7 +232,7 @@ This function performs the same function as calling cc_context_get_default_ccach

    out_ccache on exit, a ccache object for the newly created ccache
    -

    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    +
    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    Create a new credentials cache. The ccache is uniquely identified by its name. The principal given is also associated with the ccache and the credentials version specified. A NULL name is not allowed (and ccErrBadName is returned if one is passed in). Only cc_credentials_v4 and cc_credentials_v5 are valid input values for cred_vers. If you want to create a new ccache that will hold both versions of credentials, call cc_context_create_ccache() with one version, and then cc_ccache_set_principal() with the other version.

    If you want to create a new ccache (with a unique name), you should use cc_context_create_new_ccache() instead. If you want to create or reinitialize the default cache, you should use cc_context_create_default_ccache().

    If name is non-NULL and there is already a ccache named name:

    @@ -199,20 +249,28 @@ If no ccache named name already exists:

    For a new ccache, the name should be any unique string. The name is not intended to be presented to users.

    If the created ccache is the first ccache in the collection, it is made the default ccache. Note that normally it is undesirable to create the first ccache with a name different from the default ccache name (as returned by cc_context_get_default_ccache_name()); see the description of cc_context_get_default_ccache_name() for details.

    -The principal should be a C string containing an unparsed Kerberos principal in the format of the appropriate Kerberos version, i.e. 

    foo.bar/@BAZ 
-      *
    for Kerberos v4 and 
    foo/bar/@BAZ
    for Kerberos v5. -
    -

    - -

    -
    - +The principal should be a C string containing an unparsed Kerberos principal in the format of the appropriate Kerberos version, i.e.
    foo.bar/@BAZ 
+      *
    for Kerberos v4 and
    foo/bar/@BAZ
    for Kerberos v5. + +
    +

    + + + + +
    + - +
    cc_int32(* create_default_ccache)(cc_context_t in_context, cc_uint32 in_cred_vers, const char *in_principal, cc_ccache_t *out_ccache) cc_int32(* create_default_ccache)(cc_context_t in_context, cc_uint32 in_cred_vers, const char *in_principal, cc_ccache_t *out_ccache)
    - -
    +
    + + + +
    +   +

    cc_context_create_default_ccache(): Create a new default ccache. @@ -225,20 +283,28 @@ The principal should be a C string containing an unparsed Kerberos principal in

    out_ccache on exit, a ccache object for the newly created default ccache
    -

    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    -Create the default credentials cache. The behavior of this function is similar to that of cc_create_ccache(). If there is a default ccache (which is always the case except when there are no ccaches at all in the collection), it is initialized with the specified credentials version and principal, as per cc_create_ccache(); otherwise, a new ccache is created, and its name is the name returned by cc_context_get_default_ccache_name(). -
    -

    - -

    -
    - +
    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    +Create the default credentials cache. The behavior of this function is similar to that of cc_create_ccache(). If there is a default ccache (which is always the case except when there are no ccaches at all in the collection), it is initialized with the specified credentials version and principal, as per cc_create_ccache(); otherwise, a new ccache is created, and its name is the name returned by cc_context_get_default_ccache_name(). + +
    +

    + + + + +
    + - +
    cc_int32(* create_new_ccache)(cc_context_t in_context, cc_uint32 in_cred_vers, const char *in_principal, cc_ccache_t *out_ccache) cc_int32(* create_new_ccache)(cc_context_t in_context, cc_uint32 in_cred_vers, const char *in_principal, cc_ccache_t *out_ccache)
    - -
    +
    + + + +
    +   +

    cc_context_create_new_ccache(): Create a new uniquely named ccache. @@ -251,20 +317,28 @@ Create the default credentials cache. The behavior of this function is similar t

    out_ccache on exit, a ccache object for the newly created ccache
    -

    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    -Create a new unique credentials cache. The behavior of this function is similar to that of cc_create_ccache(). If there are no ccaches, and therefore no default ccache, the new ccache is created with the default ccache name as would be returned by get_default_ccache_name(). If there are some ccaches, and therefore there is a default ccache, the new ccache is created with a new unique name. Clearly, this function never reinitializes a ccache, since it always uses a unique name. -
    -

    - -

    -
    - +
    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    +Create a new unique credentials cache. The behavior of this function is similar to that of cc_create_ccache(). If there are no ccaches, and therefore no default ccache, the new ccache is created with the default ccache name as would be returned by get_default_ccache_name(). If there are some ccaches, and therefore there is a default ccache, the new ccache is created with a new unique name. Clearly, this function never reinitializes a ccache, since it always uses a unique name. + +
    +

    + + + + +
    + - +
    cc_int32(* new_ccache_iterator)(cc_context_t in_context, cc_ccache_iterator_t *out_iterator) cc_int32(* new_ccache_iterator)(cc_context_t in_context, cc_ccache_iterator_t *out_iterator)
    - -
    +
    + + + +
    +   +

    cc_context_new_ccache_iterator(): Get an iterator for the cache collection. @@ -275,21 +349,29 @@ Create a new unique credentials cache. The behavior of this function is similar

    out_iterator on exit, a ccache iterator object for the ccache collection.
    -

    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    +
    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    Used to allocate memory and initialize iterator. Successive calls to iterator's next() function will return ccaches in the collection.

    -If changes are made to the collection while an iterator is being used on it, the iterator must return at least the intersection, and at most the union, of the set of ccaches that were present when the iteration began and the set of ccaches that are present when it ends. -

    -

    - -

    -
    - +If changes are made to the collection while an iterator is being used on it, the iterator must return at least the intersection, and at most the union, of the set of ccaches that were present when the iteration began and the set of ccaches that are present when it ends. + +
    +

    + + + + +
    + - +
    cc_int32(* lock)(cc_context_t in_context, cc_uint32 in_lock_type, cc_uint32 in_block) cc_int32(* lock)(cc_context_t in_context, cc_uint32 in_lock_type, cc_uint32 in_block)
    - -
    +
    + + + +
    +   +

    cc_context_lock(): Lock the cache collection. @@ -301,32 +383,40 @@ If changes are made to the collection while an iterator is being used on it, the

    in_block whether or not the function should block if the lock cannot be obtained immediately.
    -

    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    -Attempts to acquire a lock for the ccache collection. Allowed values for lock_type are:

    +

    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    +Attempts to acquire an advisory lock for the ccache collection. Allowed values for lock_type are:

    • cc_lock_read: a read lock.
    • cc_lock_write: a write lock
    • cc_lock_upgrade: upgrade an already-obtained read lock to a write lock
    • cc_lock_downgrade: downgrade an already-obtained write lock to a read lock
    -If block is cc_lock_block, lock() will not return until the lock is acquired. If block is cc_lock_noblock, lock() will return immediately, either acquiring the lock and returning ccNoError, or failing to acquire the lock and returning an error explaining why.

    +If block is cc_lock_block, lock() will not return until the lock is acquired. If block is cc_lock_noblock, lock() will return immediately, either acquiring the lock and returning ccNoError, or failing to acquire the lock and returning an error explaining why.

    Locks apply only to the list of ccaches, not the contents of those ccaches. To prevent callers participating in the advisory locking from changing the credentials in a cache you must also lock that ccache with cc_ccache_lock(). This is so that you can get the list of ccaches without preventing applications from simultaneously obtaining service tickets.

    To avoid having to deal with differences between thread semantics on different platforms, locks are granted per context, rather than per thread or per process. That means that different threads of execution have to acquire separate contexts in order to be able to synchronize with each other.

    The lock should be unlocked by using cc_context_unlock().

    -

    Note:
    All locks are advisory. For example, callers which do not call cc_context_lock() and cc_context_unlock() will not be prevented from writing to the cache collection when you have a read lock. This is because the CCAPI locking was added later and thus adding mandatory locks would have changed the user experience and performance of existing applications.
    - -
    -

    - -

    -
    - +
    Note:
    All locks are advisory. For example, callers which do not call cc_context_lock() and cc_context_unlock() will not be prevented from writing to the cache collection when you have a read lock. This is because the CCAPI locking was added after the first release and thus adding mandatory locks would have changed the user experience and performance of existing applications.
    + + +
    +

    + + + + +
    + - +
    cc_int32(* unlock)(cc_context_t in_cc_context) cc_int32(* unlock)(cc_context_t in_cc_context)
    - -
    +
    + + + +
    +   +

    cc_context_unlock(): Unlock the cache collection. @@ -336,20 +426,28 @@ The lock should be unlocked by using

    		in_context the context object for the cache collection.
    -

    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    - -
    -

    - -

    -
    - +
    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    + + +
    +

    + + + + +
    + - +
    cc_int32(* compare)(cc_context_t in_cc_context, cc_context_t in_compare_to_context, cc_uint32 *out_equal) cc_int32(* compare)(cc_context_t in_cc_context, cc_context_t in_compare_to_context, cc_uint32 *out_equal)
    - -
    +
    + + + +
    +   +

    cc_context_compare(): Compare two context objects. @@ -361,20 +459,28 @@ The lock should be unlocked by using

    		out_equal on exit, whether or not the two contexts refer to the same cache collection.
    -

    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    - -
    -

    - -

    -
    - +
    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    + + +
    +

    + + + + +
    + - +
    cc_int32(* wait_for_change)(cc_context_t in_cc_context) cc_int32(* wait_for_change)(cc_context_t in_cc_context)
    - -
    +
    + + + +
    +   +

    cc_context_wait_for_change(): Wait for the next change in the cache collection. @@ -384,7 +490,7 @@ The lock should be unlocked by using

    		in_context a context object.
    -

    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    +
    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    This function blocks until the next change is made to the cache collection ccache collection. By repeatedly calling cc_context_wait_for_change() from a worker thread the caller can effectively receive callbacks whenever the cache collection changes. This is considerably more efficient than polling with cc_context_get_change_time().

    cc_context_wait_for_change() will return whenever:

      @@ -395,13 +501,13 @@ This function blocks until the next change is made to the cache collection ccach
    • a ccache principal is changed
    • the default ccache is changed
    -
    Note:
    In order to make sure that the caller doesn't miss any changes, cc_context_wait_for_change() always returns immediately after the first time it is called on a new context object. Callers must use the same context object for successive calls to cc_context_wait_for_change() rather than creating a new context for every call.
    -
    See also:
    get_change_time
    - -
    -

    -

    Generated on Mon Sep 10 17:00:32 2007 for Credentials Cache API by  +
    Note:
    In order to make sure that the caller doesn't miss any changes, cc_context_wait_for_change() always returns immediately after the first time it is called on a new context object. Callers must use the same context object for successive calls to cc_context_wait_for_change() rather than creating a new context for every call.
    +
    See also:
    get_change_time
    +

    • +

    Generated on Tue Oct 2 17:16:05 2007 for Credentials Cache API by  -doxygen 1.5.3
    +doxygen 1.4.6 diff --git a/doc/ccapi/html/structcc__credentials__d.html b/doc/ccapi/html/structcc__credentials__d.html index b616019b4..8a13251e5 100644 --- a/doc/ccapi/html/structcc__credentials__d.html +++ b/doc/ccapi/html/structcc__credentials__d.html @@ -1,52 +1,67 @@ - -Credentials Cache API: cc_credentials_d Struct Reference + +Credentials Cache API : cc_credentials_d Struct Reference - +

    cc_credentials_d Struct Reference
    [cc_credentials_t Overview]

    Data Fields

    Field Documentation

    - -
    -
    - +

    +

    + + + +
    + - +
    const cc_credentials_union* data const cc_credentials_union* data
    - -
    +
    + + + + + +
    +   +

    - - -

    - -

    -
    - + + +
    +

    + + + + +
    + - +
    const cc_credentials_f* functions const cc_credentials_f* functions
    - -
    +
    + + + + + +
    +   +

    - - -

    -

    Generated on Mon Sep 10 17:00:32 2007 for Credentials Cache API by  +
    +

    Generated on Tue Oct 2 17:16:06 2007 for Credentials Cache API by  -doxygen 1.5.3
    +doxygen 1.4.6 diff --git a/doc/ccapi/html/structcc__credentials__f.html b/doc/ccapi/html/structcc__credentials__f.html index 68a833fdb..91f4b3adb 100644 --- a/doc/ccapi/html/structcc__credentials__f.html +++ b/doc/ccapi/html/structcc__credentials__f.html @@ -1,27 +1,37 @@ - -Credentials Cache API: cc_credentials_f Struct Reference + +Credentials Cache API : cc_credentials_f Struct Reference - +

    cc_credentials_f Struct Reference

    Detailed Description

    -Function pointer table for cc_credentials_t. For more information see cc_credentials_t Overview.

    Data Fields

    +Function pointer table for cc_credentials_t. For more information see cc_credentials_t Overview. +

    +

    Data Fields

    Field Documentation

    - -
    -
    - +

    +

    + + + +
    + - +
    cc_int32(* release)(cc_credentials_t io_credentials) cc_int32(* release)(cc_credentials_t io_credentials)
    - -
    +
    + + + +
    +   +

    cc_credentials_release(): Release memory associated with a cc_credentials_t object. @@ -31,20 +41,28 @@ Function pointer table for cc_credentials_t. For more information see

    		io_credentials the credentials object to release.
    -
    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    - -
    -

    - -

    -
    - +
    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    + + +
    +

    + + + + +
    + - +
    cc_int32(* compare)(cc_credentials_t in_credentials, cc_credentials_t in_compare_to_credentials, cc_uint32 *out_equal) cc_int32(* compare)(cc_credentials_t in_credentials, cc_credentials_t in_compare_to_credentials, cc_uint32 *out_equal)
    - -
    +
    + + + +
    +   +

    cc_credentials_compare(): Compare two credentials objects. @@ -56,12 +74,12 @@ Function pointer table for cc_credentials_t. For more information see

    		out_equal on exit, whether or not the two credentials objects refer to the same credentials in the cache collection.
    -

    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    - -
    -

    -

    Generated on Mon Sep 10 17:00:32 2007 for Credentials Cache API by  +
    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    +
    +
    Generated on Tue Oct 2 17:16:06 2007 for Credentials Cache API by  -doxygen 1.5.3
    +doxygen 1.4.6 diff --git a/doc/ccapi/html/structcc__credentials__iterator__d.html b/doc/ccapi/html/structcc__credentials__iterator__d.html index 5b9cef49b..5682db0ed 100644 --- a/doc/ccapi/html/structcc__credentials__iterator__d.html +++ b/doc/ccapi/html/structcc__credentials__iterator__d.html @@ -1,36 +1,43 @@ - -Credentials Cache API: cc_credentials_iterator_d Struct Reference + +Credentials Cache API : cc_credentials_iterator_d Struct Reference - +

    cc_credentials_iterator_d Struct Reference
    [cc_credentials_iterator_t]

    Data Fields

    Field Documentation

    - -
    -
    - +

    +

    + + + +
    + - +
    const cc_credentials_iterator_f* functions const cc_credentials_iterator_f* functions
    - -
    +
    + + + + + +
    +   +

    - - -

    -

    Generated on Mon Sep 10 17:00:32 2007 for Credentials Cache API by  +
    +
    Generated on Tue Oct 2 17:16:06 2007 for Credentials Cache API by  -doxygen 1.5.3
    +doxygen 1.4.6 diff --git a/doc/ccapi/html/structcc__credentials__iterator__f.html b/doc/ccapi/html/structcc__credentials__iterator__f.html index 494c7a9a4..66aec178a 100644 --- a/doc/ccapi/html/structcc__credentials__iterator__f.html +++ b/doc/ccapi/html/structcc__credentials__iterator__f.html @@ -1,28 +1,38 @@ - -Credentials Cache API: cc_credentials_iterator_f Struct Reference + +Credentials Cache API : cc_credentials_iterator_f Struct Reference - +

    cc_credentials_iterator_f Struct Reference

    Detailed Description

    -Function pointer table for cc_credentials_iterator_t. For more information see cc_credentials_iterator_t.

    Data Fields

    +Function pointer table for cc_credentials_iterator_t. For more information see cc_credentials_iterator_t. +

    +

    Data Fields

    Field Documentation

    - -
    -
    - +

    +

    + + + +
    + - +
    cc_int32(* release)(cc_credentials_iterator_t io_credentials_iterator) cc_int32(* release)(cc_credentials_iterator_t io_credentials_iterator)
    - -
    +
    + + + +
    +   +

    cc_credentials_iterator_release(): Release memory associated with a cc_credentials_iterator_t object. @@ -32,20 +42,28 @@ Function pointer table for cc_credentials_iterator_t. For more information see <

    io_credentials_iterator the credentials iterator object to release.
    -
    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    - -
    -

    - -

    -
    - +
    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    + + +
    +

    + + + + +
    + - +
    cc_int32(* next)(cc_credentials_iterator_t in_credentials_iterator, cc_credentials_t *out_credentials) cc_int32(* next)(cc_credentials_iterator_t in_credentials_iterator, cc_credentials_t *out_credentials)
    - -
    +
    + + + +
    +   +

    cc_credentials_iterator_next(): Get the next credentials in the ccache. @@ -56,12 +74,12 @@ Function pointer table for cc_credentials_iterator_t. For more information see <

    out_credentials on exit, the next credentials in the ccache.
    -

    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    - -
    -

    -

    Generated on Mon Sep 10 17:00:32 2007 for Credentials Cache API by  +
    Returns:
    On success, ccNoError if the next credential in the ccache was obtained or ccIteratorEnd if there are no more credentials. On failure, an error code representing the failure.
    +
    +

    Generated on Tue Oct 2 17:16:06 2007 for Credentials Cache API by  -doxygen 1.5.3
    +doxygen 1.4.6 diff --git a/doc/ccapi/html/structcc__credentials__union.html b/doc/ccapi/html/structcc__credentials__union.html index 81e0ba58c..6082346cc 100644 --- a/doc/ccapi/html/structcc__credentials__union.html +++ b/doc/ccapi/html/structcc__credentials__union.html @@ -1,10 +1,10 @@ - -Credentials Cache API: cc_credentials_union Struct Reference + +Credentials Cache API : cc_credentials_union Struct Reference - +

    cc_credentials_union Struct Reference
    [cc_credentials_t Overview] @@ -19,68 +19,100 @@
  • } credentials

    Field Documentation

    - -
    -
    - +

    +

    + + + +
    + - +
    cc_uint32 version cc_uint32 version
    - -
    +
    + + + +
    +   +

    -The credentials version of this credentials object. - -

    - -

    -
    - +The credentials version of this credentials object. + +
    +

    + + + + +
    + - +
    cc_credentials_v4_t* credentials_v4 cc_credentials_v4_t* credentials_v4
    - -
    +
    + + + +
    +   +

    -If version is cc_credentials_v4, a pointer to a cc_credentials_v4_t. - -

    - -

    -
    - +If version is cc_credentials_v4, a pointer to a cc_credentials_v4_t. + +
    +

    + + + + +
    + - +
    cc_credentials_v5_t* credentials_v5 cc_credentials_v5_t* credentials_v5
    - -
    +
    + + + +
    +   +

    -If version is cc_credentials_v5, a pointer to a cc_credentials_v5_t. - -

    - -

    -
    - +If version is cc_credentials_v5, a pointer to a cc_credentials_v5_t. + +
    +

    + + + + +
    + - +
    union { ... } credentials union { ... } credentials
    - -
    +
    + + + + + +
    +   +

    -The credentials. - -

    -

    Generated on Mon Sep 10 17:00:32 2007 for Credentials Cache API by  +The credentials.
    +

    Generated on Tue Oct 2 17:16:06 2007 for Credentials Cache API by  -doxygen 1.5.3
    +doxygen 1.4.6 diff --git a/doc/ccapi/html/structcc__credentials__v4__t.html b/doc/ccapi/html/structcc__credentials__v4__t.html index df3f8e315..086e7fea7 100644 --- a/doc/ccapi/html/structcc__credentials__v4__t.html +++ b/doc/ccapi/html/structcc__credentials__v4__t.html @@ -1,15 +1,17 @@ - -Credentials Cache API: cc_credentials_v4_t Struct Reference + +Credentials Cache API : cc_credentials_v4_t Struct Reference - +

    cc_credentials_v4_t Struct Reference
    [cc_credentials_t Overview]

    Detailed Description

    -If a cc_credentials_t variable is used to store Kerberos v4 credentials, then credentials.credentials_v4 points to a v4 credentials structure. This structure is similar to a krb4 API CREDENTIALS structure.

    Data Fields

    +If a cc_credentials_t variable is used to store Kerberos v4 credentials, then credentials.credentials_v4 points to a v4 credentials structure. This structure is similar to a krb4 API CREDENTIALS structure. +

    +

    Data Fields

    • cc_uint32 version
    • char principal [cc_v4_name_size] @@ -27,218 +29,330 @@ If a cc_credentials_t variable is used to store Kerberos v4 credentials, then cr
    • unsigned char ticket [cc_v4_ticket_size]

    Field Documentation

    - -
    -
    - +

    +

    + + + +
    + - +
    cc_uint32 version cc_uint32 version
    - -
    +
    + + + +
    +   +

    - - -

    - -

    -
    - + + +
    +

    + + + + +
    + - +
    char principal[cc_v4_name_size] char principal[cc_v4_name_size]
    - -
    +
    + + + +
    +   +

    -A properly quoted string representation of the first component of the client principal - -

    - -

    -
    - +A properly quoted string representation of the first component of the client principal + +
    +

    + + + + +
    + - +
    char principal_instance[cc_v4_instance_size] char principal_instance[cc_v4_instance_size]
    - -
    +
    + + + +
    +   +

    -A properly quoted string representation of the second component of the client principal - -

    - -

    -
    - +A properly quoted string representation of the second component of the client principal + +
    +

    + + + + +
    + - +
    char service[cc_v4_name_size] char service[cc_v4_name_size]
    - -
    +
    + + + +
    +   +

    -A properly quoted string representation of the first component of the service principal - -

    - -

    -
    - +A properly quoted string representation of the first component of the service principal + +
    +

    + + + + +
    + - +
    char service_instance[cc_v4_instance_size] char service_instance[cc_v4_instance_size]
    - -
    +
    + + + +
    +   +

    -A properly quoted string representation of the second component of the service principal - -

    - -

    -
    - +A properly quoted string representation of the second component of the service principal + +
    +

    + + + + +
    + - +
    char realm[cc_v4_realm_size] char realm[cc_v4_realm_size]
    - -
    +
    + + + +
    +   +

    -A properly quoted string representation of the realm - -

    - -

    -
    - +A properly quoted string representation of the realm + +
    +

    + + + + +
    + - +
    unsigned char session_key[cc_v4_key_size] unsigned char session_key[cc_v4_key_size]
    - -
    +
    + + + +
    +   +

    -Ticket session key - -

    - -

    -
    - +Ticket session key + +
    +

    + + + + +
    + - +
    cc_int32 kvno cc_int32 kvno
    - -
    +
    + + + +
    +   +

    -Key version number - -

    - -

    -
    - +Key version number + +
    +

    + + + + +
    + - +
    cc_int32 string_to_key_type cc_int32 string_to_key_type
    - -
    +
    + + + +
    +   +

    -String to key type used. See cc_string_to_key_type for valid values - -

    - -

    -
    - +String to key type used. See cc_string_to_key_type for valid values + +
    +

    + + + + +
    + - +
    cc_time_t issue_date cc_time_t issue_date
    - -
    +
    + + + +
    +   +

    -Time when the ticket was issued - -

    - -

    -
    - +Time when the ticket was issued + +
    +

    + + + + +
    + - +
    cc_int32 lifetime cc_int32 lifetime
    - -
    +
    + + + +
    +   +

    -Ticket lifetime in 5 minute units - -

    - -

    -
    - +Ticket lifetime in 5 minute units + +
    +

    + + + + +
    + - +
    cc_uint32 address cc_uint32 address
    - -
    +
    + + + +
    +   +

    -IPv4 address of the client the ticket was issued for - -

    - -

    -
    - +IPv4 address of the client the ticket was issued for + +
    +

    + + + + +
    + - +
    cc_int32 ticket_size cc_int32 ticket_size
    - -
    +
    + + + +
    +   +

    -Ticket size (no greater than cc_v4_ticket_size) - -

    - -

    -
    - +Ticket size (no greater than cc_v4_ticket_size) + +
    +

    + + + + +
    + - +
    unsigned char ticket[cc_v4_ticket_size] unsigned char ticket[cc_v4_ticket_size]
    - -
    +
    + + + + + +
    +   +

    -Ticket data - -

    -

    Generated on Mon Sep 10 17:00:32 2007 for Credentials Cache API by  +Ticket data
    +

    Generated on Tue Oct 2 17:16:06 2007 for Credentials Cache API by  -doxygen 1.5.3
    +doxygen 1.4.6 diff --git a/doc/ccapi/html/structcc__credentials__v5__t.html b/doc/ccapi/html/structcc__credentials__v5__t.html index 0d33734de..ad0996281 100644 --- a/doc/ccapi/html/structcc__credentials__v5__t.html +++ b/doc/ccapi/html/structcc__credentials__v5__t.html @@ -1,15 +1,17 @@ - -Credentials Cache API: cc_credentials_v5_t Struct Reference + +Credentials Cache API : cc_credentials_v5_t Struct Reference - +

    cc_credentials_v5_t Struct Reference
    [cc_credentials_t Overview]

    Detailed Description

    -If a cc_credentials_t variable is used to store Kerberos v5 c redentials, and then credentials.credentials_v5 points to a v5 credentials structure. This structure is similar to a krb5_creds structure.

    Data Fields

    +If a cc_credentials_t variable is used to store Kerberos v5 c redentials, and then credentials.credentials_v5 points to a v5 credentials structure. This structure is similar to a krb5_creds structure. +

    +

    Data Fields

    • char * client
    • char * server @@ -26,203 +28,307 @@ If a cc_credentials_t variable is used to store Kerberos v5 c redentials, and th
    • cc_data ** authdata

    Field Documentation

    - -
    -
    - +

    +

    + + + +
    + - +
    char* client char* client
    - -
    +
    + + + +
    +   +

    -A properly quoted string representation of the client principal. - -

    - -

    -
    - +A properly quoted string representation of the client principal. + +
    +

    + + + + +
    + - +
    char* server char* server
    - -
    +
    + + + +
    +   +

    -A properly quoted string representation of the service principal. - -

    - -

    -
    - +A properly quoted string representation of the service principal. + +
    +

    + + + + +
    + - +
    cc_data keyblock cc_data keyblock
    - -
    +
    + + + +
    +   +

    -Session encryption key info. - -

    - -

    -
    - +Session encryption key info. + +
    +

    + + + + +
    + - +
    cc_time_t authtime cc_time_t authtime
    - -
    +
    + + + +
    +   +

    -The time when the ticket was issued. - -

    - -

    -
    - +The time when the ticket was issued. + +
    +

    + + + + +
    + - +
    cc_time_t starttime cc_time_t starttime
    - -
    +
    + + + +
    +   +

    -The time when the ticket becomes valid. - -

    - -

    -
    - +The time when the ticket becomes valid. + +
    +

    + + + + +
    + - +
    cc_time_t endtime cc_time_t endtime
    - -
    +
    + + + +
    +   +

    -The time when the ticket expires. - -

    - -

    -
    - +The time when the ticket expires. + +
    +

    + + + + +
    + - +
    cc_time_t renew_till cc_time_t renew_till
    - -
    +
    + + + +
    +   +

    -The time when the ticket becomes no longer renewable (if renewable). - -

    - -

    -
    - +The time when the ticket becomes no longer renewable (if renewable). + +
    +

    + + + + +
    + - +
    cc_uint32 is_skey cc_uint32 is_skey
    - -
    +
    + + + +
    +   +

    -1 if the ticket is encrypted in another ticket's key, or 0 otherwise. - -

    - -

    -
    - +1 if the ticket is encrypted in another ticket's key, or 0 otherwise. + +
    +

    + + + + +
    + - +
    cc_uint32 ticket_flags cc_uint32 ticket_flags
    - -
    +
    + + + +
    +   +

    -Ticket flags, as defined by the Kerberos 5 API. - -

    - -

    -
    - +Ticket flags, as defined by the Kerberos 5 API. + +
    +

    + + + + +
    + - +
    cc_data** addresses cc_data** addresses
    - -
    +
    + + + +
    +   +

    -The the list of network addresses of hosts that are allowed to authenticate using this ticket. - -

    - -

    -
    - +The the list of network addresses of hosts that are allowed to authenticate using this ticket. + +
    +

    + + + + +
    + - +
    cc_data ticket cc_data ticket
    - -
    +
    + + + +
    +   +

    -Ticket data. - -

    - -

    -
    - +Ticket data. + +
    +

    + + + + +
    + - +
    cc_data second_ticket cc_data second_ticket
    - -
    +
    + + + +
    +   +

    -Second ticket data. - -

    - -

    -
    - +Second ticket data. + +
    +

    + + + + +
    + - +
    cc_data** authdata cc_data** authdata
    - -
    +
    + + + + + +
    +   +

    -Authorization data. - -

    -

    Generated on Mon Sep 10 17:00:32 2007 for Credentials Cache API by  +Authorization data.
    +

    Generated on Tue Oct 2 17:16:06 2007 for Credentials Cache API by  -doxygen 1.5.3
    +doxygen 1.4.6 diff --git a/doc/ccapi/html/structcc__data.html b/doc/ccapi/html/structcc__data.html index 1c2bd7d60..346f6a41d 100644 --- a/doc/ccapi/html/structcc__data.html +++ b/doc/ccapi/html/structcc__data.html @@ -1,68 +1,94 @@ - -Credentials Cache API: cc_data Struct Reference + +Credentials Cache API : cc_data Struct Reference - +

    cc_data Struct Reference
    [cc_credentials_t Overview]

    Detailed Description

    -The CCAPI data structure. This structure is similar to a krb5_data structure. In a v5 credentials structure, cc_data structures are used to store tagged variable-length binary data. Specifically, for cc_credentials_v5.ticket and cc_credentials_v5.second_ticket, the cc_data.type field must be zero. For the cc_credentials_v5.addresses, cc_credentials_v5.authdata, and cc_credentials_v5.keyblock, the cc_data.type field should be the address type, authorization data type, and encryption type, as defined by the Kerberos v5 protocol definition.

    Data Fields

    +The CCAPI data structure. This structure is similar to a krb5_data structure. In a v5 credentials structure, cc_data structures are used to store tagged variable-length binary data. Specifically, for cc_credentials_v5.ticket and cc_credentials_v5.second_ticket, the cc_data.type field must be zero. For the cc_credentials_v5.addresses, cc_credentials_v5.authdata, and cc_credentials_v5.keyblock, the cc_data.type field should be the address type, authorization data type, and encryption type, as defined by the Kerberos v5 protocol definition. +

    +

    Data Fields

    Field Documentation

    - -
    -
    - +

    +

    + + + +
    + - +
    cc_uint32 type cc_uint32 type
    - -
    +
    + + + +
    +   +

    -The type of the data as defined by the krb5_data structure. - -

    - -

    -
    - +The type of the data as defined by the krb5_data structure. + +
    +

    + + + + +
    + - +
    cc_uint32 length cc_uint32 length
    - -
    +
    + + + +
    +   +

    -The length of data. - -

    - -

    -
    - +The length of data. + +
    +

    + + + + +
    + - +
    void* data void* data
    - -
    +
    + + + + + +
    +   +

    -The data buffer. - -

    -

    Generated on Mon Sep 10 17:00:32 2007 for Credentials Cache API by  +The data buffer.
    +

    Generated on Tue Oct 2 17:16:06 2007 for Credentials Cache API by  -doxygen 1.5.3
    +doxygen 1.4.6 diff --git a/doc/ccapi/html/structcc__string__d.html b/doc/ccapi/html/structcc__string__d.html index d9f958353..b38286b3e 100644 --- a/doc/ccapi/html/structcc__string__d.html +++ b/doc/ccapi/html/structcc__string__d.html @@ -1,10 +1,10 @@ - -Credentials Cache API: cc_string_d Struct Reference + +Credentials Cache API : cc_string_d Struct Reference - +

    cc_string_d Struct Reference
    [cc_string_t Overview] @@ -14,38 +14,54 @@
  • const cc_string_f * functions

    Field Documentation

    - -
    -
    - +

    +

    + + + +
    + - +
    const char* data const char* data
    - -
    +
    + + + + + +
    +   +

    - - -

    - -

    -
    - + + +
    +

    + + + + +
    + - +
    const cc_string_f* functions const cc_string_f* functions
    - -
    +
    + + + + + +
    +   +

    - - -

    -

    Generated on Mon Sep 10 17:00:32 2007 for Credentials Cache API by  +
    +

    Generated on Tue Oct 2 17:16:06 2007 for Credentials Cache API by  -doxygen 1.5.3
    +doxygen 1.4.6 diff --git a/doc/ccapi/html/structcc__string__f.html b/doc/ccapi/html/structcc__string__f.html index 40fad79df..d5f738f49 100644 --- a/doc/ccapi/html/structcc__string__f.html +++ b/doc/ccapi/html/structcc__string__f.html @@ -1,26 +1,36 @@ - -Credentials Cache API: cc_string_f Struct Reference + +Credentials Cache API : cc_string_f Struct Reference - +

    cc_string_f Struct Reference

    Detailed Description

    -Function pointer table for cc_string_t. For more information see cc_string_t Overview.

    Data Fields

    +Function pointer table for cc_string_t. For more information see cc_string_t Overview. +

    +

    Data Fields

    Field Documentation

    - -
    -
    - +

    +

    + + + +
    + - +
    cc_int32(* release)(cc_string_t io_string) cc_int32(* release)(cc_string_t io_string)
    - -
    +
    + + + +
    +   +

    cc_string_release(): Release memory associated with a cc_string_t object. @@ -30,12 +40,12 @@ Function pointer table for cc_string_t. For more information see

    		io_string the string object to release.
    -
    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    - -
    -

    -

    Generated on Mon Sep 10 17:00:32 2007 for Credentials Cache API by  +
    Returns:
    On success, ccNoError. On failure, an error code representing the failure.
    +
    +
    Generated on Tue Oct 2 17:16:06 2007 for Credentials Cache API by  -doxygen 1.5.3
    +doxygen 1.4.6 diff --git a/src/include/CredentialsCache.h b/src/include/CredentialsCache.h index 84783ae51..3ecc0c2ee 100644 --- a/src/include/CredentialsCache.h +++ b/src/include/CredentialsCache.h @@ -730,7 +730,8 @@ struct cc_context_f { * \param in_context the context object for the cache collection. * \param in_name the name of the ccache to open. * \param out_ccache on exit, a ccache object for the ccache - * \return On success, #ccNoError. On failure, an error code representing the failure. + * \return On success, #ccNoError. If no ccache named \a in_name exists, + * #ccErrCCacheNotFound. On failure, an error code representing the failure. * \brief \b cc_context_open_ccache(): Open a ccache. * * Opens an already existing ccache identified by its name. It returns a reference @@ -747,7 +748,8 @@ struct cc_context_f { /*! * \param in_context the context object for the cache collection. * \param out_ccache on exit, a ccache object for the default ccache - * \return On success, #ccNoError. On failure, an error code representing the failure. + * \return On success, #ccNoError. If no default ccache exists, + * #ccErrCCacheNotFound. On failure, an error code representing the failure. * \brief \b cc_context_open_default_ccache(): Open the default ccache. * * Opens the default ccache. It returns a reference to the ccache in *ccache. @@ -878,7 +880,8 @@ struct cc_context_f { * \return On success, #ccNoError. On failure, an error code representing the failure. * \brief \b cc_context_lock(): Lock the cache collection. * - * Attempts to acquire a lock for the ccache collection. Allowed values for lock_type are: + * Attempts to acquire an advisory lock for the ccache collection. Allowed values + * for lock_type are: * * \li cc_lock_read: a read lock. * \li cc_lock_write: a write lock @@ -906,8 +909,8 @@ struct cc_context_f { * \note All locks are advisory. For example, callers which do not call * cc_context_lock() and cc_context_unlock() will not be prevented from writing * to the cache collection when you have a read lock. This is because the CCAPI - * locking was added later and thus adding mandatory locks would have changed the - * user experience and performance of existing applications. + * locking was added after the first release and thus adding mandatory locks would + * have changed the user experience and performance of existing applications. */ cc_int32 (*lock) (cc_context_t in_context, cc_uint32 in_lock_type, @@ -1148,7 +1151,7 @@ struct cc_ccache_f { * \return On success, #ccNoError. On failure, an error code representing the failure. * \brief \b cc_ccache_lock(): Lock a ccache. * - * Attempts to acquire a lock for a ccache. Allowed values for lock_type are: + * Attempts to acquire an advisory lock for a ccache. Allowed values for lock_type are: * * \li cc_lock_read: a read lock. * \li cc_lock_write: a write lock @@ -1170,8 +1173,8 @@ struct cc_ccache_f { * \note All locks are advisory. For example, callers which do not call * cc_ccache_lock() and cc_ccache_unlock() will not be prevented from writing * to the ccache when you have a read lock. This is because the CCAPI - * locking was added later and thus adding mandatory locks would have changed the - * user experience and performance of existing applications. + * locking was added after the first release and thus adding mandatory locks would + * have changed the user experience and performance of existing applications. */ cc_int32 (*lock) (cc_ccache_t io_ccache, cc_uint32 in_lock_type, @@ -1201,7 +1204,8 @@ struct cc_ccache_f { /*! * \param in_ccache a cache object. * \param out_change_time on exit, the last time the ccache changed. - * \return On success, #ccNoError. On failure, an error code representing the failure. + * \return On success, #ccNoError. If the ccache was never the default ccache, + * #ccErrNeverDefault. Otherwise, an error code representing the failure. * \brief \b cc_ccache_get_change_time(): Get the last time a ccache changed. * * This function returns the time of the most recent change made to a ccache. @@ -1242,7 +1246,8 @@ struct cc_ccache_f { * \param in_credentials_version the credentials version to get the time offset for. * \param out_time_offset on exit, the KDC time offset for \a in_ccache for credentials version * \a in_credentials_version. - * \return On success, #ccNoError. On failure, an error code representing the failure. + * \return On success, #ccNoError if a time offset was obtained or #ccErrTimeOffsetNotSet + * if a time offset has not been set. On failure, an error code representing the failure. * \brief \b cc_ccache_get_kdc_time_offset(): Get the KDC time offset for credentials in a ccache. * \sa set_kdc_time_offset, clear_kdc_time_offset * @@ -1371,7 +1376,9 @@ struct cc_ccache_iterator_f { /*! * \param in_ccache_iterator a ccache iterator object. * \param out_ccache on exit, the next ccache in the cache collection. - * \return On success, #ccNoError. On failure, an error code representing the failure. + * \return On success, #ccNoError if the next ccache in the cache collection was + * obtained or #ccIteratorEnd if there are no more ccaches. + * On failure, an error code representing the failure. * \brief \b cc_ccache_iterator_next(): Get the next ccache in the cache collection. */ cc_int32 (*next) (cc_ccache_iterator_t in_ccache_iterator, @@ -1402,7 +1409,9 @@ struct cc_credentials_iterator_f { /*! * \param in_credentials_iterator a credentials iterator object. * \param out_credentials on exit, the next credentials in the ccache. - * \return On success, #ccNoError. On failure, an error code representing the failure. + * \return On success, #ccNoError if the next credential in the ccache was obtained + * or #ccIteratorEnd if there are no more credentials. + * On failure, an error code representing the failure. * \brief \b cc_credentials_iterator_next(): Get the next credentials in the ccache. */ cc_int32 (*next) (cc_credentials_iterator_t in_credentials_iterator, @@ -1429,6 +1438,7 @@ struct cc_credentials_iterator_f { * \param out_vendor if non-NULL, on exit contains a pointer to a read-only C string which * contains a string describing the vendor which implemented the credentials cache API. * \return On success, #ccNoError. On failure, an error code representing the failure. + * May return CCAPI v2 error CC_BAD_API_VERSION if #ccapi_version_2 is passed in. * \brief Initialize a new cc_context. */ CCACHE_API cc_int32 cc_initialize (cc_context_t *out_context, -- 2.26.2