[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[SCM] GNU shishi branch, master, updated. shishi-1-0-2-45-g8ba5d47
|
From: |
Mats Erik Andersson |
|
Subject: |
[SCM] GNU shishi branch, master, updated. shishi-1-0-2-45-g8ba5d47 |
|
Date: |
Fri, 11 Jul 2014 23:20:21 +0000 |
This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "GNU shishi".
http://git.savannah.gnu.org/cgit/shishi.git/commit/?id=8ba5d470a9d85efcdb111865dd0e450027a6a521
The branch, master has been updated
via 8ba5d470a9d85efcdb111865dd0e450027a6a521 (commit)
from 78f403d8c77c8493f4cea9902e7fe27715ed1e04 (commit)
Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.
- Log -----------------------------------------------------------------
commit 8ba5d470a9d85efcdb111865dd0e450027a6a521
Author: Mats Erik Andersson <address@hidden>
Date: Sat Jul 12 01:17:45 2014 +0200
API documentation.
-----------------------------------------------------------------------
Summary of changes:
db/config.c | 25 ++++++-----
db/core.c | 117 +++++++++++++++++++++++++------------------------
db/err.c | 10 ++--
db/setup.c | 34 ++++++++------
lib/cfg.c | 139 ++++++++++++++++++++++++++++++++++++----------------------
5 files changed, 182 insertions(+), 143 deletions(-)
diff --git a/db/config.c b/db/config.c
index 4a10773..7de9f41 100644
--- a/db/config.c
+++ b/db/config.c
@@ -28,11 +28,11 @@
* @value: String containing database definition.
*
* Sets up and opens a new database. The syntax of the parameter
- * @value is "TYPE[ LOCATION[ PARAMETER]]", where TYPE is one of the
- * supported database types, typically "file", and LOCATION as
- * well as PARAMETER are optional strings passed on to
- * the database during initialization.
+ * @value is "TYPE[ LOCATION[ PARAMETER]]", where TYPE is one of
+ * the supported database types, typically "file".
*
+ * The above substrings LOCATION and PARAMETER are optional strings
+ * passed on verbatim to the database during initialization.
* Neither TYPE nor LOCATION may contain embedded spaces,
* but PARAMETER may do so.
*
@@ -94,12 +94,12 @@ shisa_cfg_db (Shisa * dbh, const char *value)
* @option: String with options to prime the Shisa library.
*
* Configures the Shisa library from the specification @option.
- * This call expects a string declaration of the form "db=VALUE"
- * or "db VALUE", where VALUE is of the form
- * "TYPE[ LOCATION[ PARAMETER]]", as is described for
- * shisa_cfg_db().
+ * This call expects a string declaration of the form "db=VALUE",
+ * or "db VALUE". Here VALUE is the same declaration as used by
+ * shisa_cfg_db(), i.e., of the form "TYPE[ LOCATION[ PARAMETER]]".
*
- * Thus shisa_cfg() comes closer to a syntax with key-value pairs.
+ * The prefix "db", mandatory in @option, makes shisa_cfg() suited
+ * to a syntax with key-value pairs also in PARAMETER.
*
* Return Value: Returns %SHISA_OK if @option is valid.
**/
@@ -132,7 +132,8 @@ shisa_cfg (Shisa * dbh, const char *option)
* Configures the Shisa library using a configuration file
* located at @cfg.
*
- * Return Value: Returns %SHISA_OK iff successful.
+ * Return Value: Returns %SHISA_OK if successful. Typically
+ * returns %SHISA_CFG_NO_FILE in response to a misnamed file.
**/
int
shisa_cfg_from_file (Shisa * dbh, const char *cfg)
@@ -198,9 +199,9 @@ shisa_cfg_from_file (Shisa * dbh, const char *cfg)
* shisa_cfg_default_systemfile:
* @dbh: Shisa library handle created by shisa().
*
- * Recovers information on the installed configuration.
+ * Fetches information on the installed configuration.
*
- * Return value: Returns the file name of the active
+ * Return value: Returns file name of the active
* system configuration.
**/
const char *
diff --git a/db/core.c b/db/core.c
index f84e98c..11f37c3 100644
--- a/db/core.c
+++ b/db/core.c
@@ -64,7 +64,7 @@ shisa_enumerate_realms (Shisa * dbh, char ***realms, size_t *
nrealms)
* @realm: Name of realm, as null-terminated UTF-8 string.
* @principals: Returned pointer to newly allocated array of just
* allocated null-terminated UTF-8 strings with principal names.
- * @nprincipals: Pointer to number updated with the number of just
+ * @nprincipals: Pointer to an integer updated with the number of just
* allocated and returned principal names.
*
* Extracts a list of all principal names in backend belonging to
@@ -111,7 +111,7 @@ shisa_enumerate_principals (Shisa * dbh,
* Extracts information about given the address@hidden pair
* selected by @principal and @realm.
*
- * Return value: Returns %SHISA_OK iff successful, %SHISA_NO_REALM if
+ * Return value: Returns %SHISA_OK if successful, %SHISA_NO_REALM if
* the indicated realm does not exist, %SHISA_NO_PRINCIPAL if the
* indicated principal does not exist, or an error code otherwise.
**/
@@ -145,14 +145,16 @@ shisa_principal_find (Shisa * dbh,
* Modifies information stored about the given principal
* address@hidden Note that it is usually a good idea to set
* in @ph only the fields that are to be updated.
- * Specifically, it is recommended to first call
- * shisa_principal_find() to get the current information, then to
- * modify one field and call shisa_principal_update().
+ *
+ * It is generally suggested to first call shisa_principal_find(),
+ * to get the current information, then to modify one field and
+ * call shisa_principal_update().
+ *
* Modifying several values is not recommended in general,
- * as this will 1) overwrite any modifications made to other fields
- * between the two calls (by other processes) and
- * 2) will cause all values to be written again, which may generate
- * more overhead.
+ * as this will 1) overwrite any modifications made to other
+ * fields between the two calls (by other processes) and
+ * 2) will cause all values to be written again, which may
+ * generate more overhead.
*
* Return value: Returns %SHISA_OK if successful, %SHISA_NO_REALM if
* the indicated realm does not exist, %SHISA_NO_PRINCIPAL if the
@@ -192,16 +194,15 @@ shisa_principal_update (Shisa * dbh,
*
* Inserts the given information into the database for the
* principal address@hidden In case @principal is %NULL,
- * the prameters @ph and @key are not used and only the realm
- * added to the database.
+ * the parameters @ph and @key are not used, so only the realm
+ * is added to the database.
*
- * Return value: Returns %SHISA_OK iff successfully added,
- * or an error code.
+ * Return value: Returns %SHISA_OK if the information was
+ * successfully added, or an error code otherwise.
**/
int
shisa_principal_add (Shisa * dbh,
- const char *realm,
- const char *principal,
+ const char *realm, const char *principal,
const Shisa_principal * ph, const Shisa_key * key)
{
_Shisa_db *db;
@@ -227,15 +228,13 @@ shisa_principal_add (Shisa * dbh,
* shisa_principal_remove:
* @dbh: Shisa library handle created by shisa().
* @realm: Name of the realm the principal belongs to.
- * @principal: Name of principal to remove. Set to %NULL,
+ * @principal: Name of the principal to remove. Set to %NULL,
* only the realm @realm is removed.
- * that the @realm itself should be removed (requires that the realm
- * to be empty).
*
* Removes all information stored in the database for the given
* principal address@hidden When @principal is %NULL, then the
- * realm @realm is itself remove, but this will only succeed if
- * the realm is already empty.
+ * realm @realm is itself removed, but this can only succeed if
+ * the realm is already empty of principals.
*
* Return value: Returns %SHISA_OK if successful, or an error code.
**/
@@ -269,23 +268,23 @@ shisa_principal_remove (Shisa * dbh, const char *realm,
const char *principal)
* criteria for relevant keys. %NULL matches all keys.
* @keys: Returned pointer to a newly allocated array of Shisa
* key structures.
- * @nkeys: Pointer to number updated with the number of allocated
- * Shisa key structures in address@hidden
- *
- * Iterates through the set of keys belonging to the principal
- * address@hidden, as specified by @principal and @realm,
- * and then extracts any keys that match the criteria in @hint.
- * Not all elements of @hint need to be filled out.
- * Set only the fields you are interested in. For example, if you
- * want to extract all keys with an etype of 3, i.e., DES-CBC-MD5,
- * set the @key->etype field to 3, and all other fields to 0.
- *
- * Return value: Returns %SHISA_OK iff successful, or an error code.
+ * @nkeys: Pointer to an integer updated with the number of
+ * allocated Shisa key structures in address@hidden
+ *
+ * Iterates through the set of keys belonging to address@hidden,
+ * as selected by @principal and @realm. Then extracts any keys
+ * that match the criteria in @hint.
+ *
+ * Not all elements of @hint need to be filled in. Set only
+ * the fields you are interested in. For example, if you want
+ * to extract all keys of etype 3, i.e., DES-CBC-MD5, then set
+ * the field @key->etype to 3, and all other fields to zero.
+ *
+ * Return value: Returns %SHISA_OK if successful, or an error code.
**/
int
shisa_keys_find (Shisa * dbh,
- const char *realm,
- const char *principal,
+ const char *realm, const char *principal,
const Shisa_key * hint, Shisa_key *** keys, size_t * nkeys)
{
_Shisa_db *db;
@@ -315,10 +314,10 @@ shisa_keys_find (Shisa * dbh,
* @principal: Name of the principal to add a new key for.
* @key: Pointer to a Shisa key structure with the new key.
*
- * Adds @key to the database entry belonging to the
- * principal address@hidden, built from @principal and @realm.
+ * Adds a complete key @key to the database entry belonging
+ * to the principal address@hidden, as set by @principal and @realm.
*
- * Return value: Returns %SHISA_OK iff successful, or an error code.
+ * Return value: Returns %SHISA_OK if successful, or an error code.
**/
int
shisa_key_add (Shisa * dbh,
@@ -351,16 +350,17 @@ shisa_key_add (Shisa * dbh,
* all fields are used for the new key. Note that @oldkey
* normally has far fewer fields filled-in.
*
- * Modifies data about a key stored in the database, a key belonging
- * to the principal built from @principal and @realm.
- * First @oldkey is used to locate the key to
- * update (similar to shisa_keys_find()), then found key is
- * modified to contain whatever information is stored in @newkey.
- * Not all elements of @oldkey need to be filled out, only sufficiently
- * man so as to uniquely identify the desired key.
- * For example, if you want to modify the information stored for
- * the only key with an etype of 3, * i.e., DES-CBC-MD5,
- * then set the @key->etype field to 3, and all other fields to 0.
+ * Modifies data about a key stored in the database, a key
+ * belonging to the principal selected by @principal and @realm.
+ * First @oldkey is used to locate the key to update, as does
+ * shisa_keys_find(). Then the found key is modified to carry
+ * whatever information is stored in @newkey.
+ *
+ * Not all elements of @oldkey need to be filled out, only
+ * sufficiently many so as to uniquely identify the desired key.
+ * For example, if you want to modify the information stored about
+ * a unique key of etype 3, i.e., DES-CBC-MD5, then set the field
+ * @key->etype to 3, leaving all other fields as zero.
*
* Return value: Returns %SHISA_OK on success, %SHISA_NO_KEY if no
* key could be located, %SHISA_MULTIPLE_KEY_MATCH if more
@@ -394,14 +394,15 @@ shisa_key_update (Shisa * dbh,
* @realm: Name of the realm the principal belongs to.
* @principal: Name of the principal whose key is to be removed.
* @key: Pointer to a Shisa key structure with hints on matching
- * criteria for the key to be removed.
+ * criteria for the key to select.
*
* Removes from the Shisa database a key, matching the hints in @key,
* for the user address@hidden Not all elements of @key need to be
- * filled in, only those relevant to locate the key. For example,
- * if you want to remove the only key with an etype of 3, i.e.,
- * DES-CBC-MD5, set the @key->etype field to 3, and all other
- * fields to 0.
+ * filled in, only those relevant to locate the key uniquely.
+ *
+ * For example, if you want to remove the only key of etype 3,
+ * i.e., DES-CBC-MD5, then set the field @key->etype to 3, and
+ * all other fields to zero.
*
* Return value: Returns %SHISA_OK on success, %SHISA_NO_KEY if no key
* could be located, %SHISA_MULTIPLE_KEY_MATCH if more than one
@@ -429,10 +430,10 @@ shisa_key_remove (Shisa * dbh,
/**
* shisa_key_free:
* @dbh: Shisa library handle created by shisa().
- * @key: Pointer to a Shisa key structure to be deallocated.
+ * @key: Pointer to a Shisa key structure to deallocate.
*
- * Deallocates the fields of a Shisa key structure, and the structure
- * itself.
+ * Deallocates the fields of a Shisa key structure, as well as
+ * the structure itself.
**/
void
shisa_key_free (Shisa * dbh, Shisa_key * key)
@@ -448,11 +449,11 @@ shisa_key_free (Shisa * dbh, Shisa_key * key)
/**
* shisa_keys_free:
* @dbh: Shisa library handle created by shisa().
- * @keys: Pointer to an array of Shisa key structures, @nkeys in number.
+ * @keys: Pointer to an array of Shisa key structures.
* @nkeys: Number of key elements in the array @keys.
*
- * Deallocates each key element in an array of Shisa database keys,
- * using repeated calls to shisa_key_free().
+ * Deallocates each key element in the array @keys of Shisa
+ * database keys, using repeated calls to shisa_key_free().
**/
void
shisa_keys_free (Shisa * dbh, Shisa_key ** keys, size_t nkeys)
diff --git a/db/err.c b/db/err.c
index ba7fe59..540ceb1 100644
--- a/db/err.c
+++ b/db/err.c
@@ -81,9 +81,8 @@ static const struct shisa_error_msgs _shisa_error_messages[]
= {
* shisa_strerror:
* @err: Shisa error code.
*
- * Explains verbally an error status @err.
- * The returned string can be used to compose a diagnostic
- * message of benefit to a user.
+ * Explains verbally an error status @err. The returned string
+ * can be used to compose a diagnostic message of benefit to a user.
*
* Return value: Returns a pointer to a statically allocated string,
* containing a description of the error given as input argument.
@@ -104,10 +103,11 @@ shisa_strerror (int err)
/**
* shisa_info:
* @dbh: Shisa library handle created by shisa().
- * @format: printf(3) style format string.
- * @...: printf(3) style arguments.
+ * @format: printf style format string.
+ * @...: printf style arguments.
*
* Prints an informational message to standard error.
+ * The text is composed from the arguments, like printf(3).
**/
void
shisa_info (Shisa * dbh, const char *format, ...)
diff --git a/db/setup.c b/db/setup.c
index 5e9beb6..a266963 100644
--- a/db/setup.c
+++ b/db/setup.c
@@ -67,16 +67,18 @@ shisa_done (Shisa * dbh)
* shisa_init:
* @dbh: Returned pointer to a created Shisa library handle.
*
- * Creates a Shisa library handle, using shisa(), and reads the system
+ * Creates a Shisa library handle, using shisa(), reading the system
* configuration file from its default location. The path to the
* default system configuration file is decided at compile time
* ($sysconfdir/shisa.conf).
- * The handle is allocated regardless of return value, except for
- * %SHISA_INIT_ERROR which indicates a problem in allocating the
- * handle. Other error conditions arise while reading a file.
*
- * Return value: Returns %SHISA_OK, or an error code. The error
- * code %SHISA_INIT_ERROR indicates a failure to create the handle.
+ * The handle is allocated regardless of return value, the only
+ * exception being %SHISA_INIT_ERROR, which indicates a problem
+ * in allocating the handle. Other error conditions arise while
+ * reading a file.
+ *
+ * Return value: Returns %SHISA_OK, or an error code. The value
+ * %SHISA_INIT_ERROR indicates a failure to create the handle.
**/
int
shisa_init (Shisa ** dbh)
@@ -89,16 +91,18 @@ shisa_init (Shisa ** dbh)
* @dbh: Returned pointer to a created Shisa library handle.
* @file: Filename of system configuration, or %NULL.
*
- * Creates a Shisa library handle, using shisa(), and reads the system
- * configuration file from the indicated location at @file, or at the
- * default location, should @file be %NULL.
- * The path to the default system configuration file is
- * decided at compile time ($sysconfdir/shisa.conf).
- * The handle is allocated regardless of return value, except for
- * %SHISA_INIT_ERROR which indicates a problem in allocating the
- * handle. Other error conditions arise while reading a file.
+ * Creates a Shisa library handle, using shisa(), but reading
+ * the system configuration file at the location @file, or at
+ * the default location, should @file be %NULL. The path to
+ * the default system configuration file is decided at compile
+ * time ($sysconfdir/shisa.conf).
+ *
+ * The handle is allocated regardless of return value, the only
+ * exception being %SHISA_INIT_ERROR, which indicates a problem
+ * in allocating the handle. Other error conditions arise while
+ * reading a file.
*
- * Return value: Returns %SHISA_OK, or an error code. The error
+ * Return value: Returns %SHISA_OK, or an error code. The value
* %SHISA_INIT_ERROR indicates a failure to create the handle.
**/
int
diff --git a/lib/cfg.c b/lib/cfg.c
index 8f2d473..025437f 100644
--- a/lib/cfg.c
+++ b/lib/cfg.c
@@ -104,12 +104,14 @@ _shishi_realminfo_new (Shishi * handle, char *realm)
/**
* shishi_cfg:
- * @handle: Shishi library handle create by shishi_init().
- * @option: string with shishi library option.
+ * @handle: Shishi library handle created by shishi_init().
+ * @option: String containing shishi library options.
*
- * Configure shishi library with given option.
+ * Configures the shishi library according to the options
+ * given in @option.
*
- * Return Value: Returns SHISHI_OK if option was valid.
+ * Return Value: Returns SHISHI_OK if @option is valid
+ * and configuration was successful.
**/
int
shishi_cfg (Shishi * handle, const char *option)
@@ -348,12 +350,13 @@ out:
/**
* shishi_cfg_from_file:
- * @handle: Shishi library handle create by shishi_init().
- * @cfg: filename to read configuration from.
+ * @handle: Shishi library handle created by shishi_init().
+ * @cfg: Name of configuration file.
*
- * Configure shishi library using configuration file.
+ * Configures the shishi library using a configuration file
+ * located at @cfg.
*
- * Return Value: Returns %SHISHI_OK iff successful.
+ * Return Value: Returns %SHISHI_OK if successful.
**/
int
shishi_cfg_from_file (Shishi * handle, const char *cfg)
@@ -422,12 +425,13 @@ _shishi_transport2string (int transport)
/**
* shishi_cfg_print:
- * @handle: Shishi library handle create by shishi_init().
- * @fh: file descriptor opened for writing.
+ * @handle: Shishi library handle created by shishi_init().
+ * @fh: File stream handle opened for writing.
*
- * Print library configuration status, mostly for debugging purposes.
+ * Prints library configuration status to @fh. This function is
+ * mostly intended for debugging purposes.
*
- * Return Value: Returns SHISHI_OK.
+ * Return Value: Always returns SHISHI_OK.
**/
int
shishi_cfg_print (Shishi * handle, FILE * fh)
@@ -467,12 +471,15 @@ shishi_cfg_print (Shishi * handle, FILE * fh)
/**
* shishi_cfg_default_systemfile:
- * @handle: Shishi library handle create by shishi_init().
+ * @handle: Shishi library handle created by shishi_init().
*
- * The system configuration file name is decided at compile-time, but
- * may be overridden by the environment variable SHISHI_CONFIG.
+ * The system configuration file name is decided at compile
+ * time, but is replaced by assigning another file name to
+ * the environment variable $SHISHI_CONFIG. This call offers
+ * a single interface for determining the file name, to which
+ * the library turns for its settings.
*
- * Return value: Return system configuration file name.
+ * Return value: Returns file name of present system configuration.
**/
const char *
shishi_cfg_default_systemfile (Shishi * handle)
@@ -490,15 +497,20 @@ shishi_cfg_default_systemfile (Shishi * handle)
/**
* shishi_cfg_default_userdirectory:
- * @handle: Shishi library handle create by shishi_init().
+ * @handle: Shishi library handle created by shishi_init().
+ *
+ * The default user directory, referred to for Shishi ticket cache
+ * and other purposes, is normally computed by appending the compile
+ * time macro %BASE_DIR ("/.shishi" by default) to the content of
+ * the environment variable $HOME.
*
- * The default user directory (used for, e.g. Shishi ticket cache) is
- * normally computed by appending BASE_DIR ("/.shishi") to the content
- * of the environment variable $HOME, but can be overridden by
- * specifying the complete path in the environment variable
- * SHISHI_HOME.
+ * The hard coded directory, generally "$HOME/.shishi/", will be
+ * replaced by whatever complete path is stored in the environment
+ * variable $SHISHI_HOME.
*
- * Return value: Return directory with configuration files etc.
+ * Return value: Returns the user's directory name where the Shishi
+ * library will search for configuration files, ticket caches,
+ * etcetera.
**/
const char *
shishi_cfg_default_userdirectory (Shishi * handle)
@@ -522,15 +534,20 @@ shishi_cfg_default_userdirectory (Shishi * handle)
/**
* shishi_cfg_userdirectory_file:
- * @handle: Shishi library handle create by shishi_init().
- * @file: basename of file to find in user directory.
+ * @handle: Shishi library handle created by shishi_init().
+ * @file: Basename of file to use for the user's configuration
+ * settings of the library.
+ *
+ * Reports the full path to the file where the Shishi library
+ * expects to find the user's library configuration, given that
+ * the file itself is named by the parameter @file.
*
- * Get the full path to specified @file in the users' configuration
- * directory.
+ * The answer is composed from the value of @file and the directory
+ * returned by shishi_cfg_default_userdirectory(). Typically, the
+ * returned string would be expanded from "$HOME/.shishi/@file".
*
- * Return value: Return full path to given relative filename, relative
- * to the user specific Shishi configuration directory as returned
- * by shishi_cfg_default_userdirectory() (typically $HOME/.shishi).
+ * Return value: Returns the absolute filename to the argument @file,
+ * relative to the user specific Shishi configuration directory.
**/
char *
shishi_cfg_userdirectory_file (Shishi * handle, const char *file)
@@ -546,12 +563,15 @@ shishi_cfg_userdirectory_file (Shishi * handle, const
char *file)
/**
* shishi_cfg_default_userfile:
- * @handle: Shishi library handle create by shishi_init().
+ * @handle: Shishi library handle created by shishi_init().
+ *
+ * Reports the absolute filename of the default user configuration
+ * file. This is typically "$HOME/.shishi/shishi.conf".
*
- * Get filename of default user configuration file, typically
- * $HOME/shishi.conf.
+ * The value of $SHISHI_HOME will change the directory part,
+ * as stated regarding shishi_cfg_default_userdirectory().
*
- * Return value: Return user configuration filename.
+ * Return value: Returns the user's configuration filename.
**/
const char *
shishi_cfg_default_userfile (Shishi * handle)
@@ -565,13 +585,14 @@ shishi_cfg_default_userfile (Shishi * handle)
/**
* shishi_cfg_clientkdcetype:
- * @handle: Shishi library handle create by shishi_init().
- * @etypes: output array with encryption types.
+ * @handle: Shishi library handle created by shishi_init().
+ * @etypes: Pointer to an array of encryption types.
*
- * Set the etypes variable to the array of preferred client etypes.
+ * Sets the variable @etypes to a static array of preferred encryption
+ * types applicable to clients.
*
- * Return value: Return the number of encryption types in the array,
- * 0 means none.
+ * Return value: Returns the number of encryption types referred to
+ * by the updated array pointer, or zero, should no type exist.
**/
int
shishi_cfg_clientkdcetype (Shishi * handle, int32_t ** etypes)
@@ -582,11 +603,15 @@ shishi_cfg_clientkdcetype (Shishi * handle, int32_t **
etypes)
/**
* shishi_cfg_clientkdcetype_fast:
- * @handle: Shishi library handle create by shishi_init().
+ * @handle: Shishi library handle created by shishi_init().
*
- * Extract the default etype from the list of preferred client etypes.
+ * Extracts the default encryption type from the list of preferred
+ * encryption types acceptable to the client.
*
- * Return value: Return the default encryption types.
+ * When the preferred list is empty, %SHISHI_AES256_CTS_HMAC_SHA1_96
+ * is returned as a sensible default type.
+ *
+ * Return value: Returns the default encryption type.
**/
int32_t
shishi_cfg_clientkdcetype_fast (Shishi * handle)
@@ -600,14 +625,17 @@ shishi_cfg_clientkdcetype_fast (Shishi * handle)
/**
* shishi_cfg_clientkdcetype_set:
* @handle: Shishi library handle created by shishi_init().
- * @value: string with encryption types.
+ * @value: String naming acceptable encryption types.
+ *
+ * Sets the configuration option "client-kdc-etypes" from @value.
+ * The string contains encryption types, integers or names,
+ * separated by comma or by whitespace. An example naming three
+ * encryption types could be:
*
- * Set the "client-kdc-etypes" configuration option from given string.
- * The string contains encryption types (integer or names) separated
- * by comma or whitespace, e.g. "aes256-cts-hmac-sha1-96
- * des3-cbc-sha1-kd des-cbc-md5".
+ * aes256-cts-hmac-sha1-96 des3-cbc-sha1-kd des-cbc-md5
*
- * Return value: Returns SHISHI_OK if successful.
+ * Return value: Returns SHISHI_OK if successful, and
+ * %SHISHI_INVALID_ARGUMENT otherwise.
**/
int
shishi_cfg_clientkdcetype_set (Shishi * handle, char *value)
@@ -651,13 +679,18 @@ shishi_cfg_clientkdcetype_set (Shishi * handle, char
*value)
/**
* shishi_cfg_authorizationtype_set:
* @handle: Shishi library handle created by shishi_init().
- * @value: string with authorization types.
+ * @value: String listing acceptable authorization types.
+ *
+ * Sets the configuration option "authorization-types" from @value.
+ * The string contains authorization types, integers or names,
+ * separated by comma or whitespace.
*
- * Set the "authorization-types" configuration option from given string.
- * The string contains authorization types (integer or names) separated
- * by comma or whitespace, e.g. "basic k5login".
+ * As an example, "k5login basic" would first check Kerberos5
+ * authentication based on preset principals, and then fall back
+ * to the basic test of identical principal names.
*
- * Return value: Returns SHISHI_OK if successful.
+ * Return value: Returns SHISHI_OK if successful, and
+ * %SHISHI_INVALID_ARGUMENT otherwise.
**/
int
shishi_cfg_authorizationtype_set (Shishi * handle, char *value)
hooks/post-receive
--
GNU shishi
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [SCM] GNU shishi branch, master, updated. shishi-1-0-2-45-g8ba5d47,
Mats Erik Andersson <=