shishi-commit
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

CVS shishi/lib


From: shishi-commit
Subject: CVS shishi/lib
Date: Tue, 09 Nov 2004 20:39:20 +0100

Update of /home/cvs/shishi/lib
In directory dopio:/tmp/cvs-serv5081/lib

Modified Files:
        ap.c apreq.c as.c authorize.c cfg.c crypto-md.c crypto-null.c 
        crypto.c enckdcreppart.c encticketpart.c error.c gztime.c 
        hostkeys.c kdc.c key.c keys.c krberror.c priv.c realm.c safe.c 
        tgs.c ticket.c tkt.c tkts.c 
Log Message:
Doc fix.

--- /home/cvs/shishi/lib/ap.c   2004/10/15 11:05:57     1.71
+++ /home/cvs/shishi/lib/ap.c   2004/11/09 19:39:20     1.72
@@ -1,4 +1,4 @@
-/* ap.c        AP functions
+/* ap.c --- AP functions
  * Copyright (C) 2002, 2003, 2004  Simon Josefsson
  *
  * This file is part of Shishi.
@@ -545,6 +545,8 @@
  * shishi_ap_tkt:
  * @ap: structure that holds information about AP exchange
  *
+ * Get Ticket from AP exchange.
+ *
  * Return value: Returns the ticket from the AP exchange, or NULL if
  *               not yet set or an error occured.
  **/
@@ -575,6 +577,8 @@
  *       authenticator checksum data, on output actual length of
  *       output array that holds authenticator checksum data.
  *
+ * Get checksum data from Authenticator.
+ *
  * Return value: Returns SHISHI_OK if successful, or
  * SHISHI_TOO_SMALL_BUFFER if buffer provided was too small.
  **/
@@ -669,6 +673,8 @@
  * shishi_ap_authenticator:
  * @ap: structure that holds information about AP exchange
  *
+ * Get ASN.1 Authenticator structure from AP exchange.
+ *
  * Return value: Returns the Authenticator from the AP exchange, or
  *               NULL if not yet set or an error occured.
  **/
@@ -698,6 +704,8 @@
  * shishi_ap_req:
  * @ap: structure that holds information about AP exchange
  *
+ * Get ASN.1 AP-REQ structure from AP exchange.
+ *
  * Return value: Returns the AP-REQ from the AP exchange, or NULL if
  *               not yet set or an error occured.
  **/
@@ -1046,6 +1054,8 @@
  * shishi_ap_rep:
  * @ap: structure that holds information about AP exchange
  *
+ * Get ASN.1 AP-REP structure from AP exchange.
+ *
  * Return value: Returns the AP-REP from the AP exchange, or NULL if
  *               not yet set or an error occured.
  **/
@@ -1278,9 +1288,11 @@
 }
 
 /**
- * shishi_ap_rep:
+ * shishi_ap_encapreppart:
  * @ap: structure that holds information about AP exchange
  *
+ * Get ASN.1 EncAPRepPart structure from AP exchange.
+ *
  * Return value: Returns the EncAPREPPart from the AP exchange, or
  *               NULL if not yet set or an error occured.
  **/
--- /home/cvs/shishi/lib/apreq.c        2004/09/10 10:00:00     1.48
+++ /home/cvs/shishi/lib/apreq.c        2004/11/09 19:39:20     1.49
@@ -648,12 +648,12 @@
 }
 
 /**
- * shishi_kdcrep_get_enc_part_etype:
+ * shishi_apreq_get_authenticator_etype:
  * @handle: shishi handle as allocated by shishi_init().
- * @kdcrep: KDC-REP variable to get value from.
+ * @aprep: AP-REP variable to get value from.
  * @etype: output variable that holds the value.
  *
- * Extract KDC-REP.enc-part.etype.
+ * Extract AP-REP.authenticator.etype.
  *
  * Return value: Returns SHISHI_OK iff successful.
  **/
--- /home/cvs/shishi/lib/as.c   2004/09/17 12:31:03     1.43
+++ /home/cvs/shishi/lib/as.c   2004/11/09 19:39:20     1.44
@@ -1,4 +1,4 @@
-/* as.c                High level client AS functions
+/* as.c --- High level client AS functions
  * Copyright (C) 2002, 2003, 2004  Simon Josefsson
  *
  * This file is part of Shishi.
@@ -117,6 +117,8 @@
  * shishi_as_asreq:
  * @as: structure that holds information about AS exchange
  *
+ * Get ASN.1 AS-REQ structure from AS exchange.
+ *
  * Return value: Returns the generated AS-REQ packet from the AS
  *               exchange, or NULL if not yet set or an error occured.
  **/
@@ -214,6 +216,8 @@
  * shishi_as_rep:
  * @as: structure that holds information about AS exchange
  *
+ * Get ASN.1 AS-REP structure from AS exchange.
+ *
  * Return value: Returns the received AS-REP packet from the AS
  *               exchange, or NULL if not yet set or an error occured.
  **/
@@ -440,6 +444,8 @@
  * shishi_as_get_krberror:
  * @as: structure that holds information about AS exchange
  *
+ * Get ASN.1 KRB-ERROR structure from AS exchange.
+ *
  * Return value: Returns the received KRB-ERROR packet from the AS
  *               exchange, or NULL if not yet set or an error occured.
  **/
@@ -491,6 +497,8 @@
  * shishi_as_get_tkt:
  * @as: structure that holds information about AS exchange
  *
+ * Get Ticket in AS exchange.
+ *
  * Return value: Returns the newly aquired tkt from the AS
  *               exchange, or NULL if not yet set or an error occured.
  **/
--- /home/cvs/shishi/lib/authorize.c    2004/09/17 12:54:53     1.7
+++ /home/cvs/shishi/lib/authorize.c    2004/11/09 19:39:20     1.8
@@ -107,6 +107,8 @@
  * shishi_authorization_parse:
  * @authorization: name of authorization type, e.g. "basic".
  *
+ * Parse authorization type name.
+ *
  * Return value: Return authorization type corresponding to a string.
  **/
 int
--- /home/cvs/shishi/lib/cfg.c  2004/09/10 10:00:00     1.58
+++ /home/cvs/shishi/lib/cfg.c  2004/11/09 19:39:20     1.59
@@ -507,6 +507,9 @@
  * @handle: Shishi library handle create by shishi_init().
  * @file: basename of file to find in user directory.
  *
+ * Get the full path to specified @file in the users' configuration
+ * directory.
+ *
  * 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).
@@ -527,6 +530,9 @@
  * shishi_cfg_default_userfile:
  * @handle: Shishi library handle create by shishi_init().
  *
+ * Get filename of default user configuration file, typically
+ * $HOME/shishi.conf.
+ *
  * Return value: Return user configuration filename.
  **/
 const char *
--- /home/cvs/shishi/lib/crypto-md.c    2003/09/08 22:58:49     1.9
+++ /home/cvs/shishi/lib/crypto-md.c    2004/11/09 19:39:20     1.10
@@ -1,5 +1,5 @@
-/* crypto-md.c DES crypto functions
- * Copyright (C) 2002, 2003  Simon Josefsson
+/* crypto-md.c --- DES crypto functions
+ * Copyright (C) 2002, 2003, 2004  Simon Josefsson
  * Copyright (C) 2003  Nicolas Pouvesle
  *
  * This file is part of Shishi.
--- /home/cvs/shishi/lib/crypto-null.c  2004/04/18 10:29:52     1.15
+++ /home/cvs/shishi/lib/crypto-null.c  2004/11/09 19:39:20     1.16
@@ -1,4 +1,4 @@
-/* crypto-null.c       NULL crypto functions
+/* crypto-null.c --- NULL crypto functions
  * Copyright (C) 2002, 2003, 2004  Simon Josefsson
  *
  * This file is part of Shishi.
--- /home/cvs/shishi/lib/crypto.c       2004/10/05 18:54:42     1.103
+++ /home/cvs/shishi/lib/crypto.c       2004/11/09 19:39:20     1.104
@@ -516,6 +516,8 @@
  * shishi_cipher_supported_p:
  * @type: encryption type, see Shishi_etype.
  *
+ * Find out if cipher is supported.
+ *
  * Return value: Return 0 iff cipher is unsupported.
  **/
 int
@@ -534,6 +536,8 @@
  * shishi_cipher_name:
  * @type: encryption type, see Shishi_etype.
  *
+ * Read humanly readable string for cipher.
+ *
  * Return value: Return name of encryption type,
  * e.g. "des3-cbc-sha1-kd", as defined in the standards.
  **/
@@ -557,6 +561,8 @@
  * shishi_cipher_blocksize:
  * @type: encryption type, see Shishi_etype.
  *
+ * Get block size for cipher.
+ *
  * Return value: Return block size for encryption type, as defined in
  * the standards.
  **/
@@ -576,6 +582,8 @@
  * shishi_cipher_confoundersize:
  * @type: encryption type, see Shishi_etype.
  *
+ * Get length of confounder for cipher.
+ *
  * Return value: Returns the size of the confounder (random data) for
  * encryption type, as defined in the standards.
  **/
@@ -595,6 +603,8 @@
  * shishi_cipher_keylen:
  * @type: encryption type, see Shishi_etype.
  *
+ * Get key length for cipher.
+ *
  * Return value: Return length of key used for the encryption type, as
  * defined in the standards.
  **/
@@ -614,6 +624,8 @@
  * shishi_cipher_randomlen:
  * @type: encryption type, see Shishi_etype.
  *
+ * Get length of random data for cipher.
+ *
  * Return value: Return length of random used for the encryption type,
  * as defined in the standards.
  **/
@@ -633,6 +645,8 @@
  * shishi_cipher_defaultcksumtype:
  * @type: encryption type, see Shishi_etype.
  *
+ * Get the default checksum associated with cipher.
+ *
  * Return value: Return associated checksum mechanism for the
  * encryption type, as defined in the standards.
  **/
@@ -776,6 +790,8 @@
  * shishi_checksum_supported_p:
  * @type: checksum type, see Shishi_cksumtype.
  *
+ * Find out whether checksum is supported.
+ *
  * Return value: Return 0 iff checksum is unsupported.
  **/
 int
@@ -794,6 +810,8 @@
  * shishi_checksum_name:
  * @type: checksum type, see Shishi_cksumtype.
  *
+ * Get name of checksum.
+ *
  * Return value: Return name of checksum type,
  * e.g. "hmac-sha1-96-aes256", as defined in the standards.
  **/
@@ -817,6 +835,8 @@
  * shishi_checksum_cksumlen:
  * @type: checksum type, see Shishi_cksumtype.
  *
+ * Get length of checksum output.
+ *
  * Return value: Return length of checksum used for the checksum type,
  * as defined in the standards.
  **/
@@ -836,6 +856,8 @@
  * shishi_checksum_parse:
  * @checksum: name of checksum type, e.g. "hmac-sha1-96-aes256".
  *
+ * Get checksum number by parsing a string.
+ *
  * Return value: Return checksum type, see Shishi_cksumtype,
  * corresponding to a string.
  **/
--- /home/cvs/shishi/lib/enckdcreppart.c        2004/09/10 10:00:00     1.34
+++ /home/cvs/shishi/lib/enckdcreppart.c        2004/11/09 19:39:20     1.35
@@ -1,4 +1,4 @@
-/* enckdcreppart.c     Key distribution encrypted reply part functions
+/* enckdcreppart.c --- Key distribution encrypted reply part functions
  * Copyright (C) 2002, 2003, 2004  Simon Josefsson
  *
  * This file is part of Shishi.
--- /home/cvs/shishi/lib/encticketpart.c        2004/10/15 11:05:57     1.34
+++ /home/cvs/shishi/lib/encticketpart.c        2004/11/09 19:39:20     1.35
@@ -1,4 +1,4 @@
-/* encticketpart.c     encrypted ticket part handling
+/* encticketpart.c --- Encrypted ticket part handling.
  * Copyright (C) 2002, 2003, 2004  Simon Josefsson
  *
  * This file is part of Shishi.
--- /home/cvs/shishi/lib/error.c        2004/08/01 18:08:45     1.35
+++ /home/cvs/shishi/lib/error.c        2004/11/09 19:39:20     1.36
@@ -1,4 +1,4 @@
-/* error.c     error handling functions
+/* error.c --- Error handling functions.
  * Copyright (C) 2002, 2003, 2004  Simon Josefsson
  *
  * This file is part of Shishi.
@@ -85,7 +85,9 @@
 
 /**
  * shishi_strerror:
- * @err: shishi error code
+ * @err: shishi error code.
+ *
+ * Convert return code to human readable string.
  *
  * Return value: Returns a pointer to a statically allocated string
  * containing a description of the error with the error value @err.
--- /home/cvs/shishi/lib/gztime.c       2004/09/10 10:00:00     1.16
+++ /home/cvs/shishi/lib/gztime.c       2004/11/09 19:39:20     1.17
@@ -96,7 +96,7 @@
 }
 
 /**
- * shishi_time_get:
+ * shishi_time:
  * @handle: shishi handle as allocated by shishi_init().
  * @node: ASN.1 node to get time from.
  * @field: Name of field in ASN.1 node to get time from.
--- /home/cvs/shishi/lib/hostkeys.c     2004/10/14 21:05:59     1.11
+++ /home/cvs/shishi/lib/hostkeys.c     2004/11/09 19:39:20     1.12
@@ -1,4 +1,4 @@
-/* hostkeys.c  Functions for managing hostkeys stored in files.
+/* hostkeys.c --- Functions for managing hostkeys stored in files.
  * Copyright (C) 2002, 2003, 2004  Simon Josefsson
  *
  * This file is part of Shishi.
@@ -25,6 +25,8 @@
  * shishi_hostkeys_default_file:
  * @handle: Shishi library handle create by shishi_init().
  *
+ * Get file name of default host key file.
+ *
  * Return value: Returns the default host key filename used in the
  * library.  (Not a copy of it, so don't modify or deallocate it.)
  **/
@@ -69,6 +71,8 @@
  * @handle: Shishi library handle create by shishi_init().
  * @server: server name to get key for
  *
+ * Get host key for @server.
+ *
  * Return value: Returns the key for specific server, read from the
  * default host keys file (see shishi_hostkeys_default_file()), or
  * NULL if no key could be found or an error encountered.
@@ -87,6 +91,8 @@
  * @server: server name to get key for
  * @realm: realm of server to get key for.
  *
+ * Get host key for @server in @realm.
+ *
  * Return value: Returns the key for specific server and realm, read
  * from the default host keys file (see
  * shishi_hostkeys_default_file()), or NULL if no key could be found
@@ -106,6 +112,8 @@
  * @service: service to get key for.
  * @realm: realm of server to get key for, or NULL for default realm.
  *
+ * Get host key for @service on current host in @realm.
+ *
  * Return value: Returns the key for the server
  * "SERVICE/address@hidden" (where HOSTNAME is the current system's
  * hostname), read from the default host keys file (see
@@ -125,6 +133,8 @@
  * @handle: Shishi library handle create by shishi_init().
  * @service: service to get key for.
  *
+ * Get host key for @service on current host in default realm.
+ *
  * Return value: Returns the key for the server "SERVICE/HOSTNAME"
  * (where HOSTNAME is the current system's hostname), read from the
  * default host keys file (see shishi_hostkeys_default_file()), or
--- /home/cvs/shishi/lib/kdc.c  2004/09/10 10:00:00     1.62
+++ /home/cvs/shishi/lib/kdc.c  2004/11/09 19:39:20     1.63
@@ -1,4 +1,4 @@
-/* kdc.c       Key distribution (AS/TGS) functions
+/* kdc.c --- Key distribution (AS/TGS) functions.
  * Copyright (C) 2002, 2003, 2004  Simon Josefsson
  *
  * This file is part of Shishi.
--- /home/cvs/shishi/lib/key.c  2004/09/10 10:00:00     1.26
+++ /home/cvs/shishi/lib/key.c  2004/11/09 19:39:20     1.27
@@ -1,4 +1,4 @@
-/* key.c       Key related functions.
+/* key.c --- Key related functions.
  * Copyright (C) 2002, 2003, 2004  Simon Josefsson
  *
  * This file is part of Shishi.
@@ -35,6 +35,9 @@
  * shishi_key_principal:
  * @key: structure that holds key information
  *
+ * Get the principal part of the key owner principal name, i.e.,
+ * except the realm.
+ *
  * Return value: Returns the principal owning the key.  (Not a copy of
  * it, so don't modify or deallocate it.)
  **/
@@ -68,6 +71,8 @@
  * shishi_key_realm:
  * @key: structure that holds key information
  *
+ * Get the realm part of the key owner principal name.
+ *
  * Return value: Returns the realm for the principal owning the key.
  * (Not a copy of it, so don't modify or deallocate it.)
  **/
@@ -101,6 +106,8 @@
  * shishi_key_type:
  * @key: structure that holds key information
  *
+ * Get key type.
+ *
  * Return value: Returns the type of key as an integer as described in
  * the standard.
  **/
@@ -127,6 +134,8 @@
  * shishi_key_value:
  * @key: structure that holds key information
  *
+ * Get the raw key bytes.
+ *
  * Return value: Returns the key value as a pointer which is valid
  * throughout the lifetime of the key structure.
  **/
@@ -156,6 +165,8 @@
  * shishi_key_version:
  * @key: structure that holds key information
  *
+ * Get the "kvno" (key version) of key.
+ *
  * Return value: Returns the version of key ("kvno").
  **/
 int
--- /home/cvs/shishi/lib/keys.c 2004/02/03 16:06:27     1.8
+++ /home/cvs/shishi/lib/keys.c 2004/11/09 19:39:20     1.9
@@ -1,5 +1,5 @@
-/* keys.c      Functions for managing keys stored in files.
- * Copyright (C) 2002, 2003  Simon Josefsson
+/* keys.c --- Functions for managing keys stored in files.
+ * Copyright (C) 2002, 2003, 2004  Simon Josefsson
  *
  * This file is part of Shishi.
  *
@@ -28,6 +28,9 @@
  * @server: server name to get key for.
  * @realm: realm of server to get key for.
  *
+ * Get keys that match specified @server and @realm from the key set
+ * file @filename.
+ *
  * Return value: Returns the key for specific server and realm, read
  * from the indicated file, or NULL if no key could be found or an
  * error encountered.
@@ -88,9 +91,11 @@
  * @filename: file to read keys from.
  * @server: server name to get key for.
  *
+ * Get key for specified @server from @filename.
+ *
  * Return value: Returns the key for specific server, read from the
- * indicated file, or NULL if no key could be found or an error
- * encountered.
+ *   indicated file, or NULL if no key could be found or an error
+ *   encountered.
  **/
 Shishi_key *
 shishi_keys_for_server_in_file (Shishi * handle,
@@ -106,6 +111,8 @@
  * @service: service to get key for.
  * @realm: realm of server to get key for, or NULL for default realm.
  *
+ * Get key for specified @service and @realm from @filename.
+ *
  * Return value: Returns the key for the server
  * "SERVICE/address@hidden" (where HOSTNAME is the current system's
  * hostname), read from the default host keys file (see
--- /home/cvs/shishi/lib/krberror.c     2004/11/09 18:46:26     1.41
+++ /home/cvs/shishi/lib/krberror.c     2004/11/09 19:39:20     1.42
@@ -953,6 +953,8 @@
  * @handle: shishi handle as allocated by shishi_init().
  * @krberror: KRB-ERROR structure with error code.
  *
+ * Get error code from KRB-ERROR, without error checking.
+ *
  * Return value: Return error code (see shishi_krberror_errorcode())
  *               directly, or -1 on error.
  **/
@@ -1258,6 +1260,8 @@
  * @handle: shishi handle as allocated by shishi_init().
  * @errorcode: integer KRB-ERROR error code.
  *
+ * Get human readable string describing KRB-ERROR code.
+ *
  * Return value: Return a string describing error code.  This function
  *               will always return a string even if the error code
  *               isn't known.
--- /home/cvs/shishi/lib/priv.c 2004/09/10 10:00:00     1.8
+++ /home/cvs/shishi/lib/priv.c 2004/11/09 19:39:20     1.9
@@ -135,6 +135,8 @@
  * shishi_priv_key:
  * @priv: structure that holds information about PRIV exchange
  *
+ * Get key from PRIV exchange.
+ *
  * Return value: Returns the key used in the PRIV exchange, or NULL if
  *               not yet set or an error occured.
  **/
@@ -161,6 +163,8 @@
  * shishi_priv_priv:
  * @priv: structure that holds information about PRIV exchange
  *
+ * Get ASN.1 PRIV structure in PRIV exchange.
+ *
  * Return value: Returns the ASN.1 priv in the PRIV exchange, or NULL if
  *               not yet set or an error occured.
  **/
@@ -239,6 +243,8 @@
  * shishi_priv_encprivpart:
  * @priv: structure that holds information about PRIV exchange
  *
+ * Get ASN.1 EncPrivPart structure from PRIV exchange.
+ *
  * Return value: Returns the ASN.1 encprivpart in the PRIV exchange, or NULL if
  *               not yet set or an error occured.
  **/
--- /home/cvs/shishi/lib/realm.c        2004/10/15 11:05:57     1.19
+++ /home/cvs/shishi/lib/realm.c        2004/11/09 19:39:20     1.20
@@ -62,6 +62,8 @@
  * shishi_realm_default:
  * @handle: Shishi library handle create by shishi_init().
  *
+ * Get name of default realm.
+ *
  * Return value: Returns the default realm used in the library.  (Not
  * a copy of it, so don't modify or deallocate it.)
  **/
--- /home/cvs/shishi/lib/safe.c 2004/09/10 10:00:00     1.30
+++ /home/cvs/shishi/lib/safe.c 2004/11/09 19:39:20     1.31
@@ -123,6 +123,8 @@
  * shishi_safe_key:
  * @safe: structure that holds information about SAFE exchange
  *
+ * Get key structured from SAFE exchange.
+ *
  * Return value: Returns the key used in the SAFE exchange, or NULL if
  *               not yet set or an error occured.
  **/
@@ -149,6 +151,8 @@
  * shishi_safe_safe:
  * @safe: structure that holds information about SAFE exchange
  *
+ * Get ASN.1 SAFE structured from SAFE exchange.
+ *
  * Return value: Returns the ASN.1 safe in the SAFE exchange, or NULL if
  *               not yet set or an error occured.
  **/
--- /home/cvs/shishi/lib/tgs.c  2004/09/10 09:04:16     1.38
+++ /home/cvs/shishi/lib/tgs.c  2004/11/09 19:39:20     1.39
@@ -1,4 +1,4 @@
-/* tgs.c       High level client TGS functions
+/* tgs.c --- High level client TGS functions.
  * Copyright (C) 2002, 2003, 2004  Simon Josefsson
  *
  * This file is part of Shishi.
@@ -91,11 +91,11 @@
 }
 
 /**
- * shishi_as_done:
- * @as: structure that holds information about AS exchange
+ * shishi_tgs_done:
+ * @tgs: structure that holds information about AS exchange
  *
- * Deallocate resources associated with AS exchange.  This should be
- * called by the application when it no longer need to utilize the AS
+ * Deallocate resources associated with TGS exchange.  This should be
+ * called by the application when it no longer need to utilize the TGS
  * exchange handle.
  **/
 void
@@ -113,6 +113,8 @@
  * shishi_tgs_tgtkt:
  * @tgs: structure that holds information about TGS exchange
  *
+ * Get Ticket-granting-ticket from TGS exchange.
+ *
  * Return value: Returns the ticket-granting-ticket used in the TGS
  *               exchange, or NULL if not yet set or an error occured.
  **/
@@ -139,6 +141,8 @@
  * shishi_tgs_ap:
  * @tgs: structure that holds information about TGS exchange
  *
+ * Get the AP from TGS exchange.
+ *
  * Return value: Returns the AP exchange (part of TGS-REQ) from the
  *               TGS exchange, or NULL if not yet set or an error
  *               occured.
@@ -153,6 +157,8 @@
  * shishi_tgs_req:
  * @tgs: structure that holds information about TGS exchange
  *
+ * Get the TGS-REQ from TGS exchange.
+ *
  * Return value: Returns the generated TGS-REQ from the TGS exchange,
  *               or NULL if not yet set or an error occured.
  **/
@@ -325,6 +331,8 @@
  * shishi_tgs_rep:
  * @tgs: structure that holds information about TGS exchange
  *
+ * Get TGS-REP from TGS exchange.
+ *
  * Return value: Returns the received TGS-REP from the TGS exchange,
  *               or NULL if not yet set or an error occured.
  **/
@@ -473,6 +481,8 @@
  * shishi_tgs_krberror:
  * @tgs: structure that holds information about TGS exchange
  *
+ * Get KRB-ERROR from TGS exchange.
+ *
  * Return value: Returns the received TGS-REP from the TGS exchange,
  *               or NULL if not yet set or an error occured.
  **/
@@ -524,6 +534,8 @@
  * shishi_tgs_tkt:
  * @tgs: structure that holds information about TGS exchange
  *
+ * Get Ticket from TGS exchange.
+ *
  * Return value: Returns the newly aquired ticket from the TGS
  *               exchange, or NULL if not yet set or an error occured.
  **/
--- /home/cvs/shishi/lib/ticket.c       2004/09/17 14:59:28     1.59
+++ /home/cvs/shishi/lib/ticket.c       2004/11/09 19:39:20     1.60
@@ -1,4 +1,4 @@
-/* ticket.c    low-level ASN.1 Ticket handling
+/* ticket.c --- Low-level ASN.1 Ticket handling.
  * Copyright (C) 2002, 2003, 2004  Simon Josefsson
  *
  * This file is part of Shishi.
--- /home/cvs/shishi/lib/tkt.c  2004/10/15 11:05:57     1.50
+++ /home/cvs/shishi/lib/tkt.c  2004/11/09 19:39:20     1.51
@@ -169,6 +169,8 @@
  * shishi_tkt_ticket:
  * @tkt: input variable with ticket info.
  *
+ * Get ASN.1 Ticket structure from ticket.
+ *
  * Return value: Returns actual ticket.
  **/
 Shishi_asn1
@@ -196,6 +198,8 @@
  * shishi_tkt_enckdcreppart:
  * @tkt: input variable with ticket info.
  *
+ * Get ASN.1 EncKDCRepPart structure from ticket.
+ *
  * Return value: Returns auxilliary ticket information.
  **/
 Shishi_asn1
@@ -205,7 +209,7 @@
 }
 
 /**
- * shishi_tkt_encticketreppart_set:
+ * shishi_tkt_enckdcreppart_set:
  * @tkt: structure that holds information about Ticket exchange
  * @enckdcreppart: EncKDCRepPart to store in Ticket.
  *
@@ -223,6 +227,8 @@
  * shishi_tkt_kdcrep:
  * @tkt: input variable with ticket info.
  *
+ * Get ASN.1 KDCRep structure from ticket.
+ *
  * Return value: Returns KDC-REP information.
  **/
 Shishi_asn1
@@ -235,6 +241,8 @@
  * shishi_tkt_encticketpart:
  * @tkt: input variable with ticket info.
  *
+ * Get ASN.1 EncTicketPart structure from ticket.
+ *
  * Return value: Returns EncTicketPart information.
  **/
 Shishi_asn1
@@ -262,7 +270,12 @@
  * shishi_tkt_key:
  * @tkt: input variable with ticket info.
  *
- * Return value: Returns key extracted from enckdcreppart.
+ * Get key used in ticket, by looking first in EncKDCRepPart and then
+ * in EncTicketPart.  If key is already populated, it is not extracted
+ * again.
+ *
+ * Return value: Returns key extracted from EncKDCRepPart or
+ * EncTicketPart.
  **/
 Shishi_key *
 shishi_tkt_key (Shishi_tkt * tkt)
--- /home/cvs/shishi/lib/tkts.c 2004/11/09 19:12:14     1.42
+++ /home/cvs/shishi/lib/tkts.c 2004/11/09 19:39:20     1.43
@@ -1,4 +1,4 @@
-/* tkts.c      Ticket set handling.
+/* tkts.c --- Ticket set handling.
  * Copyright (C) 2002, 2003, 2004  Simon Josefsson
  *
  * This file is part of Shishi.
@@ -586,6 +586,8 @@
  * @tkt: ticket to test hints on.
  * @hint: structure with characteristics of ticket to be found.
  *
+ * Test if a ticket matches specified hints.
+ *
  * Return value: Returns 0 iff ticket fails to match given criteria.
  **/
 int





reply via email to

[Prev in Thread] Current Thread [Next in Thread]