Blame doc/compat-api.texi

Packit Service 4684c1
Packit Service 4684c1
@subheading gnutls_compression_get
Packit Service 4684c1
@anchor{gnutls_compression_get}
Packit Service 4684c1
@deftypefun {gnutls_compression_method_t} {gnutls_compression_get} (gnutls_session_t @var{session})
Packit Service 4684c1
@var{session}: is a @code{gnutls_session_t}  type.
Packit Service 4684c1
Packit Service 4684c1
Get the currently used compression algorithm.
Packit Service 4684c1
Packit Service 4684c1
@strong{Returns:} the currently used compression method, a
Packit Service 4684c1
@code{gnutls_compression_method_t}  value.
Packit Service 4684c1
@end deftypefun
Packit Service 4684c1
Packit Service 4684c1
@subheading gnutls_compression_get_id
Packit Service 4684c1
@anchor{gnutls_compression_get_id}
Packit Service 4684c1
@deftypefun {gnutls_compression_method_t} {gnutls_compression_get_id} (const char * @var{name})
Packit Service 4684c1
@var{name}: is a compression method name
Packit Service 4684c1
Packit Service 4684c1
The names are compared in a case insensitive way.
Packit Service 4684c1
Packit Service 4684c1
@strong{Returns:} an id of the specified in a string compression method, or
Packit Service 4684c1
@code{GNUTLS_COMP_UNKNOWN}  on error.
Packit Service 4684c1
@end deftypefun
Packit Service 4684c1
Packit Service 4684c1
@subheading gnutls_compression_get_name
Packit Service 4684c1
@anchor{gnutls_compression_get_name}
Packit Service 4684c1
@deftypefun {const char *} {gnutls_compression_get_name} (gnutls_compression_method_t      @var{algorithm})
Packit Service 4684c1
@var{algorithm}: is a Compression algorithm
Packit Service 4684c1
Packit Service 4684c1
Convert a @code{gnutls_compression_method_t}  value to a string.
Packit Service 4684c1
Packit Service 4684c1
@strong{Returns:} a pointer to a string that contains the name of the
Packit Service 4684c1
specified compression algorithm, or @code{NULL} .
Packit Service 4684c1
@end deftypefun
Packit Service 4684c1
Packit Service 4684c1
@subheading gnutls_compression_list
Packit Service 4684c1
@anchor{gnutls_compression_list}
Packit Service 4684c1
@deftypefun {const gnutls_compression_method_t *} {gnutls_compression_list} ( @var{void})
Packit Service 4684c1
Packit Service 4684c1
Get a list of compression methods.
Packit Service 4684c1
Packit Service 4684c1
@strong{Returns:} a zero-terminated list of @code{gnutls_compression_method_t} 
Packit Service 4684c1
integers indicating the available compression methods.
Packit Service 4684c1
@end deftypefun
Packit Service 4684c1
Packit Service 4684c1
@subheading gnutls_global_set_mem_functions
Packit Service 4684c1
@anchor{gnutls_global_set_mem_functions}
Packit Service 4684c1
@deftypefun {void} {gnutls_global_set_mem_functions} (gnutls_alloc_function @var{alloc_func}, gnutls_alloc_function @var{secure_alloc_func}, gnutls_is_secure_function @var{is_secure_func}, gnutls_realloc_function @var{realloc_func}, gnutls_free_function @var{free_func})
Packit Service 4684c1
@var{alloc_func}: it's the default memory allocation function. Like @code{malloc()} .
Packit Service 4684c1
Packit Service 4684c1
@var{secure_alloc_func}: This is the memory allocation function that will be used for sensitive data.
Packit Service 4684c1
Packit Service 4684c1
@var{is_secure_func}: a function that returns 0 if the memory given is not secure. May be NULL.
Packit Service 4684c1
Packit Service 4684c1
@var{realloc_func}: A realloc function
Packit Service 4684c1
Packit Service 4684c1
@var{free_func}: The function that frees allocated data. Must accept a NULL pointer.
Packit Service 4684c1
Packit Service 4684c1
Packit Service 4684c1
@strong{Deprecated:} since 3.3.0 it is no longer possible to replace the internally used 
Packit Service 4684c1
memory allocation functions
Packit Service 4684c1
Packit Service 4684c1
This is the function where you set the memory allocation functions
Packit Service 4684c1
gnutls is going to use. By default the libc's allocation functions
Packit Service 4684c1
(@code{malloc()} , @code{free()} ), are used by gnutls, to allocate both sensitive
Packit Service 4684c1
and not sensitive data.  This function is provided to set the
Packit Service 4684c1
memory allocation functions to something other than the defaults
Packit Service 4684c1
Packit Service 4684c1
This function must be called before @code{gnutls_global_init()}  is called.
Packit Service 4684c1
This function is not thread safe.
Packit Service 4684c1
@end deftypefun
Packit Service 4684c1
Packit Service 4684c1
@subheading gnutls_openpgp_privkey_sign_hash
Packit Service 4684c1
@anchor{gnutls_openpgp_privkey_sign_hash}
Packit Service 4684c1
@deftypefun {int} {gnutls_openpgp_privkey_sign_hash} (gnutls_openpgp_privkey_t @var{key}, const gnutls_datum_t * @var{hash}, gnutls_datum_t * @var{signature})
Packit Service 4684c1
@var{key}: Holds the key
Packit Service 4684c1
Packit Service 4684c1
@var{hash}: holds the data to be signed
Packit Service 4684c1
Packit Service 4684c1
@var{signature}: will contain newly allocated signature
Packit Service 4684c1
Packit Service 4684c1
This function is no-op.
Packit Service 4684c1
Packit Service 4684c1
@strong{Returns:} @code{GNUTLS_E_UNIMPLEMENTED_FEATURE} .
Packit Service 4684c1
@end deftypefun
Packit Service 4684c1
Packit Service 4684c1
@subheading gnutls_priority_compression_list
Packit Service 4684c1
@anchor{gnutls_priority_compression_list}
Packit Service 4684c1
@deftypefun {int} {gnutls_priority_compression_list} (gnutls_priority_t @var{pcache}, const unsigned int ** @var{list})
Packit Service 4684c1
@var{pcache}: is a @code{gnutls_prioritity_t}  type.
Packit Service 4684c1
Packit Service 4684c1
@var{list}: will point to an integer list
Packit Service 4684c1
Packit Service 4684c1
Get a list of available compression method in the priority
Packit Service 4684c1
structure.
Packit Service 4684c1
Packit Service 4684c1
@strong{Returns:} the number of methods, or an error code.
Packit Service 4684c1
Packit Service 4684c1
@strong{Since:} 3.0
Packit Service 4684c1
@end deftypefun
Packit Service 4684c1
Packit Service 4684c1
@subheading gnutls_x509_crt_get_preferred_hash_algorithm
Packit Service 4684c1
@anchor{gnutls_x509_crt_get_preferred_hash_algorithm}
Packit Service 4684c1
@deftypefun {int} {gnutls_x509_crt_get_preferred_hash_algorithm} (gnutls_x509_crt_t @var{crt}, gnutls_digest_algorithm_t *           @var{hash}, unsigned int * @var{mand})
Packit Service 4684c1
@var{crt}: Holds the certificate
Packit Service 4684c1
Packit Service 4684c1
@var{hash}: The result of the call with the hash algorithm used for signature
Packit Service 4684c1
Packit Service 4684c1
@var{mand}: If non-zero it means that the algorithm MUST use this hash. May be @code{NULL} .
Packit Service 4684c1
Packit Service 4684c1
This function will read the certificate and return the appropriate digest
Packit Service 4684c1
algorithm to use for signing with this certificate. Some certificates (i.e.
Packit Service 4684c1
DSA might not be able to sign without the preferred algorithm).
Packit Service 4684c1
Packit Service 4684c1
@strong{Deprecated:} Please use @code{gnutls_pubkey_get_preferred_hash_algorithm()} .
Packit Service 4684c1
Packit Service 4684c1
@strong{Returns:} the 0 if the hash algorithm is found. A negative error code is
Packit Service 4684c1
returned on error.
Packit Service 4684c1
Packit Service 4684c1
@strong{Since:} 2.12.0
Packit Service 4684c1
@end deftypefun
Packit Service 4684c1
Packit Service 4684c1
@subheading gnutls_x509_privkey_sign_hash
Packit Service 4684c1
@anchor{gnutls_x509_privkey_sign_hash}
Packit Service 4684c1
@deftypefun {int} {gnutls_x509_privkey_sign_hash} (gnutls_x509_privkey_t @var{key}, const gnutls_datum_t * @var{hash}, gnutls_datum_t * @var{signature})
Packit Service 4684c1
@var{key}: a key
Packit Service 4684c1
Packit Service 4684c1
@var{hash}: holds the data to be signed
Packit Service 4684c1
Packit Service 4684c1
@var{signature}: will contain newly allocated signature
Packit Service 4684c1
Packit Service 4684c1
This function will sign the given hash using the private key. Do not
Packit Service 4684c1
use this function directly unless you know what it is. Typical signing
Packit Service 4684c1
requires the data to be hashed and stored in special formats 
Packit Service 4684c1
(e.g. BER Digest-Info for RSA).
Packit Service 4684c1
Packit Service 4684c1
This API is provided only for backwards compatibility, and thus
Packit Service 4684c1
restricted to RSA, DSA and ECDSA key types. For other key types please
Packit Service 4684c1
use @code{gnutls_privkey_sign_hash()}  and @code{gnutls_privkey_sign_data()} .
Packit Service 4684c1
Packit Service 4684c1
@strong{Returns:} On success, @code{GNUTLS_E_SUCCESS}  (0) is returned, otherwise a
Packit Service 4684c1
negative error value.
Packit Service 4684c1
Packit Service 4684c1
Deprecated in: 2.12.0
Packit Service 4684c1
@end deftypefun
Packit Service 4684c1