/*! \defgroup kcdb NetIDMgr Credentials Database */
/*@{*/
-/*! \brief Maximum length in characters of short description
+/*! \brief Maximum length in characters of short description
The length includes the terminating \a NULL character.
*/
#define KCDB_MAXCCH_SHORT_DESC 256
-/*! \brief Maximum length in bytes of short description
+/*! \brief Maximum length in bytes of short description
The length includes the terminating \a NULL character.
*/
#define KCDB_MAXCB_SHORT_DESC (sizeof(wchar_t) * KCDB_MAXCCH_SHORT_DESC)
-/*! \brief Maximum length in characters of long description
+/*! \brief Maximum length in characters of long description
The length includes the terminating \a NULL character.
*/
#define KCDB_MAXCCH_LONG_DESC 8192
-/*! \brief Maximum length in characters of long description
+/*! \brief Maximum length in characters of long description
The length includes the terminating \a NULL character.
*/
#define KCDB_MAXCB_LONG_DESC (sizeof(wchar_t) * KCDB_MAXCCH_LONG_DESC)
-/*! \brief Maximum length in characters of name
+/*! \brief Maximum length in characters of name
The length includes the terminating \a NULL character.
*/
#define KCDB_MAXCCH_NAME 256
-/*! \brief Maximum length in bytes of short description
+/*! \brief Maximum length in bytes of short description
The length includes the terminating \a NULL character.
*/
\name Flags for identities */
/*@{*/
-/*! \brief Create the identity if it doesn't already exist.
+/*! \brief Create the identity if it doesn't already exist.
\note Only to be used with kcdb_identity_create() */
#define KCDB_IDENT_FLAG_CREATE 0x10000000L
*/
#define KCDB_IDENT_FLAG_ATTRIBS 0x08000000L
-/*! \brief This is the default identity.
+/*! \brief This is the default identity.
At most one identity will have this flag set at any given time.
To set or reset the flag, use kcdb_identity_set_default() */
\see ::KMSG_IDENT_VALIDATE_NAME
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_identpro_validate_name(const wchar_t * name);
/*! \brief Validate an identity
\see ::KMSG_IDENT_VALIDATE_IDENTITY
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_identpro_validate_identity(khm_handle identity);
-/*! \brief Canonicalize the name
+/*! \brief Canonicalize the name
\see ::KMSG_IDENT_CANON_NAME
*/
-KHMEXP khm_int32 KHMAPI
-kcdb_identpro_canon_name(const wchar_t * name_in,
- wchar_t * name_out,
+KHMEXP khm_int32 KHMAPI
+kcdb_identpro_canon_name(const wchar_t * name_in,
+ wchar_t * name_out,
khm_size * cb_name_out);
-/*! \brief Compare two identity names
+/*! \brief Compare two identity names
\see ::KMSG_IDENT_COMPARE_NAME
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_identpro_compare_name(const wchar_t * name1,
const wchar_t * name2);
-/*! \brief Set the specified identity as the default
+/*! \brief Set the specified identity as the default
\see ::KMSG_IDENT_SET_DEFAULT
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_identpro_set_default(khm_handle identity);
-/*! \brief Set the specified identity as searchable
+/*! \brief Set the specified identity as searchable
\see ::KMSG_IDENT_SET_SEARCHABLE
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_identpro_set_searchable(khm_handle identity,
khm_boolean searchable);
-/*! \brief Update the specified identity
+/*! \brief Update the specified identity
\see ::KMSG_IDENT_UPDATE
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_identpro_update(khm_handle identity);
/*! \brief Obtain the UI callback
\see ::KMSG_IDENT_GET_UI_CALLBACK
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_identpro_get_ui_cb(void * rock);
-/*! \brief Notify an identity provider of the creation of a new identity
+/*! \brief Notify an identity provider of the creation of a new identity
\see ::KMSG_IDENT_NOTIFY_CREATE
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_identpro_notify_create(khm_handle identity);
/*@}*/
\return TRUE or FALSE to the question, is this valid?
*/
-KHMEXP khm_boolean KHMAPI
+KHMEXP khm_boolean KHMAPI
kcdb_identity_is_valid_name(const wchar_t * name);
/*! \brief Create or open an identity.
kcdb_identity_release() to release the identity once it is no
longer needed.
*/
-KHMEXP khm_int32 KHMAPI
-kcdb_identity_create(const wchar_t *name,
- khm_int32 flags,
+KHMEXP khm_int32 KHMAPI
+kcdb_identity_create(const wchar_t *name,
+ khm_int32 flags,
khm_handle * result);
/*! \brief Mark an identity for deletion.
identity. Once all references to the identity are released, it
will be removed from memory. All associated credentials will also
be removed. */
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_identity_delete(khm_handle id);
/*! \brief Set or unset the specified flags in the specified identity.
check the flags in the identity using kcdb_identity_get_flags() to
check which flags have been set and which have failed.
*/
-KHMEXP khm_int32 KHMAPI
-kcdb_identity_set_flags(khm_handle id,
+KHMEXP khm_int32 KHMAPI
+kcdb_identity_set_flags(khm_handle id,
khm_int32 flags,
khm_int32 mask);
The returned flags may include internal flags.
*/
-KHMEXP khm_int32 KHMAPI
-kcdb_identity_get_flags(khm_handle id,
+KHMEXP khm_int32 KHMAPI
+kcdb_identity_get_flags(khm_handle id,
khm_int32 * flags);
-/*! \brief Return the name of the identity
+/*! \brief Return the name of the identity
\param[out] buffer Buffer to copy the identity name into. The
maximum size of an identity name is \a KCDB_IDENT_MAXCB_NAME.
is returned in \a pcbsize.
\param[in,out] pcbsize Size of buffer in bytes. */
-KHMEXP khm_int32 KHMAPI
-kcdb_identity_get_name(khm_handle id,
- wchar_t * buffer,
+KHMEXP khm_int32 KHMAPI
+kcdb_identity_get_name(khm_handle id,
+ wchar_t * buffer,
khm_size * pcbsize);
/*! \brief Set the specified identity as the default.
\see kcdb_identity_set_flags()
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_identity_set_default(khm_handle id);
/*! \brief Mark the specified identity as the default.
This API is reserved for use by identity providers as a means of
specifying which identity is default. The difference between
kcdb_identity_set_default() and kcdb_identity_set_default_int() is
- in semantics.
+ in semantics.
- kcdb_identity_set_default() is used to request the KCDB to
designate the specified identity as the default. When
If there is no default identity, then the handle pointed to by \a
pvid is set to \a NULL and the function returns
KHM_ERROR_NOT_FOUND. */
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_identity_get_default(khm_handle * pvid);
-/*! \brief Get the configuration space for the identity.
+/*! \brief Get the configuration space for the identity.
If the configuration space for the identity does not exist and the
flags parameter does not specify ::KHM_FLAG_CREATE, then the
successful, this receives a handle to the configuration space.
Use khc_close_space() to close the handle.
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_identity_get_config(khm_handle id,
khm_int32 flags,
khm_handle * result);
held. \note Once the handle is released, it can not be
revalidated by calling kcdb_identity_hold(). Doing so would lead
to unpredictable consequences. */
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_identity_hold(khm_handle id);
/*! \brief Release a reference to an identity.
\see kcdb_identity_hold() */
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_identity_release(khm_handle id);
/*! \brief Set the identity provider subscription
\param[in] sub New identity provider subscription
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_identity_set_provider(khm_handle sub);
/*! \brief Set the primary credentials type
provider. As such, this function should only be called by an
identity provider.
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_identity_set_type(khm_int32 cred_type);
/*! \brief Retrieve the identity provider subscription
identity provider. If \a sub was not NULL, the handle it
points to has been set to NULL.
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_identity_get_provider(khm_handle * sub);
/*! \brief Retrieve the identity provider credentials type
This is the credentials type that the identity provider has
designated as the primary credentials type.
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_identity_get_type(khm_int32 * ptype);
/*! \brief Returns TRUE if the two identities are equal
individual data type handlers may copy in less than this many
bytes in to the credential.
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_identity_set_attr(khm_handle identity,
khm_int32 attr_id,
void * buffer,
individual data type handlers may copy in less than this many
bytes in to the credential.
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_identity_set_attrib(khm_handle identity,
wchar_t * attr_name,
void * buffer,
exists in this identity then the function will return
KHM_ERROR_SUCCESS, otherwise it returns KHM_ERROR_NOT_FOUND.
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_identity_get_attr(khm_handle identity,
khm_int32 attr_id,
khm_int32 * attr_type,
exists in this identity then the function will return
KHM_ERROR_SUCCESS, otherwise it returns KHM_ERROR_NOT_FOUND.
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_identity_get_attrib(khm_handle identity,
wchar_t * attr_name,
khm_int32 * attr_type,
\retval KHM_ERROR_TOO_LONG Either \a buffer was NULL or the
supplied buffer was insufficient
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_identity_get_attr_string(khm_handle identity,
khm_int32 attr_id,
wchar_t * buffer,
\see kcdb_identity_get_attr_string()
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_identity_get_attrib_string(khm_handle identity,
wchar_t * attr_name,
wchar_t * buffer,
guaranteed to work since the list of identities may change
between the two calls.
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_identity_enum(khm_int32 and_flags,
khm_int32 eq_flags,
wchar_t * name_buf,
\see kcdb_identity_refresh()
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_identity_refresh(khm_handle vid);
/*! \brief Refresh all identities
\see kcdb_identityt_refresh()
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_identity_refresh_all(void);
/* KSMG_KCDB_IDENT notifications are structured as follows:
\see kcdb_credset_apply()
*/
-typedef khm_int32
-(KHMAPI *kcdb_cred_apply_func)(khm_handle cred,
+typedef khm_int32
+(KHMAPI *kcdb_cred_apply_func)(khm_handle cred,
void * rock);
/*! \brief Credentials filter function.
\see kcdb_credset_collect_filtered()
\see kcdb_credset_extract_filtered()
*/
-typedef khm_int32
-(KHMAPI *kcdb_cred_filter_func)(khm_handle cred,
- khm_int32 flags,
+typedef khm_int32
+(KHMAPI *kcdb_cred_filter_func)(khm_handle cred,
+ khm_int32 flags,
void * rock);
/*! \brief Credentials compare function.
\see kcdb_credset_sort()
\see ::kcdb_credtype
*/
-typedef khm_int32
-(KHMAPI *kcdb_cred_comp_func)(khm_handle cred1,
- khm_handle cred2,
+typedef khm_int32
+(KHMAPI *kcdb_cred_comp_func)(khm_handle cred1,
+ khm_handle cred2,
void * rock);
/*! \defgroup kcdb_credset Credential sets */
\see kcdb_credset_delete()
\see kcdb_credset_collect()
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_credset_create(khm_handle * result);
/** \brief Delete a credential set
\see kcdb_credset_create()
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_credset_delete(khm_handle credset);
/** \brief Collect credentials from a credential set to another credential set.
\note The destination credential set cannot be sealed.
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_credset_collect(khm_handle cs_dest,
khm_handle cs_src,
- khm_handle identity,
+ khm_handle identity,
khm_int32 type,
khm_int32 * delta);
\see kcdb_credset_collect() */
#define KCDB_DELTA_ADD 1
-/*! \brief Credentials were deleted
+/*! \brief Credentials were deleted
\see kcdb_credset_collect() */
#define KCDB_DELTA_DEL 2
#define KCDB_CREDCOLL_FILTER_ROOT 1
/*! \brief Indicates that the credential to be filtered is from the source
- credential set
-
+ credential set
+
\see kcdb_credset_collect_filtered() */
#define KCDB_CREDCOLL_FILTER_SRC 2
/*! \brief Indicates that the credential to be filtered is from the destination
- credential set
-
+ credential set
+
\see kcdb_credset_collect_filtered() */
#define KCDB_CREDCOLL_FILTER_DEST 4
\see kcdb_credset_collect()
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_credset_collect_filtered(khm_handle cs_dest,
khm_handle cs_src,
kcdb_cred_filter_func filter,
\note The credential set cannot be sealed
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_credset_flush(khm_handle credset);
/*! \brief Extract credentials from one credential set to another
\note The destination credential set cannot be sealed.
*/
-KHMEXP khm_int32 KHMAPI
-kcdb_credset_extract(khm_handle destcredset,
- khm_handle sourcecredset,
- khm_handle identity,
+KHMEXP khm_int32 KHMAPI
+kcdb_credset_extract(khm_handle destcredset,
+ khm_handle sourcecredset,
+ khm_handle identity,
khm_int32 type);
/*! \brief Extract credentials from one credential set to another using a filter.
\note The destination credential set cannot be sealed.
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_credset_extract_filtered(khm_handle destcredset,
khm_handle sourcecredset,
kcdb_cred_filter_func filter,
\param[in] idx The index of the credential to retrieve. This is a
zero based index which goes from 0 ... (size of credset - 1).
- \param[out] cred The held reference to a credential. Call
+ \param[out] cred The held reference to a credential. Call
kcdb_cred_release() to release the credential.
\retval KHM_ERROR_SUCCESS Success. \a cred has a held reference to the credential.
\see kcdb_cred_release()
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_credset_get_cred(khm_handle credset,
khm_int32 idx,
khm_handle * cred);
matches are possible if the order of the credentials in the
set was changed.
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_credset_find_filtered(khm_handle credset,
khm_int32 idx_start,
kcdb_cred_filter_func f,
specified credential. For a credential to be a match, it must
have the same identity, credential type and name.
- \param[in] credset Credential set to search
+ \param[in] credset Credential set to search
\param[in] cred_src Credetial to search on
\retval KHM_ERROR_NOT_FOUND A matching credential was not found.
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_credset_find_cred(khm_handle credset,
khm_handle cred_src,
khm_handle *cred_dest);
-
+
/*! \brief Delete a credential from a credential set.
\see kcdb_credset_del_cred_ref()
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_credset_del_cred(khm_handle credset,
khm_int32 idx);
\see kcdb_credset_del_cred()
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_credset_del_cred_ref(khm_handle credset,
khm_handle cred);
\note The credential set cannot be sealed.
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_credset_add_cred(khm_handle credset,
khm_handle cred,
khm_int32 idx);
\see kcdb_credset_purge()
\see kcdb_credset_get_cred()
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_credset_get_size(khm_handle credset,
khm_size * size);
\see kcdb_credset_get_size()
\see kcdb_credset_get_cred()
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_credset_purge(khm_handle credset);
/*! \brief Applies a function to all the credentials in a credentials set
\retval KHM_ERROR_INVALID_PARAM One or more parameters were invalid.
*/
-KHMEXP khm_int32 KHMAPI
-kcdb_credset_apply(khm_handle credset,
- kcdb_cred_apply_func f,
+KHMEXP khm_int32 KHMAPI
+kcdb_credset_apply(khm_handle credset,
+ kcdb_cred_apply_func f,
void * rock);
/*! \brief Sort the contents of a credential set.
\see kcdb_cred_comp_generic()
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_credset_sort(khm_handle credset,
kcdb_cred_comp_func comp,
void * rock);
\see kcdb_credset_unseal()
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_credset_seal(khm_handle credset);
/*! \brief Unseal a credential set
with either. */
} kcdb_cred_comp_field;
-/*! \brief Defines the sort order for a field in ::kcdb_cred_comp_field
+/*! \brief Defines the sort order for a field in ::kcdb_cred_comp_field
Sorts lexicographically ascending by string representation of field.
*/
*/
#define KCDB_CRED_COMP_DECREASING 1
-/*! \brief Defines the sort order for a field in ::kcdb_cred_comp_field
+/*! \brief Defines the sort order for a field in ::kcdb_cred_comp_field
Any credentials which have the ::KCDB_CRED_FLAG_INITIAL will be
grouped above any that don't.
\param[in] rock a pointer to a ::kcdb_cred_comp_order object
*/
-KHMEXP khm_int32 KHMAPI
-kcdb_cred_comp_generic(khm_handle cred1,
- khm_handle cred2,
+KHMEXP khm_int32 KHMAPI
+kcdb_cred_comp_generic(khm_handle cred1,
+ khm_handle cred2,
void * rock);
/*@}*/
*/
#define KCDB_CRED_FLAGMASK_EXT (KCDB_CRED_FLAG_INITIAL | KCDB_CRED_FLAG_EXPIRED | KCDB_CRED_FLAG_INVALID | KCDB_CRED_FLAG_RENEWABLE)
-/*! \brief Bitmask indicating dditive flags
+/*! \brief Bitmask indicating dditive flags
Additive flags are special flags which are added to exiting
credentials based on new credentials when doing a collect
/*! \brief Create a new credential
\param[in] name Name of credential. \a name cannot be NULL and cannot
- exceed \a KCDB_CRED_MAXCCH_NAME unicode characters including the
+ exceed \a KCDB_CRED_MAXCCH_NAME unicode characters including the
\a NULL terminator.
\param[in] identity A reference to an identity.
\param[in] cred_type A credentials type identifier for the credential.
\param[out] result Gets a held reference to the newly created credential.
- Call kcdb_cred_release() or kcdb_cred_delete() to release the
+ Call kcdb_cred_release() or kcdb_cred_delete() to release the
reference.
\see kcdb_cred_release()
*/
-KHMEXP khm_int32 KHMAPI
-kcdb_cred_create(wchar_t * name,
+KHMEXP khm_int32 KHMAPI
+kcdb_cred_create(wchar_t * name,
khm_handle identity,
khm_int32 cred_type,
khm_handle * result);
\param[out] newcred A held reference to the new credential if the call
succeeds.
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_cred_dup(khm_handle cred,
khm_handle * newcred);
\retval KHM_ERROR_SUCCESS vdest was successfully updated
\retval KHM_ERROR_EQUIVALENT all fields in vsrc were present and equivalent in vdest
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_cred_update(khm_handle vdest,
khm_handle vsrc);
individual data type handlers may copy in less than this many
bytes in to the credential.
*/
-KHMEXP khm_int32 KHMAPI
-kcdb_cred_set_attrib(khm_handle cred,
- wchar_t * name,
- void * buffer,
+KHMEXP khm_int32 KHMAPI
+kcdb_cred_set_attrib(khm_handle cred,
+ wchar_t * name,
+ void * buffer,
khm_size cbbuf);
/*! \brief Set an attribute in a credential by attribute id
individual data type handlers may copy in less than this many
bytes in to the credential.
*/
-KHMEXP khm_int32 KHMAPI
-kcdb_cred_set_attr(khm_handle cred,
- khm_int32 attr_id,
- void * buffer,
+KHMEXP khm_int32 KHMAPI
+kcdb_cred_set_attr(khm_handle cred,
+ khm_int32 attr_id,
+ void * buffer,
khm_size cbbuf);
/*! \brief Get an attribute from a credential by name.
exists in this credential then the function will return
KHM_ERROR_SUCCESS, otherwise it returns KHM_ERROR_NOT_FOUND.
*/
-KHMEXP khm_int32 KHMAPI
-kcdb_cred_get_attrib(khm_handle cred,
- wchar_t * name,
+KHMEXP khm_int32 KHMAPI
+kcdb_cred_get_attrib(khm_handle cred,
+ wchar_t * name,
khm_int32 * attr_type,
- void * buffer,
+ void * buffer,
khm_size * cbbuf);
/*! \brief Get an attribute from a credential by attribute id.
exists in this credential then the function will return
KHM_ERROR_SUCCESS, otherwise it returns KHM_ERROR_NOT_FOUND.
*/
-KHMEXP khm_int32 KHMAPI
-kcdb_cred_get_attr(khm_handle cred,
+KHMEXP khm_int32 KHMAPI
+kcdb_cred_get_attr(khm_handle cred,
khm_int32 attr_id,
khm_int32 * attr_type,
- void * buffer,
+ void * buffer,
khm_size * cbbuf);
/*! \brief Get the name of a credential.
If \a buffer is not sufficient, returns KHM_ERROR_TOO_LONG and
sets this to the required buffer size.
*/
-KHMEXP khm_int32 KHMAPI
-kcdb_cred_get_name(khm_handle cred,
- wchar_t * buffer,
+KHMEXP khm_int32 KHMAPI
+kcdb_cred_get_name(khm_handle cred,
+ wchar_t * buffer,
khm_size * cbbuf);
/*! \brief Get the string representation of a credential attribute.
\retval KHM_ERROR_TOO_LONG Either \a buffer was NULL or the
supplied buffer was insufficient
*/
-KHMEXP khm_int32 KHMAPI
-kcdb_cred_get_attr_string(khm_handle vcred,
+KHMEXP khm_int32 KHMAPI
+kcdb_cred_get_attr_string(khm_handle vcred,
khm_int32 attr_id,
- wchar_t * buffer,
+ wchar_t * buffer,
khm_size * pcbbuf,
khm_int32 flags);
\see kcdb_cred_get_attr_string()
*/
-KHMEXP khm_int32 KHMAPI
-kcdb_cred_get_attrib_string(khm_handle cred,
- wchar_t * name,
- wchar_t * buffer,
+KHMEXP khm_int32 KHMAPI
+kcdb_cred_get_attrib_string(khm_handle cred,
+ wchar_t * name,
+ wchar_t * buffer,
khm_size * cbbuf,
khm_int32 flags) ;
\see kcdb_identity_relase()
*/
-KHMEXP khm_int32 KHMAPI
-kcdb_cred_get_identity(khm_handle cred,
+KHMEXP khm_int32 KHMAPI
+kcdb_cred_get_identity(khm_handle cred,
khm_handle * identity);
/*! \brief Set the identity of a credential
credential that is not placed in a credential set or placed in a
credential set that is only used by a single entity.
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_cred_set_identity(khm_handle vcred,
khm_handle id);
\param[out] pserial Receives the serial number. Cannot be NULL.
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_cred_get_serial(khm_handle cred,
khm_ui_8 * pserial);
\param[out] type Receives the type. Cannot be NULL.
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_cred_get_type(khm_handle cred,
khm_int32 * type);
credential for the operation to succeed. This means the
::KCDB_CRED_FLAG_DELETED will never be retured by this function.
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_cred_get_flags(khm_handle cred,
khm_int32 * flags);
\see ::KCDB_CRED_FLAGMASK_ALL
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_cred_set_flags(khm_handle cred,
khm_int32 flags,
khm_int32 mask);
\see kcdb_cred_release()
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_cred_hold(khm_handle cred);
/*! \brief Release a held reference to a credential.
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_cred_release(khm_handle cred);
/*! \brief Delete a credential.
is bound to a credential set or the root credential store, it will
be removed from the respective container.
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_cred_delete(khm_handle cred);
/*! \brief Compare an attribute of two credentials by name.
attribute, the return value is 0, which signifies that no ordering
can be determined.
*/
-KHMEXP khm_int32 KHMAPI
-kcdb_creds_comp_attrib(khm_handle cred1,
- khm_handle cred2,
+KHMEXP khm_int32 KHMAPI
+kcdb_creds_comp_attrib(khm_handle cred1,
+ khm_handle cred2,
wchar_t * name);
/*! \brief Compare an attribute of two credentials by attribute id.
attribute, the return value is 0, which signifies that no ordering
can be determined.
*/
-KHMEXP khm_int32 KHMAPI
-kcdb_creds_comp_attr(khm_handle cred1,
- khm_handle cred2,
+KHMEXP khm_int32 KHMAPI
+kcdb_creds_comp_attr(khm_handle cred1,
+ khm_handle cred2,
khm_int32 attr_id);
/*! \brief Compare two credentials for equivalence
- Both have the same name.
- Both have the same type.
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_creds_is_equal(khm_handle cred1,
khm_handle cred2);
\see ::kcdb_type
*/
-typedef khm_int32
+typedef khm_int32
(KHMAPI *kcdb_dtf_toString)(const void * data,
khm_size cb_data,
wchar_t * s_buf,
\see ::kcdb_type
*/
-typedef khm_boolean
+typedef khm_boolean
(KHMAPI *kcdb_dtf_isValid)(const void * data,
khm_size cb_data);
\see ::kcdb_type
*/
-typedef khm_int32
+typedef khm_int32
(KHMAPI *kcdb_dtf_comp)(const void * data_l,
khm_size cb_data_l,
const void * data_r,
\see ::kcdb_type
*/
-typedef khm_int32
+typedef khm_int32
(KHMAPI *kcdb_dtf_dup)(const void * data_src,
khm_size cb_data_src,
void * data_dst,
/*! \name Flags for kcdb_type::toString
@{*/
-/*! \brief Specify that the short form of the string representation should be returned.
+/*! \brief Specify that the short form of the string representation should be returned.
Flags for #kcdb_type::toString. The flag specifies how long the
string representation should be. The specific length of a short
Usually, KCDB_TS_SHORT is specified when the amount of space that
is available to display the string is very restricted. It may be
the case that the string is truncated to facilitate displaying in
- a constrainted space.
+ a constrainted space.
*/
#define KCDB_TS_SHORT 1
-/*! \brief Specify that the long form of the string representation should be returned
+/*! \brief Specify that the long form of the string representation should be returned
Flags for #kcdb_type::toString. The flag specifies how long the
string representation should be. The specific length of a short
\note If this flag is used in conjunction with \a
KCDB_TYPE_FLAG_CB_MAX then, \a cb_min must be less than or equal
- to \a cb_max.
+ to \a cb_max.
*/
#define KCDB_TYPE_FLAG_CB_MIN 128
/*@}*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_type_get_id(wchar_t *name, khm_int32 * id);
/*! \brief Return the type descriptor for a given type id
\see kcdb_type_release_info()
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_type_get_info(khm_int32 id, kcdb_type ** info);
/*! \brief Release a reference to a type info structure
Releases the reference to the type information obtained with a
prior call to kcdb_type_get_info().
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_type_release_info(kcdb_type * info);
/*! \brief Get the name of a type
Retrieves the non-localized name of the specified type.
*/
-KHMEXP khm_int32 KHMAPI
-kcdb_type_get_name(khm_int32 id,
- wchar_t * buffer,
+KHMEXP khm_int32 KHMAPI
+kcdb_type_get_name(khm_int32 id,
+ wchar_t * buffer,
khm_size * cbbuf);
/*! \brief Register a credentials attribute type
\param[in] type The type descriptor
\param[out] new_id Receives the identifier for the credential attribute type.
*/
-KHMEXP khm_int32 KHMAPI
-kcdb_type_register(kcdb_type * type,
+KHMEXP khm_int32 KHMAPI
+kcdb_type_register(kcdb_type * type,
khm_int32 * new_id);
/*! \brief Unregister a credential attribute type
Removes the registration for the specified credentials attribute
type.
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_type_unregister(khm_int32 id);
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_type_get_next_free(khm_int32 * id);
/*! \name Conversion functions
@{*/
/*! \brief Convert a time_t value to FILETIME
*/
-KHMEXP void KHMAPI
+KHMEXP void KHMAPI
TimetToFileTime( time_t t, LPFILETIME pft );
/*! \brief Convert a time_t interval to a FILETIME interval
*/
-KHMEXP void KHMAPI
+KHMEXP void KHMAPI
TimetToFileTimeInterval(time_t t, LPFILETIME pft);
/*! \brief Convert a FILETIME interval to seconds
*/
-KHMEXP long KHMAPI
+KHMEXP long KHMAPI
FtIntervalToSeconds(LPFILETIME pft);
/*! \brief Convert a FILETIME interval to milliseconds
*/
-KHMEXP long KHMAPI
+KHMEXP long KHMAPI
FtIntervalToMilliseconds(LPFILETIME pft);
/*! \brief Compare two FILETIME values
The return value is similar to the return value of strcmp(), based
on the comparison of the two FILETIME values.
*/
-KHMEXP long KHMAPI
+KHMEXP long KHMAPI
FtCompare(LPFILETIME pft1, LPFILETIME pft2);
/*! \brief Convert a FILETIME to a 64 bit int
/*! \brief Convert a FILETIME inverval to a string
*/
-KHMEXP khm_int32 KHMAPI
-FtIntervalToString(LPFILETIME data,
- wchar_t * buffer,
+KHMEXP khm_int32 KHMAPI
+FtIntervalToString(LPFILETIME data,
+ wchar_t * buffer,
khm_size * cb_buf);
/*! \brief Parse a string representing an interval into a FILETIME interval
\retval KHM_ERROR_SUCCESS The string was successfully parsed and
the result was placed in \a pft.
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
IntervalStringToFt(FILETIME * pft, wchar_t * str);
/*! \brief Return number of milliseconds till next representation change
Returns 0 if the representation is not expected to change.
*/
-KHMEXP long KHMAPI
+KHMEXP long KHMAPI
FtIntervalMsToRepChange(LPFILETIME pft);
/*! \brief Convert a safe ANSI string to a Unicode string
\return the number of characters converted. This is always either
the length of the string \a astr or 0.
*/
-KHMEXP int KHMAPI
+KHMEXP int KHMAPI
AnsiStrToUnicode( wchar_t * wstr, size_t cbwstr, const char * astr);
/*! \brief Convert a Unicode string to ANSI
\return the number of characters converted. This is always either
the length of the string \a src or 0.
*/
-KHMEXP int KHMAPI
+KHMEXP int KHMAPI
UnicodeStrToAnsi( char * dest, size_t cbdest, const wchar_t * src);
/*@}*/
-/*! \name Standard type identifiers and names
+/*! \name Standard type identifiers and names
@{*/
/*! Maximum identifier number */
buffer is \a NULL, then the required buffer size should be placed
in \a cbsize.
*/
-typedef khm_int32
-(KHMAPI *kcdb_attrib_compute_cb)(khm_handle cred,
+typedef khm_int32
+(KHMAPI *kcdb_attrib_compute_cb)(khm_handle cred,
khm_int32 id,
void * buffer,
khm_size * cbsize);
} kcdb_attrib;
/*! \brief Retrieve the ID of a named attribute */
-KHMEXP khm_int32 KHMAPI
-kcdb_attrib_get_id(wchar_t *name,
+KHMEXP khm_int32 KHMAPI
+kcdb_attrib_get_id(wchar_t *name,
khm_int32 * id);
/*! \brief Register an attribute
\param[out] new_id Receives the ID of the newly registered
attribute. If the \a id member of the ::kcdb_attrib object is
set to KCDB_ATTR_INVALID, then a unique ID is generated. */
-KHMEXP khm_int32 KHMAPI
-kcdb_attrib_register(kcdb_attrib * attrib,
+KHMEXP khm_int32 KHMAPI
+kcdb_attrib_register(kcdb_attrib * attrib,
khm_int32 * new_id);
-/*! \brief Retrieve the attribute descriptor for an attribute
+/*! \brief Retrieve the attribute descriptor for an attribute
The descriptor that is returned must be released through a call to
kcdb_attrib_release_info()
checked, you can pass in NULL for \a attrib. In this case, if the
identifier is valid, then the funciton will return
KHM_ERROR_SUCCESS, otherwise it will return KHM_ERROR_NOT_FOUND.
-
+
\see kcdb_attrib_release_info()
*/
-KHMEXP khm_int32 KHMAPI
-kcdb_attrib_get_info(khm_int32 id,
+KHMEXP khm_int32 KHMAPI
+kcdb_attrib_get_info(khm_int32 id,
kcdb_attrib ** attrib);
/*! \brief Release an attribute descriptor
\see kcdb_attrib_get_info()
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_attrib_release_info(kcdb_attrib * attrib);
-/*! \brief Unregister an attribute
+/*! \brief Unregister an attribute
Once an attribute ID has been unregistered, it may be reclaimed by
a subsequent call to kcdb_attrib_register().
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_attrib_unregister(khm_int32 id);
-/*! \brief Retrieve the description of an attribute
+/*! \brief Retrieve the description of an attribute
\param[in] flags Specify \a KCDB_TS_SHORT to retrieve the short description. */
-KHMEXP khm_int32 KHMAPI
-kcdb_attrib_describe(khm_int32 id,
- wchar_t * buffer,
- khm_size * cbsize,
+KHMEXP khm_int32 KHMAPI
+kcdb_attrib_describe(khm_int32 id,
+ wchar_t * buffer,
+ khm_size * cbsize,
khm_int32 flags);
/*! \brief Count attributes
The number of attributes that match are returned in \a pcount.
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_attrib_get_count(khm_int32 and_flags,
khm_int32 eq_flags,
khm_size * pcount);
array. This is different from the usual size parameters used
in the NetIDMgr API.
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_attrib_get_ids(khm_int32 and_flags,
khm_int32 eq_flags,
khm_int32 * plist,
*/
#define KCDB_ATTR_ID 1
-/*! \brief The name of the identity
+/*! \brief The name of the identity
- \b Type: STRING
- \b Flags: REQUIRED, COMPUTED, SYSTEM
*/
#define KCDB_ATTR_TYPE 3
-/*! \brief Type name for the credential
+/*! \brief Type name for the credential
- \b Type: STRING
- \b Flags: REQUIRED, COMPUTED, SYSTEM
*/
#define KCDB_ATTR_TYPE_NAME 4
-/*! \brief Name of the parent credential
+/*! \brief Name of the parent credential
- \b Type: STRING
- \b Flags: SYSTEM
*/
#define KCDB_ATTR_PARENT_NAME 5
-/*! \brief Issed on
+/*! \brief Issed on
- \b Type: DATE
- \b Flags: SYSTEM
*/
#define KCDB_ATTR_ISSUE 6
-/*! \brief Expires on
+/*! \brief Expires on
- \b Type: DATE
- \b Flags: SYSTEM
*/
#define KCDB_ATTR_EXPIRE 7
-/*! \brief Renewable period expires on
+/*! \brief Renewable period expires on
- \b Type: DATE
- \b Flags: SYSTEM
*/
#define KCDB_ATTR_RENEW_EXPIRE 8
-/*! \brief Time left till expiration
+/*! \brief Time left till expiration
- \b Type: INTERVAL
- \b Flags: SYSTEM, COMPUTED, VOLATILE
*/
#define KCDB_ATTR_LOCATION 11
-/*! \brief Lifetime of the credential
+/*! \brief Lifetime of the credential
- \b Type: INTERVAL
- \b Flags: SYSTEM
\retval KHM_ERROR_DUPLICATE The \a name or \a id that was
specified is already in use.
*/
-KHMEXP khm_int32 KHMAPI
-kcdb_credtype_register(kcdb_credtype * type,
+KHMEXP khm_int32 KHMAPI
+kcdb_credtype_register(kcdb_credtype * type,
khm_int32 * new_id);
/*! \brief Return a held reference to a \a kcdb_credtype object describing the credential type.
\see kcdb_credtype_release_info()
\see kcdb_credtype_register()
*/
-KHMEXP khm_int32 KHMAPI
-kcdb_credtype_get_info(khm_int32 id,
+KHMEXP khm_int32 KHMAPI
+kcdb_credtype_get_info(khm_int32 id,
kcdb_credtype ** type);
/*! \brief Release a reference to a \a kcdb_credtype object
\see kcdb_credtype_get_info()
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_credtype_release_info(kcdb_credtype * type);
/*! \brief Unregister a credentials type
This should only be done when the credentials provider is being
unloaded.
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_credtype_unregister(khm_int32 id);
/*! \brief Retrieve the name of a credentials type
\retval KHM_ERROR_INVALID_PARAM Invalid parameter.
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_credtype_get_name(khm_int32 id,
wchar_t * buf,
khm_size * cbbuf);
type specific subcription. It may return NULL if the subscription
is not available.
*/
-KHMEXP khm_handle KHMAPI
+KHMEXP khm_handle KHMAPI
kcdb_credtype_get_sub(khm_int32 id);
/*! \brief Get the description of a credentials type
\retval KHM_ERROR_TOO_LONG Either \a buf was NULL or the supplied buffer was insufficient. The required size is specified in \a cbbuf.
\retval KHM_ERROR_INVALID_PARAM One or more parameters were invalid.
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_credtype_describe(khm_int32 id,
wchar_t * buf,
khm_size * cbbuf,
\param[out] id Receives the identifier if the call succeeds
*/
-KHMEXP khm_int32 KHMAPI
-kcdb_credtype_get_id(wchar_t * name,
+KHMEXP khm_int32 KHMAPI
+kcdb_credtype_get_id(wchar_t * name,
khm_int32 * id);
/*@}*/
/*********************************************************************/
-/*! \defgroup kcdb_buf Generic access to buffer
+/*! \defgroup kcdb_buf Generic access to buffer
Currently, credentials and identities both hold record data types.
This set of API's allow an application to access fields in the
exists in this record then the function will return
KHM_ERROR_SUCCESS, otherwise it returns KHM_ERROR_NOT_FOUND.
*/
-KHMEXP khm_int32 KHMAPI
-kcdb_buf_get_attr(khm_handle record,
- khm_int32 attr_id,
- khm_int32 * attr_type,
- void * buffer,
+KHMEXP khm_int32 KHMAPI
+kcdb_buf_get_attr(khm_handle record,
+ khm_int32 attr_id,
+ khm_int32 * attr_type,
+ void * buffer,
khm_size * pcb_buf);
/*! \brief Get an attribute from a record by name.
exists in this record then the function will return
KHM_ERROR_SUCCESS, otherwise it returns KHM_ERROR_NOT_FOUND.
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_buf_get_attrib(khm_handle record,
wchar_t * attr_name,
khm_int32 * attr_type,
\retval KHM_ERROR_TOO_LONG Either \a buffer was NULL or the
supplied buffer was insufficient
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_buf_get_attr_string(khm_handle record,
khm_int32 attr_id,
wchar_t * buffer,
\see kcdb_cred_get_attr_string()
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_buf_get_attrib_string(khm_handle record,
wchar_t * attr_name,
wchar_t * buffer,
individual data type handlers may copy in less than this many
bytes in to the record.
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_buf_set_attr(khm_handle record,
khm_int32 attr_id,
void * buffer,
individual data type handlers may copy in less than this many
bytes in to the record.
*/
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_buf_set_attrib(khm_handle record,
wchar_t * attr_name,
void * buffer,
khm_size cbbuf);
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_buf_hold(khm_handle record);
-KHMEXP khm_int32 KHMAPI
+KHMEXP khm_int32 KHMAPI
kcdb_buf_release(khm_handle record);
/*@}*/
git://git.openafs.org / openafs.git / blobdiff