glib2 2.0.2-x86-mingw32 → 2.0.3-x86-mingw32

data/vendor/local/share/info/gnutls.info-3

@@ -1,6 +1,7 @@
 This is gnutls.info, produced by makeinfo version 5.1 from gnutls.texi.
 
-This manual is last updated 24 April 2013 for version 3.1.11 of GnuTLS.
+This manual is last updated 10 November 2013 for version 3.2.7 of
+GnuTLS.
 
 Copyright (C) 2001-2013 Free Software Foundation, Inc.\\ Copyright (C)
 2001-2013 Nikos Mavrogiannopoulos
@@ -34,6 +35,247 @@ E.2 High level TLS API
 
 The prototypes for the following functions lie in 'gnutls/xssl.h'.
 
+xssl_client_init
+----------------
+
+ -- Function: int xssl_client_init (xssl_t * ISB, const char * HOSTNAME,
+          const char * SERVICE, gnutls_transport_ptr FD, const char *
+          PRIORITY, xssl_cred_t CRED, unsigned int * STATUS, unsigned
+          int FLAGS)
+     ISB: is a pointer to a 'xssl_t' structure.
+
+     HOSTNAME: The name of the host to connect to
+
+     SERVICE: The name of the host to connect to
+
+     FD: a socket descriptor
+
+     PRIORITY: A priority string to use (use 'NULL' for default)
+
+     CRED: A credentials structure
+
+     STATUS: An authentication failure status
+
+     FLAGS: should be zero or 'GNUTLS_SBUF_WRITE_FLUSHES'
+
+     This function initializes a 'xssl_t' structure.  If the flag
+     'GNUTLS_SBUF_WRITE_FLUSHES' is set then 'xssl_queue()' will flush
+     when the maximum data size for a record is reached.
+
+     If peer verification fails then 'GNUTLS_E_AUTH_ERROR' is returned.
+
+     *Returns:* 'GNUTLS_E_SUCCESS' on success, or an error code.
+
+     *Since:* 3.1.7
+
+xssl_cred_deinit
+----------------
+
+ -- Function: void xssl_cred_deinit (xssl_cred_t CRED)
+     CRED: is a 'xssl_cred_t' structure.
+
+     This function deinitializes a 'xssl_cred_t' structure.
+
+     *Returns:* 'GNUTLS_E_SUCCESS' on success, or an error code.
+
+     *Since:* 3.1.7
+
+xssl_cred_init
+--------------
+
+ -- Function: int xssl_cred_init (xssl_cred_t * C, unsigned VFLAGS,
+          gnutls_cinput_st * AUX, unsigned AUX_SIZE)
+     C: is a pointer to 'xssl_cred_t' structure.
+
+     VFLAGS: the requested peer verification methods
+
+     AUX: Auxilary data to input any required CA certificate etc.
+
+     AUX_SIZE: the number of the auxillary data provided
+
+     This function initializes X.509 certificates in a 'xssl_cred_t'
+     structure.
+
+     The 'ca_file' and 'crl_file' are required only if 'vflags' includes
+     'GNUTLS_VMETHOD_GIVEN_CAS' .  The 'tofu_file' may be set if
+     'GNUTLS_VMETHOD_TOFU' is specified.
+
+     *Returns:* 'GNUTLS_E_SUCCESS' on success, or an error code.
+
+     *Since:* 3.1.7
+
+xssl_deinit
+-----------
+
+ -- Function: void xssl_deinit (xssl_t SB)
+     SB: is a 'xssl_t' structure.
+
+     This function clears all buffers associated with the 'sb'
+     structure.  The GnuTLS session associated with the structure is
+     left intact.
+
+     *Since:* 3.1.7
+
+xssl_flush
+----------
+
+ -- Function: ssize_t xssl_flush (xssl_t SB)
+     SB: is a 'xssl_t' structure.
+
+     This function flushes the buffer 'sb' .  All the data stored are
+     transmitted.
+
+     This function must only be used with blocking sockets.
+
+     *Returns:* On success, the number of bytes sent, otherwise a
+     negative error code.
+
+     *Since:* 3.1.7
+
+xssl_get_session
+----------------
+
+ -- Function: gnutls_session_t xssl_get_session (xssl_t SB)
+     SB: is a 'xssl_t' structure.
+
+     *Returns:* The associated session or 'NULL' .
+
+     *Since:* 3.1.7
+
+xssl_getdelim
+-------------
+
+ -- Function: ssize_t xssl_getdelim (xssl_t SBUF, char ** LINEPTR,
+          size_t * N, int DELIMITER)
+     SBUF: - undescribed -
+
+     LINEPTR: a pointer.
+
+     N: The size of 'lineptr' .
+
+     DELIMITER: The delimiter to stop reading at.
+
+     Read up to (and including) a 'delimiter' from &sb into *LINEPTR
+     (and NUL-terminate it).  'lineptr' is a pointer returned from
+     'gnutls_malloc()' (or 'NULL' ), pointing to 'n' characters of
+     space.  It is realloc'ed as necessary.
+
+     Only fatal errors are returned by this function.
+
+     Returns the number of characters read (not including the null
+     terminator), or a negative error code on error.
+
+     *Since:* 3.1.7
+
+xssl_printf
+-----------
+
+ -- Function: ssize_t xssl_printf (xssl_t SB, const char * FMT, ...)
+     SB: is a 'xssl_t' structure.
+
+     FMT: printf-style format
+
+     ...: - undescribed -
+
+     This function allows writing to a 'xssl_t' using printf style
+     arguments.
+
+     This function must only be used with blocking sockets.
+
+     *Returns:* On success, the number of bytes written is returned,
+     otherwise an error code is returned.
+
+     *Since:* 3.1.7
+
+xssl_read
+---------
+
+ -- Function: ssize_t xssl_read (xssl_t SB, void * DATA, size_t
+          DATA_SIZE)
+     SB: is a 'xssl_t' structure.
+
+     DATA: the buffer that the data will be read into
+
+     DATA_SIZE: the number of requested bytes
+
+     This function receives data from the underlying session.  Only
+     fatal errors are returned by this function.
+
+     *Returns:* The number of bytes received and zero on EOF (for stream
+     connections) or a negative error code.
+
+     *Since:* 3.1.7
+
+xssl_server_init
+----------------
+
+ -- Function: int xssl_server_init (xssl_t * ISB, gnutls_transport_ptr
+          FD, const char * PRIORITY, xssl_cred_t CRED, unsigned int *
+          STATUS, unsigned int FLAGS)
+     ISB: is a pointer to a 'xssl_t' structure.
+
+     FD: a socket descriptor
+
+     PRIORITY: A priority string to use (use 'NULL' for default)
+
+     CRED: A credentials structure
+
+     STATUS: An authentication failure status
+
+     FLAGS: should be zero or 'GNUTLS_SBUF_WRITE_FLUSHES'
+
+     This function initializes a 'xssl_t' structure.  If the flag
+     'GNUTLS_SBUF_WRITE_FLUSHES' is set then 'xssl_queue()' will flush
+     when the maximum data size for a record is reached.
+
+     *Returns:* 'GNUTLS_E_SUCCESS' on success, or an error code.
+
+     *Since:* 3.1.7
+
+xssl_sinit
+----------
+
+ -- Function: int xssl_sinit (xssl_t * ISB, gnutls_session_t SESSION,
+          unsigned int FLAGS)
+     ISB: is a pointer to a 'xssl_t' structure.
+
+     SESSION: a GnuTLS session
+
+     FLAGS: should be zero or 'GNUTLS_SBUF_WRITE_FLUSHES'
+
+     This function initializes a 'xssl_t' structure associated with the
+     provided session.  If the flag 'GNUTLS_SBUF_WRITE_FLUSHES' is set
+     then 'xssl_queue()' will flush when the maximum data size for a
+     record is reached.
+
+     *Returns:* 'GNUTLS_E_SUCCESS' on success, or an error code.
+
+     *Since:* 3.1.7
+
+xssl_write
+----------
+
+ -- Function: ssize_t xssl_write (xssl_t SB, const void * DATA, size_t
+          DATA_SIZE)
+     SB: is a 'xssl_t' structure.
+
+     DATA: contains the data to send
+
+     DATA_SIZE: is the length of the data
+
+     This function is the buffered equivalent of 'gnutls_record_send()'
+     .  Instead of sending the data immediately the data are buffered
+     until 'xssl_queue()' is called, or if the flag
+     'GNUTLS_SBUF_WRITE_FLUSHES' is set, until the number of bytes for a
+     full record is reached.
+
+     This function must only be used with blocking sockets.
+
+     *Returns:* On success, the number of bytes written is returned,
+     otherwise an error code is returned.
+
+     *Since:* 3.1.7
+
 
 File: gnutls.info,  Node: Datagram TLS API,  Next: X509 certificate API,  Prev: High level TLS API,  Up: API reference
 
@@ -45,9 +287,9 @@ The prototypes for the following functions lie in 'gnutls/dtls.h'.
 gnutls_dtls_cookie_send
 -----------------------
 
- -- Function: int gnutls_dtls_cookie_send (gnutls_datum_t* KEY, void*
-          CLIENT_DATA, size_t CLIENT_DATA_SIZE, gnutls_dtls_prestate_st*
-          PRESTATE, gnutls_transport_ptr_t PTR, gnutls_push_func
+ -- Function: int gnutls_dtls_cookie_send (gnutls_datum_t * KEY, void *
+          CLIENT_DATA, size_t CLIENT_DATA_SIZE, gnutls_dtls_prestate_st
+          * PRESTATE, gnutls_transport_ptr_t PTR, gnutls_push_func
           PUSH_FUNC)
      KEY: is a random key to be used at cookie generation
 
@@ -68,6 +310,10 @@ gnutls_dtls_cookie_send
      allocated resources for (i.e.  'gnutls_session_t' ) is the one that
      the original incoming packet was originated from.
 
+     This function must be called at the first incoming packet, prior to
+     allocating any resources and must be succeeded by
+     'gnutls_dtls_cookie_verify()' .
+
      *Returns:* the number of bytes sent, or a negative error code.
 
      *Since:* 3.0
@@ -75,9 +321,9 @@ gnutls_dtls_cookie_send
 gnutls_dtls_cookie_verify
 -------------------------
 
- -- Function: int gnutls_dtls_cookie_verify (gnutls_datum_t* KEY, void*
-          CLIENT_DATA, size_t CLIENT_DATA_SIZE, void* _MSG, size_t
-          MSG_SIZE, gnutls_dtls_prestate_st* PRESTATE)
+ -- Function: int gnutls_dtls_cookie_verify (gnutls_datum_t * KEY, void
+          * CLIENT_DATA, size_t CLIENT_DATA_SIZE, void * _MSG, size_t
+          MSG_SIZE, gnutls_dtls_prestate_st * PRESTATE)
      KEY: is a random key to be used at cookie generation
 
      CLIENT_DATA: contains data identifying the client (i.e.  address)
@@ -90,10 +336,12 @@ gnutls_dtls_cookie_verify
 
      PRESTATE: The cookie of this client.
 
-     This function will verify an incoming message for a valid cookie.
+     This function will verify the received message for a valid cookie.
      If a valid cookie is returned then it should be associated with the
      session using 'gnutls_dtls_prestate_set()' ;
 
+     This function must be called after 'gnutls_dtls_cookie_send()' .
+
      *Returns:* 'GNUTLS_E_SUCCESS' (0) on success, or a negative error
      code.
 
@@ -108,7 +356,7 @@ gnutls_dtls_get_data_mtu
 
      This function will return the actual maximum transfer unit for
      application data.  I.e.  DTLS headers are subtracted from the
-     actual MTU.
+     actual MTU which is set using 'gnutls_dtls_set_mtu()' .
 
      *Returns:* the maximum allowed transfer unit.
 
@@ -150,7 +398,7 @@ gnutls_dtls_prestate_set
 ------------------------
 
  -- Function: void gnutls_dtls_prestate_set (gnutls_session_t SESSION,
-          gnutls_dtls_prestate_st* PRESTATE)
+          gnutls_dtls_prestate_st * PRESTATE)
      SESSION: a new session
 
      PRESTATE: contains the client's prestate
@@ -158,6 +406,10 @@ gnutls_dtls_prestate_set
      This function will associate the prestate acquired by the cookie
      authentication with the client, with the newly established session.
 
+     This functions must be called after a successful
+     'gnutls_dtls_cookie_verify()' and should be succeeded by the actual
+     DTLS handshake using 'gnutls_handshake()' .
+
      *Since:* 3.0
 
 gnutls_dtls_set_data_mtu
@@ -178,6 +430,9 @@ gnutls_dtls_set_data_mtu
      that the MTU is still sufficient to account for the new protocol
      overhead.
 
+     In most cases you only need to call 'gnutls_dtls_set_mtu()' with
+     the maximum MTU of your transport layer.
+
      *Returns:* 'GNUTLS_E_SUCCESS' (0) on success, or a negative error
      code.
 
@@ -225,6 +480,9 @@ gnutls_dtls_set_timeouts
      If the retransmission timeout is zero then the handshake will
      operate in a non-blocking way, i.e., return 'GNUTLS_E_AGAIN' .
 
+     To disable retransmissions set a 'retrans_timeout' larger than the
+     'total_timeout' .
+
      *Since:* 3.0
 
 gnutls_record_get_discarded
@@ -249,6 +507,30 @@ E.4 X.509 certificate API
 The following functions are to be used for X.509 certificate handling.
 Their prototypes lie in 'gnutls/x509.h'.
 
+gnutls_certificate_set_trust_list
+---------------------------------
+
+ -- Function: void gnutls_certificate_set_trust_list
+          (gnutls_certificate_credentials_t RES,
+          gnutls_x509_trust_list_t TLIST, unsigned FLAGS)
+     RES: is a 'gnutls_certificate_credentials_t' structure.
+
+     TLIST: is a 'gnutls_x509_trust_list_t' structure
+
+     FLAGS: must be zero
+
+     This function sets a trust list in the
+     gnutls_certificate_credentials_t structure.
+
+     Note that the 'tlist' will become part of the credentials structure
+     and must not be deallocated.  It will be automatically deallocated
+     when the 'res' structure is deinitialized.
+
+     *Returns:* 'GNUTLS_E_SUCCESS' (0) on success, or a negative error
+     code.
+
+     *Since:* 3.2.2
+
 gnutls_pkcs7_deinit
 -------------------
 
@@ -579,7 +861,7 @@ gnutls_x509_crl_get_authority_key_gn_serial
 
  -- Function: int gnutls_x509_crl_get_authority_key_gn_serial
           (gnutls_x509_crl_t CRL, unsigned int SEQ, void * ALT, size_t *
-          ALT_SIZE, unsigned int * ALT_TYPE, void* SERIAL, size_t *
+          ALT_SIZE, unsigned int * ALT_TYPE, void * SERIAL, size_t *
           SERIAL_SIZE, unsigned int * CRITICAL)
      CRL: should contain a 'gnutls_x509_crl_t' structure
 
@@ -1777,7 +2059,7 @@ gnutls_x509_crq_get_private_key_usage_period
 --------------------------------------------
 
  -- Function: int gnutls_x509_crq_get_private_key_usage_period
-          (gnutls_x509_crq_t CRQ, time_t* ACTIVATION, time_t*
+          (gnutls_x509_crq_t CRQ, time_t * ACTIVATION, time_t *
           EXPIRATION, unsigned int * CRITICAL)
      CRQ: - undescribed -
 
@@ -2000,7 +2282,7 @@ gnutls_x509_crq_set_dn
 ----------------------
 
  -- Function: int gnutls_x509_crq_set_dn (gnutls_x509_crq_t CRQ, const
-          char * DN, const char** ERR)
+          char * DN, const char ** ERR)
      CRQ: a certificate of type 'gnutls_x509_crq_t'
 
      DN: a comma separated DN string (RFC4514)
@@ -2433,7 +2715,7 @@ gnutls_x509_crt_get_authority_key_gn_serial
 
  -- Function: int gnutls_x509_crt_get_authority_key_gn_serial
           (gnutls_x509_crt_t CERT, unsigned int SEQ, void * ALT, size_t
-          * ALT_SIZE, unsigned int * ALT_TYPE, void* SERIAL, size_t *
+          * ALT_SIZE, unsigned int * ALT_TYPE, void * SERIAL, size_t *
           SERIAL_SIZE, unsigned int * CRITICAL)
      CERT: should contain a 'gnutls_x509_crt_t' structure
 
@@ -3249,7 +3531,7 @@ gnutls_x509_crt_get_policy
 --------------------------
 
  -- Function: int gnutls_x509_crt_get_policy (gnutls_x509_crt_t CRT, int
-          INDX, struct gnutls_x509_policy_st* POLICY, unsigned int *
+          INDX, struct gnutls_x509_policy_st * POLICY, unsigned int *
           CRITICAL)
      CRT: - undescribed -
 
@@ -3276,7 +3558,7 @@ gnutls_x509_crt_get_private_key_usage_period
 --------------------------------------------
 
  -- Function: int gnutls_x509_crt_get_private_key_usage_period
-          (gnutls_x509_crt_t CERT, time_t* ACTIVATION, time_t*
+          (gnutls_x509_crt_t CERT, time_t * ACTIVATION, time_t *
           EXPIRATION, unsigned int * CRITICAL)
      CERT: should contain a 'gnutls_x509_crt_t' structure
 
@@ -3936,7 +4218,7 @@ gnutls_x509_crt_set_dn
 ----------------------
 
  -- Function: int gnutls_x509_crt_set_dn (gnutls_x509_crt_t CRT, const
-          char * DN, const char** ERR)
+          char * DN, const char ** ERR)
      CRT: a certificate of type 'gnutls_x509_crt_t'
 
      DN: a comma separated DN string (RFC4514)
@@ -3988,6 +4270,8 @@ gnutls_x509_crt_set_expiration_time
      EXP_TIME: The actual time
 
      This function will set the time this Certificate will expire.
+     Setting an expiration time of (time_t)-1 will set to the no
+     well-defined expiration date value.
 
      *Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
      otherwise a negative error value.
@@ -4020,7 +4304,7 @@ gnutls_x509_crt_set_issuer_dn
 -----------------------------
 
  -- Function: int gnutls_x509_crt_set_issuer_dn (gnutls_x509_crt_t CRT,
-          const char * DN, const char** ERR)
+          const char * DN, const char ** ERR)
      CRT: a certificate of type 'gnutls_x509_crt_t'
 
      DN: a comma separated DN string (RFC4514)
@@ -4140,7 +4424,7 @@ gnutls_x509_crt_set_policy
 --------------------------
 
  -- Function: int gnutls_x509_crt_set_policy (gnutls_x509_crt_t CRT,
-          struct gnutls_x509_policy_st* POLICY, unsigned int CRITICAL)
+          struct gnutls_x509_policy_st * POLICY, unsigned int CRITICAL)
      CRT: - undescribed -
 
      POLICY: A pointer to a policy structure.
@@ -4545,7 +4829,7 @@ gnutls_x509_dn_oid_known
 gnutls_x509_dn_oid_name
 -----------------------
 
- -- Function: const char* gnutls_x509_dn_oid_name (const char * OID,
+ -- Function: const char * gnutls_x509_dn_oid_name (const char * OID,
           unsigned int FLAGS)
      OID: holds an Object Identifier in a null terminated string
 
@@ -4563,7 +4847,7 @@ gnutls_x509_policy_release
 --------------------------
 
  -- Function: void gnutls_x509_policy_release (struct
-          gnutls_x509_policy_st* POLICY)
+          gnutls_x509_policy_st * POLICY)
      POLICY: a certificate policy
 
      This function will deinitialize all memory associated with the
@@ -4717,7 +5001,7 @@ gnutls_x509_privkey_export_ecc_raw
 
  -- Function: int gnutls_x509_privkey_export_ecc_raw
           (gnutls_x509_privkey_t KEY, gnutls_ecc_curve_t * CURVE,
-          gnutls_datum_t * X, gnutls_datum_t * Y, gnutls_datum_t* K)
+          gnutls_datum_t * X, gnutls_datum_t * Y, gnutls_datum_t * K)
      KEY: a structure that holds the rsa parameters
 
      CURVE: will hold the curve
@@ -4868,6 +5152,10 @@ gnutls_x509_privkey_generate
      This function will generate a random private key.  Note that this
      function must be called on an empty private key.
 
+     Note that when generating an elliptic curve key, the curve can be
+     substituted in the place of the bits parameter using the
+     'GNUTLS_CURVE_TO_BITS()' macro.
+
      Do not set the number of bits directly, use
      'gnutls_sec_param_to_pk_bits()' .
 
@@ -4956,7 +5244,7 @@ gnutls_x509_privkey_import2
 
  -- Function: int gnutls_x509_privkey_import2 (gnutls_x509_privkey_t
           KEY, const gnutls_datum_t * DATA, gnutls_x509_crt_fmt_t
-          FORMAT, const char* PASSWORD, unsigned int FLAGS)
+          FORMAT, const char * PASSWORD, unsigned int FLAGS)
      KEY: The structure to store the parsed key
 
      DATA: The DER or PEM encoded key.
@@ -5037,7 +5325,7 @@ gnutls_x509_privkey_import_openssl
 
  -- Function: int gnutls_x509_privkey_import_openssl
           (gnutls_x509_privkey_t KEY, const gnutls_datum_t * DATA, const
-          char* PASSWORD)
+          char * PASSWORD)
      KEY: The structure to store the parsed key
 
      DATA: The DER or PEM encoded key.
@@ -5377,8 +5665,8 @@ gnutls_x509_trust_list_add_trust_file
 -------------------------------------
 
  -- Function: int gnutls_x509_trust_list_add_trust_file
-          (gnutls_x509_trust_list_t LIST, const char* CA_FILE, const
-          char* CRL_FILE, gnutls_x509_crt_fmt_t TYPE, unsigned int
+          (gnutls_x509_trust_list_t LIST, const char * CA_FILE, const
+          char * CRL_FILE, gnutls_x509_crt_fmt_t TYPE, unsigned int
           TL_FLAGS, unsigned int TL_VFLAGS)
      LIST: The structure of the list
 
@@ -5505,7 +5793,7 @@ gnutls_x509_trust_list_remove_trust_file
 ----------------------------------------
 
  -- Function: int gnutls_x509_trust_list_remove_trust_file
-          (gnutls_x509_trust_list_t LIST, const char* CA_FILE,
+          (gnutls_x509_trust_list_t LIST, const char * CA_FILE,
           gnutls_x509_crt_fmt_t TYPE)
      LIST: The structure of the list
 
@@ -5565,9 +5853,6 @@ gnutls_x509_trust_list_verify_crt
      its status.  The 'verify' parameter will hold an OR'ed sequence of
      'gnutls_certificate_status_t' flags.
 
-     *Limitation:* Pathlen constraints or key usage flags are not
-     consulted.
-
      *Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
      otherwise a negative error value.