This manual is last updated 2 May 2007 for version 1.7.8.p11.1 of GNU TLS.
Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled “GNU Free Documentation License”.
This document tries to demonstrate and explain the GnuTLS library API. A brief introduction to the protocols and the technology involved, is also included so that an application programmer can better understand the GnuTLS purpose and actual offerings. Even if GnuTLS is a typical library software, it operates over several security and cryptographic protocols, which require the programmer to make careful and correct usage of them, otherwise he risks to offer just a false sense of security. Security and the network security terms are very general terms even for computer software thus cannot be easily restricted to a single cryptographic library. For that reason, do not consider a program secure just because it uses GnuTLS; there are several ways to compromise a program or a communication line and GnuTLS only helps with some of them.
Although this document tries to be self contained, basic network programming and PKI knowlegde is assumed in most of it. A good introduction to networking can be found in [STEVENS] (see Bibliography) and for Public Key Infrastructure in [GUTPKI] (see Bibliography).
Updated versions of the GnuTLS software and this document will be available from http://www.gnutls.org/ and http://www.gnu.org/software/gnutls/.
In brief GnuTLS can be described as a library which offers an API to access secure communication protocols. These protocols provide privacy over insecure lines, and were designed to prevent eavesdropping, tampering, or message forgery.
Technically GnuTLS is a portable ANSI C based library which implements the TLS 1.1 and SSL 3.0 protocols (See Introduction to TLS, for a more detailed description of the protocols), accompanied with the required framework for authentication and public key infrastructure. The library is available under the GNU Lesser GPL license1. Important features of the GnuTLS library include:
Additionally GnuTLS provides a limited emulation API for the widely used OpenSSL2 library, to ease integration with existing applications.
GnuTLS consists of three independent parts, namely the “TLS protocol part”, the “Certificate part”, and the “Crypto backend” part. The `TLS protocol part' is the actual protocol implementation, and is entirely implemented within the GnuTLS library. The `Certificate part' consists of the certificate parsing, and verification functions which is partially implemented in the GnuTLS library. The Libtasn13, a library which offers ASN.1 parsing capabilities, is used for the X.509 certificate parsing functions, and Opencdk4 is used for the OpenPGP key support in GnuTLS. The “Crypto backend” is provided by the Libgcrypt5 library.
In order to ease integration in embedded systems, parts of the GnuTLS library can be disabled at compile time. That way a small library, with the required features, can be generated.
A brief description of how GnuTLS works internally is shown at the figure below. This section may be easier to understand after having seen the examples (see examples).
As shown in the figure, there is a read-only global state that is initialized once by the global initialization function. This global structure, among others, contains the memory allocation functions used, and some structures needed for the ASN.1 parser. This structure is never modified by any GnuTLS function, except for the deinitialization function which frees all memory allocated in the global structure and is called after the program has permanently finished using GnuTLS.
The credentials structure is used by some authentication methods, such as certificate authentication (see Certificate Authentication). A credentials structure may contain certificates, private keys, temporary parameters for diffie hellman or RSA key exchange, and other stuff that may be shared between several TLS sessions.
This structure should be initialized using the appropriate initialization functions. For example an application which uses certificate authentication would probably initialize the credentials, using the appropriate functions, and put its trusted certificates in this structure. The next step is to associate the credentials structure with each TLS session.
A GnuTLS session contains all the required stuff for a session to handle one secure connection. This session calls directly to the transport layer functions, in order to communicate with the peer. Every session has a unique session ID shared with the peer.
Since TLS sessions can be resumed, servers would probably need a database backend to hold the session's parameters. Every GnuTLS session after a successful handshake calls the appropriate backend function (See resume, for information on initialization) to store the newly negotiated session. The session database is examined by the server just after having received the client hello6, and if the session ID sent by the client, matches a stored session, the stored session will be retrieved, and the new session will be a resumed one, and will share the same session ID with the previous one.
In GnuTLS most functions return an integer type as a result. In almost all cases a zero or a positive number means success, and a negative number indicates failure, or a situation that some action has to be taken. Thus negative error codes may be fatal or not.
Fatal errors terminate the connection immediately and further sends
and receives will be disallowed. An example of a fatal error code is
GNUTLS_E_DECRYPTION_FAILED. Non-fatal errors may warn about
something, i.e., a warning alert was received, or indicate the some
action has to be taken. This is the case with the error code
GNUTLS_E_REHANDSHAKE returned by gnutls_record_recv.
This error code indicates that the server requests a re-handshake. The
client may ignore this request, or may reply with an alert. You can
test if an error code is a fatal one by using the
gnutls_error_is_fatal.
If any non fatal errors, that require an action, are to be returned by a function, these error codes will be documented in the function's reference. See Error Codes, for all the error codes.
GnuTLS internally handles heap allocated objects differently, depending on the sensitivity of the data they contain. However for performance reasons, the default memory functions do not overwrite sensitive data from memory, nor protect such objects from being written to the swap. In order to change the default behavior the gnutls_global_set_mem_functions function is available which can be used to set other memory handlers than the defaults.
The Libgcrypt library on which GnuTLS depends, has such secure memory allocation functions available. These should be used in cases where even the system's swap memory is not considered secure. See the documentation of Libgcrypt for more information.
There are several cases where GnuTLS may need some out of band input from your program. This is now implemented using some callback functions, which your program is expected to register.
An example of this type of functions are the push and pull callbacks which are used to specify the functions that will retrieve and send data to the transport layer.
Other callback functions such as the one set by gnutls_srp_set_server_credentials_function, may require more complicated input, including data to be allocated. These callbacks should allocate and free memory using the functions shown below.
TLS stands for “Transport Layer Security” and is the successor of SSL, the Secure Sockets Layer protocol [SSL3] (see Bibliography) designed by Netscape. TLS is an Internet protocol, defined by IETF7, described in RFC 2246 and also in [RESCOLA] (see Bibliography). The protocol provides confidentiality, and authentication layers over any reliable transport layer. The description, below, refers to TLS 1.0 but also applies to TLS 1.1 [RFC4346] (see Bibliography) and SSL 3.0, since the differences of these protocols are minor. Older protocols such as SSL 2.0 are not discussed nor implemented in GnuTLS since they are not considered secure today.
TLS is a layered protocol, and consists of the Record Protocol, the Handshake Protocol and the Alert Protocol. The Record Protocol is to serve all other protocols and is above the transport layer. The Record protocol offers symmetric encryption, data authenticity, and optionally compression.
The Alert protocol offers some signaling to the other protocols. It can help informing the peer for the cause of failures and other error conditions. See The Alert Protocol, for more information. The alert protocol is above the record protocol.
The Handshake protocol is responsible for the security parameters' negotiation, the initial key exchange and authentication. See The Handshake Protocol, for more information about the handshake protocol. The protocol layering in TLS is shown in the figure below.
TLS is not limited to one transport layer, it can be used above any transport layer, as long as it is a reliable one. A set of functions is provided and their purpose is to load to GnuTLS the required callbacks to access the transport layer.
These functions accept a callback function as a parameter. The
callback functions should return the number of bytes written, or -1 on
error and should set errno appropriately.
In some environments, setting errno is unreliable, for example
Windows have several errno variables in different CRTs, or it may be
that errno is not a thread-local variable. If this is a concern to
you, call gnutls_transport_set_errno with the intended errno
value instead of setting errno directly.
GnuTLS currently only interprets the EINTR and EAGAIN errno
values and returns the corresponding GnuTLS error codes
GNUTLS_E_INTERRUPTED and GNUTLS_E_AGAIN. These values
are usually returned by interrupted system calls, or when non blocking
IO is used. All GnuTLS functions can be resumed (called
again), if any of these error codes is returned. The error codes
above refer to the system call, not the GnuTLS function,
since signals do not interrupt GnuTLS' functions.
For non blocking sockets or other custom made pull/push functions the gnutls_transport_set_lowat must be called, with a zero low water mark value.
By default, if the transport functions are not set, GnuTLS
will use the Berkeley Sockets functions. In this case
GnuTLS will use some hacks in order for select to
work, thus making it easy to add TLS support to existing
TCP/IP servers.
The Record protocol is the secure communications provider. Its purpose is to encrypt, authenticate and —optionally— compress packets. The following functions are available:
As you may have already noticed, the functions which access the Record protocol, are quite limited, given the importance of this protocol in TLS. This is because the Record protocol's parameters are all set by the Handshake protocol.
The Record protocol initially starts with NULL parameters, which means no encryption, and no MAC is used. Encryption and authentication begin just after the handshake protocol has finished.
Confidentiality in the record layer is achieved by using symmetric
block encryption algorithms like 3DES, AES8, or stream algorithms like
ARCFOUR_1289. Ciphers are encryption algorithms that use a single, secret,
key to encrypt and decrypt data. Block algorithms in TLS also provide
protection against statistical analysis of the data. Thus, if you're
using the TLS protocol, a random number of blocks will be
appended to data, to prevent eavesdroppers from guessing the actual
data size.
Supported cipher algorithms:
3DES_CBC3DES_CBC is the DES block cipher algorithm used with triple
encryption (EDE). Has 64 bits block size and is used in CBC mode.
ARCFOUR_128ARCFOUR_40AES_CBCSupported MAC algorithms:
MAC_MD5MAC_SHAThe TLS record layer also supports compression. The algorithms implemented in GnuTLS can be found in the table below. All the algorithms except for DEFLATE which is referenced in [RFC3749] (see Bibliography), should be considered as GnuTLS' extensions10, and should be advertised only when the peer is known to have a compliant client, to avoid interoperability problems.
The included algorithms perform really good when text, or other compressible data are to be transfered, but offer nothing on already compressed data, such as compressed images, zipped archives etc. These compression algorithms, may be useful in high bandwidth TLS tunnels, and in cases where network usage has to be minimized. As a drawback, compression increases latency.
The record layer compression in GnuTLS is implemented based on the proposal [RFC3749] (see Bibliography). The supported compression algorithms are:
DEFLATELZOSome weaknesses that may affect the security of the Record layer have been found in TLS 1.0 protocol. These weaknesses can be exploited by active attackers, and exploit the facts that
Those weaknesses were solved in TLS 1.1 [RFC4346] (see Bibliography) which is implemented in GnuTLS. For a detailed discussion see the archives of the TLS Working Group mailing list and the paper [CBCATT] (see Bibliography).
The Alert protocol is there to allow signals to be sent between peers.
These signals are mostly used to inform the peer about the cause of a
protocol failure. Some of these signals are used internally by the
protocol and the application protocol does not have to cope with them
(see GNUTLS_A_CLOSE_NOTIFY), and others refer to the
application protocol solely (see GNUTLS_A_USER_CANCELLED). An
alert signal includes a level indication which may be either fatal or
warning. Fatal alerts always terminate the current connection, and
prevent future renegotiations using the current session ID.
The alert messages are protected by the record protocol, thus the information that is included does not leak. You must take extreme care for the alert information not to leak to a possible attacker, via public log files etc.
The Handshake protocol is responsible for the ciphersuite negotiation, the initial key exchange, and the authentication of the two peers. This is fully controlled by the application layer, thus your program has to set up the required parameters. Available functions to control the handshake protocol include:
The Handshake Protocol of TLS negotiates cipher suites of
the form TLS_DHE_RSA_WITH_3DES_CBC_SHA. The usual cipher
suites contain these parameters:
DHE_RSA in the example.
3DES_CBC in this example.
MAC_SHA is used in the above example.
The cipher suite negotiated in the handshake protocol will affect the Record Protocol, by enabling encryption and data authentication. Note that you should not over rely on TLS to negotiate the strongest available cipher suite. Do not enable ciphers and algorithms that you consider weak.
The priority functions, dicussed above, allow the application layer to enable and set priorities on the individual ciphers. It may imply that all combinations of ciphersuites are allowed, but this is not true. For several reasons, not discussed here, some combinations were not defined in the TLS protocol. The supported ciphersuites are shown in ciphersuites.
In the case of ciphersuites that use certificate authentication, the authentication of the client is optional in TLS. A server may request a certificate from the client — using the gnutls_certificate_server_set_request function. If a certificate is to be requested from the client during the handshake, the server will send a certificate request message that contains a list of acceptable certificate signers. In GnuTLS the certificate signers list is constructed using the trusted Certificate Authorities by the server. That is the ones set using
Sending of the names of the CAs can be controlled using gnutls_certificate_send_x509_rdn_sequence. The client, then, may send a certificate, signed by one of the server's acceptable signers.
The gnutls_handshake function, is expensive since a lot of calculations are performed. In order to support many fast connections to the same server a client may use session resuming. Session resuming is a feature of the TLS protocol which allows a client to connect to a server, after a successful handshake, without the expensive calculations. This is achieved by using the previously established keys. GnuTLS supports this feature, and the example (see ex:resume-client) illustrates a typical use of it.
Keep in mind that sessions are expired after some time, for security reasons, thus it may be normal for a server not to resume a session even if you requested that. Also note that you must enable, using the priority functions, at least the algorithms used in the last session.
The resuming capability, mostly in the server side, is one of the problems of a thread-safe TLS implementations. The problem is that all threads must share information in order to be able to resume sessions. The gnutls approach is, in case of a client, to leave all the burden of resuming to the client. I.e., copy and keep the necessary parameters. See the functions:
The server side is different. A server has to specify some callback functions which store, retrieve and delete session data. These can be registered with:
It might also be useful to be able to check for expired sessions in order to remove them, and save space. The function gnutls_db_check_entry is provided for that reason.
A number of extensions to the TLS protocol have been proposed mainly in [TLSEXT] (see Bibliography). The extensions supported in GnuTLS are:
and they will be discussed in the subsections that follow.
This extension allows a TLS implementation to negotiate a smaller value for record packet maximum length. This extension may be useful to clients with constrained capabilities. See the gnutls_record_set_max_size and the gnutls_record_get_max_size functions.
A common problem in HTTPS servers is the fact that the TLS protocol is not aware of the hostname that a client connects to, when the handshake procedure begins. For that reason the TLS server has no way to know which certificate to send.
This extension solves that problem within the TLS protocol, and allows a client to send the HTTP hostname before the handshake begins within the first handshake packet. The functions gnutls_server_name_set and gnutls_server_name_get can be used to enable this extension, or to retrieve the name sent by a client.
One of the initial decisions in the GnuTLS development was to implement the known security protocols for the transport layer. Initially TLS 1.0 was implemented since it was the latest at that time, and was considered to be the most advanced in security properties. Later the SSL 3.0 protocol was implemented since it is still the only protocol supported by several servers and there are no serious security vulnerabilities known.
One question that may arise is why we didn't implement SSL 2.0 in the library. There are several reasons, most important being that it has serious security flaws, unacceptable for a modern security library. Other than that, this protocol is barely used by anyone these days since it has been deprecated since 1996. The security problems in SSL 2.0 include:
Other protocols such as Microsoft's PCT 1 and PCT 2 were not implemented because they were also abandoned and deprecated by SSL 3.0 and later TLS 1.0.
The TLS protocol provides confidentiality and encryption, but also offers authentication, which is a prerequisite for a secure connection. The available authentication methods in GnuTLS are:
X.509 certificates contain the public parameters, of a public key algorithm, and an authority's signature, which proves the authenticity of the parameters. See The X.509 trust model, for more information on X.509 protocols.
OpenPGP keys also contain public parameters of a public key algorithm, and signatures from several other parties. Depending on whether a signer is trusted the key is considered trusted or not. GnuTLS's OpenPGP authentication implementation is based on the [TLSPGP] (see Bibliography) proposal.
See The OpenPGP trust model, for more information about the OpenPGP trust model. For a more detailed introduction to OpenPGP and GnuPG see [GPGH] (see Bibliography).
In GnuTLS both the OpenPGP and X.509 certificates are part of the certificate authentication and thus are handled using a common API.
When using certificates the server is required to have at least one certificate and private key pair. A client may or may not have such a pair. The certificate and key pair should be loaded, before any TLS session is initialized, in a certificate credentials structure. This should be done by using gnutls_certificate_set_x509_key_file or gnutls_certificate_set_openpgp_key_file depending on the certificate type. In the X.509 case, the functions will also accept and use a certificate list that leads to a trusted authority. The certificate list must be ordered in such way that every certificate certifies the one before it. The trusted authority's certificate need not to be included, since the peer should possess it already.
As an alternative, a callback may be used so the server or the client specify the certificate and the key at the handshake time. That callback can be set using the functions:
Certificate verification is possible by loading the trusted authorities into the credentials structure by using gnutls_certificate_set_x509_trust_file or gnutls_certificate_set_openpgp_keyring_file for openpgp keys. Note however that the peer's certificate is not automatically verified, you should call gnutls_certificate_verify_peers2, after a successful handshake, to verify the signatures of the certificate. An alternative way, which reports a more detailed verification output, is to use gnutls_certificate_get_peers to obtain the raw certificate of the peer and verify it using the functions discussed in The X.509 trust model.
In a handshake, the negotiated cipher suite depends on the
certificate's parameters, so not all key exchange methods will be
available with some certificates. GnuTLS will disable
ciphersuites that are not compatible with the key, or the enabled
authentication methods. For example keys marked as sign-only, will
not be able to access the plain RSA ciphersuites, but only the
DHE_RSA ones. It is recommended not to use RSA keys for both
signing and encryption. If possible use the same key for the
DHE_RSA and RSA_EXPORT ciphersuites, which use signing,
and a different key for the plain RSA ciphersuites, which use
encryption. All the key exchange methods shown below are available in
certificate authentication.
Note that the DHE key exchange methods are generally
slower12 than plain RSA and require Diffie
Hellman parameters to be generated and associated with a credentials
structure, by the server. The RSA-EXPORT method also requires 512 bit RSA
parameters, that should also be generated and associated with the
credentials structure. See the functions:
Sometimes in order to avoid bottlenecks in programs it is usefull to store
and read parameters from formats that can be generated by external programs such
as certtool. This is possible with GnuTLS by using the following
functions:
Key exchange algorithms for OpenPGP and X.509 certificates:
RSA:RSA_EXPORT:DHE_RSA:DHE_DSS:The anonymous key exchange performs encryption but there is no indication of the identity of the peer. This kind of authentication is vulnerable to a man in the middle attack, but this protocol can be used even if there is no prior communication and trusted parties with the peer, or when full anonymity is required. Unless really required, do not use anonymous authentication. Available key exchange methods are shown below.
Note that the key exchange methods for anonymous authentication require Diffie Hellman parameters to be generated by the server and associated with an anonymous credentials structure.
Supported anonymous key exchange algorithms:
ANON_DH:Authentication via the Secure Remote Password protocol, SRP13, is supported. The SRP key exchange is an extension to the TLS protocol, and it is a password based authentication (unlike X.509 or OpenPGP that use certificates). The two peers can be identified using a single password, or there can be combinations where the client is authenticated using SRP and the server using a certificate.
The advantage of SRP authentication, over other proposed secure password authentication schemes, is that SRP does not require the server to hold the user's password. This kind of protection is similar to the one used traditionally in the UNIX /etc/passwd file, where the contents of this file did not cause harm to the system security if they were revealed. The SRP needs instead of the plain password something called a verifier, which is calculated using the user's password, and if stolen cannot be used to impersonate the user. Check [TOMSRP] (see Bibliography) for a detailed description of the SRP protocol and the Stanford SRP libraries, which includes a PAM module that synchronizes the system's users passwords with the SRP password files. That way SRP authentication could be used for all the system's users.
The implementation in GnuTLS is based on paper [TLSSRP] (see Bibliography). The supported SRP key exchange methods are:
SRP:SRP_DSS:SRP_RSA:If clients supporting SRP know the username and password before the connection, should initialize the client credentials and call the function gnutls_srp_set_client_credentials. Alternatively they could specify a callback function by using the function gnutls_srp_set_client_credentials_function. This has the advantage that allows probing the server for SRP support. In that case the callback function will be called twice per handshake. The first time is before the ciphersuite is negotiated, and if the callback returns a negative error code, the callback will be called again if SRP has been negotiated. This uses a special TLS-SRP handshake idiom in order to avoid, in interactive applications, to ask the user for SRP password and username if the server does not negotiate an SRP ciphersuite.
In server side the default behaviour of GnuTLS is to read the usernames and SRP verifiers from password files. These password files are the ones used by the Stanford srp libraries and can be specified using the gnutls_srp_set_server_credentials_file. If a different password file format is to be used, then the function gnutls_srp_set_server_credentials_function, should be called, in order to set an appropriate callback.
Some helper functions such as
are included in GnuTLS, and can be used to generate and maintain SRP verifiers and password files. A program to manipulate the required parameters for SRP authentication is also included. See srptool, for more information.
Authentication using Pre-shared keys is a method to authenticate using usernames and binary keys. This protocol avoids making use of public key infrastructure and expensive calculations, thus it is suitable for constraint clients.
The implementation in GnuTLS is based on paper [TLSPSK] (see Bibliography). The supported PSK key exchange methods are:
PSK:DHE-PSK:Clients supporting PSK should supply the username and key before the connection to the client credentials by calling the function gnutls_psk_set_client_credentials. Alternatively they could specify a callback function by using the function gnutls_psk_set_client_credentials_function. This has the advantage that the callback will be called only if PSK has been negotiated.
In server side the default behaviour of GnuTLS is to read the usernames and PSK keys from a password file. The password file should contain usernames and keys in hexadecimal format. The name of the password file can be stored to the credentials structure by calling gnutls_psk_set_server_credentials_file. If a different password file format is to be used, then the function gnutls_psk_set_server_credentials_function, should be used instead.
Some helper functions such as:
are included in GnuTLS, and may be used to generate and maintain PSK keys.
In GnuTLS every key exchange method is associated with a credentials type. So in order to enable to enable a specific method, the corresponding credentials type should be initialized and set using gnutls_credentials_set. A mapping is shown below.
Key exchange algorithms and the corresponding credential types:
| Key exchange | Client credentials | Server credentials
|
|---|---|---|
KX_RSA
| ||
KX_DHE_RSA
| ||
KX_DHE_DSS
| ||
KX_RSA_EXPORT
| CRD_CERTIFICATE
| CRD_CERTIFICATE
|
KX_SRP_RSA
| CRD_SRP
| CRD_SRP
|
KX_SRP_DSS
| CRD_CERTIFICATE
| |
KX_SRP
| CRD_SRP
| CRD_SRP
|
KX_ANON_DH
| CRD_ANON
| CRD_ANON
|
KX_PSK
| CRD_PSK
| CRD_PSK
|
Several parameters such as the ones used for Diffie-Hellman
authentication are stored within the credentials structures, so all
sessions can access them. Those parameters are stored in structures
such as gnutls_dh_params_t and gnutls_rsa_params_t, and
functions like gnutls_certificate_set_dh_params and
gnutls_certificate_set_rsa_export_params can be used to
associate those parameters with the given credentials structure.
Since those parameters need to be renewed from time to time and a global structure such as the credentials, may not be easy to modify since it is accessible by all sessions, an alternative interface is available using a callback function. This can be set using the gnutls_certificate_set_params_function. An example is shown below.
#include <gnutls.h>
gnutls_rsa_params_t rsa_params;
gnutls_dh_params_t dh_params;
/* This function will be called once a session requests DH
* or RSA parameters. The parameters returned (if any) will
* be used for the first handshake only.
*/
static int get_params( gnutls_session_t session,
gnutls_params_type_t type,
gnutls_params_st *st)
{
if (type == GNUTLS_PARAMS_RSA_EXPORT)
st->params.rsa_export = rsa_params;
else if (type == GNUTLS_PARAMS_DH)
st->params.dh = dh_params;
else return -1;
st->type = type;
/* do not deinitialize those parameters.
*/
st->deinit = 0;
return 0;
}
int main()
{
gnutls_certificate_credentials_t cert_cred;
initialize_params();
/* ...
*/
gnutls_certificate_set_params_function( cert_cred, get_params);
}
The X.509 protocols rely on a hierarchical trust model. In this trust model Certification Authorities (CAs) are used to certify entities. Usually more than one certification authorities exist, and certification authorities may certify other authorities to issue certificates as well, following a hierarchical model.
One needs to trust one or more CAs for his secure communications. In that case only the certificates issued by the trusted authorities are acceptable. See the figure above for a typical example. The API for handling X.509 certificates is described at section sec:x509api. Some examples are listed below.
An X.509 certificate usually contains information about the certificate holder, the signer, a unique serial number, expiration dates and some other fields [RFC3280] (see Bibliography) as shown in the table below.
version:serialNumber:issuer:validity:subject:extensions:The certificate's subject or issuer name is not just a single string. It is a Distinguished name and in the ASN.1 notation is a sequence of several object IDs with their corresponding values. Some of available OIDs to be used in an X.509 distinguished name are defined in gnutls/x509.h.
The Version field in a certificate has values either 1 or 3 for version 3 certificates. Version 1 certificates do not support the extensions field so it is not possible to distinguish a CA from a person, thus their usage should be avoided.
The validity dates are there to indicate the date that the specific certificate was activated and the date the certificate's key would be considered invalid.
Certificate extensions are there to include information about the certificate's subject that did not fit in the typical certificate fields. Those may be e-mail addresses, flags that indicate whether the belongs to a CA etc. All the supported X.509 version 3 extensions are shown in the table below.
subject key id (2.5.29.14):authority key id (2.5.29.35):subject alternative name (2.5.29.17):key usage (2.5.29.15):extended key usage (2.5.29.37):basic constraints (2.5.29.19):CRL distribution points (2.5.29.31):Proxy Certification Information (1.3.6.1.5.5.7.1.14):In GnuTLS the X.509 certificate structures are handled using
the gnutls_x509_crt_t type and the corresponding private keys
with the gnutls_x509_privkey_t type. All the available
functions for X.509 certificate handling have their prototypes in
gnutls/x509.h. An example program to demonstrate the X.509
parsing capabilities can be found at section ex:x509-info.
Verifying certificate paths is important in X.509 authentication. For
this purpose the function gnutls_x509_crt_verify is
provided. The output of this function is the bitwise OR of the
elements of the gnutls_certificate_status_t enumeration. A
detailed description of these elements can be found in figure below.
The function gnutls_certificate_verify_peers2 is equivalent to
the previous one, and will verify the peer's certificate in a TLS
session.
CERT_INVALID:CERT_REVOKED:CERT_SIGNER_NOT_FOUND:GNUTLS_CERT_SIGNER_NOT_CA:GNUTLS_CERT_INSECURE_ALGORITHM:There is also to possibility to pass some input to the verification functions in the form of flags. For gnutls_x509_crt_verify the flags are passed straightforward, but gnutls_certificate_verify_peers2 depends on the flags set by calling gnutls_certificate_set_verify_flags. All the available flags are part of the enumeration gnutls_certificate_verify_flags and are explained in the table below.
GNUTLS_VERIFY_DISABLE_CA_SIGN:GNUTLS_VERIFY_ALLOW_X509_V1_CA_CRT:GNUTLS_VERIFY_ALLOW_ANY_X509_V1_CA_CRT:GNUTLS_VERIFY_DO_NOT_ALLOW_SAME:GNUTLS_VERIFY_ALLOW_SIGN_RSA_MD2:GNUTLS_VERIFY_ALLOW_SIGN_RSA_MD5:Although the verification of a certificate path indicates that the certificate is signed by trusted authority, does not reveal anything about the peer's identity. It is required to verify if the certificate's owner is the one you expect. For more information consult [RFC2818] (see Bibliography) and section ex:verify for an example.
A certificate request is a structure, which contain information about an applicant of a certificate service. It usually contains a private key, a distinguished name and secondary data such as a challenge password. GnuTLS supports the requests defined in PKCS #10 [RFC2986] (see Bibliography). Other certificate request's format such as PKIX's [RFC4211] (see Bibliography) are not currently supported.
In GnuTLS the PKCS #10 structures are handled
using the gnutls_x509_crq_t type. An example of a certificate
request generation can be found at section ex:crq.
A PKCS #12 structure [PKCS12] (see Bibliography) usually contains a user's private keys and certificates. It is commonly used in browsers to export and import the user's identities.
In GnuTLS the PKCS #12 structures are handled
using the gnutls_pkcs12_t type. This is an abstract type that
may hold several gnutls_pkcs12_bag_t types. The Bag types are
the holders of the actual data, which may be certificates, private
keys or encrypted data. An Bag of type encrypted should be decrypted
in order for its data to be accessed.
An example of a PKCS #12 structure generation can be found at section ex:pkcs12.
The OpenPGP key authentication relies on a distributed trust model, called the “web of trust”. The “web of trust” uses a decentralized system of trusted introducers, which are the same as a CA. OpenPGP allows anyone to sign anyone's else public key. When Alice signs Bob's key, she is introducing Bob's key to anyone who trusts Alice. If someone trusts Alice to introduce keys, then Alice is a trusted introducer in the mind of that observer.
For example: If David trusts Alice to be an introducer, and Alice signed Bob's key, Dave also trusts Bob's key to be the real one.
There are some key points that are important in that model. In the example Alice has to sign Bob's key, only if she is sure that the key belongs to Bob. Otherwise she may also make Dave falsely believe that this is Bob's key. Dave has also the responsibility to know who to trust. This model is similar to real life relations.
Just see how Charlie behaves in the previous example. Although he has signed Bob's key - because he knows, somehow, that it belongs to Bob - he does not trust Bob to be an introducer. Charlie decided to trust only Kevin, for some reason. A reason could be that Bob is lazy enough, and signs other people's keys without being sure that they belong to the actual owner.
In GnuTLS the OpenPGP key structures
[RFC2440] (see Bibliography) are handled using the gnutls_openpgp_key_t type
and the corresponding private keys with the
gnutls_openpgp_privkey_t type. All the prototypes for the key
handling functions can be found at gnutls/openpgp.h.
The verification functions of OpenPGP keys, included in GnuTLS, are simple ones, and do not use the features of the “web of trust”. For that reason, if the verification needs are complex, the assistance of external tools like GnuPG and GPGME (http://www.gnupg.org/related_software/gpgme/) is recommended.
There are two verification functions in GnuTLS, The gnutls_openpgp_key_verify_ring and the gnutls_openpgp_key_verify_trustdb. The first one checks an OpenPGP key against a given set of public keys (keyring) and returns the key status. The key verification status is the same as in X.509 certificates, although the meaning and interpretation are different. For example an OpenPGP key may be valid, if the self signature is ok, even if no signers were found. The meaning of verification status is shown in the figure below. The latter function checks a GnuPG trust database for the given key. This function does not check the key signatures, only checks for disabled and revoked keys.
CERT_INVALID:CERT_REVOKED:CERT_SIGNER_NOT_FOUND:GNUTLS_CERT_INSECURE_ALGORITHM:In this section we will provide some information about digital signatures, how they work, and give the rationale for disabling some of the algorithms used.
Digital signatures work by using somebody's secret key to sign some arbitrary data. Then anybody else could use the public key of that person to verify the signature. Since the data may be arbitrary it is not suitable input to a cryptographic digital signature algorithm. For this reason and also for performance cryptographic hash algorithms are used to preprocess the input to the signature algorithm. This works as long as it is difficult enough to generate two different messages with the same hash algorithm output. In that case the same signature could be used as a proof for both messages. Nobody wants to sign an innocent message of donating 1 € to Greenpeace and find out that he donated 1.000.000 € to Bad Inc.
For a hash algorithm to be called cryptographic the following three requirements must hold
The last two requirements in the list are the most important in digital signatures. These protect against somebody who would like to generate two messages with the same hash output. When an algorithm is considered broken usually it means that the Collision resistance of the algorithm is less than brute force. Using the birthday paradox the brute force attack takes 2^((hash size) / 2) operations. Today colliding certificates using the MD5 hash algorithm have been generated as shown in [WEGER] (see Bibliography).
There has been cryptographic results for the SHA-1 hash algorithms as well, although they are not yet critical. Before 2004, MD5 had a presumed collision strength of 2^64, but it has been showed to have a collision strength well under 2^50. As of November 2005, it is believed that SHA-1's collision strength is around 2^63. We consider this sufficiently hard so that we still support SHA-1. We anticipate that SHA-256/386/512 will be used in publicly-distributed certificates in the future. When 2^63 can be considered too weak compared to the computer power available sometime in the future, SHA-1 will be disabled as well. The collision attacks on SHA-1 may also get better, given the new interest in tools for creating them.
The available digital signature algorithms in GnuTLS are listed below:
RSADSAThe supported cryptographic hash algorithms are:
MD2MD5SHA-1RMD160If you connect to a server and use GnuTLS' functions to verify the
certificate chain, and get a GNUTLS_CERT_INSECURE_ALGORITHM
validation error (see Verifying X.509 certificate paths), it means
that somewhere in the certificate chain there is a certificate signed
using RSA-MD2 or RSA-MD5. These two digital signature
algorithms are considered broken, so GnuTLS fail when attempting to
verify the certificate. In some situations, it may be useful to be
able to verify the certificate chain anyway, assuming an attacker did
not utilize the fact that these signatures algorithms are broken.
This section will give help on how to achieve that.
First, it is important to know that you do not have to enable any of
the flags discussed here to be able to use trusted root CA
certificates signed using RSA-MD2 or RSA-MD5. The only
attack today is that it is possible to generate certificates with
colliding signatures (collision resistance); you cannot generate a
certificate that has the same signature as an already existing
signature (2nd preimage resistance).
If you are using gnutls_certificate_verify_peers2 to verify the
certificate chain, you can call
gnutls_certificate_set_verify_flags with the
GNUTLS_VERIFY_ALLOW_SIGN_RSA_MD2 or
GNUTLS_VERIFY_ALLOW_SIGN_RSA_MD5 flag, as in:
gnutls_certificate_set_verify_flags (x509cred,
GNUTLS_VERIFY_ALLOW_SIGN_RSA_MD5);
This will tell the verifier algorithm to enable RSA-MD5 when
verifying the certificates.
If you are using gnutls_x509_crt_verify or
gnutls_x509_crt_list_verify, you can pass the
GNUTLS_VERIFY_ALLOW_SIGN_RSA_MD5 parameter directly in the
flags parameter.
If you are using these flags, it may also be a good idea to warn the
user when verification failure occur for this reason. The simplest is
to not use the flags by default, and only fall back to using them
after warning the user. If you wish to inspect the certificate chain
yourself, you can use gnutls_certificate_get_peers to extract
the raw server's certificate chain, then use
gnutls_x509_crt_import to parse each of the certificates, and
then use gnutls_x509_crt_get_signature_algorithm to find out the
signing algorithm used for each certificate. If any of the
intermediary certificates are using GNUTLS_SIGN_RSA_MD2 or
GNUTLS_SIGN_RSA_MD5, you could present a warning.
This chapter is intended to provide some hints on how to use the TLS over simple custom made application protocols. The discussion below mainly refers to the TCP/IP transport layer but may be extended to other ones too.
Traditionally SSL was used in application protocols by assigning a new port number for the secure services. That way two separate ports were assigned, one for the non secure sessions, and one for the secured ones. This has the benefit that if a user requests a secure session then the client will try to connect to the secure port and fail otherwise. The only possible attack with this method is a denial of service one. The most famous example of this method is the famous “HTTP over TLS” or HTTPS protocol [RFC2818] (see Bibliography).
Despite its wide use, this method is not as good as it seems. This approach starts the TLS Handshake procedure just after the client connects on the —so called— secure port. That way the TLS protocol does not know anything about the client, and popular methods like the host advertising in HTTP do not work14. There is no way for the client to say “I connected to YYY server” before the Handshake starts, so the server cannot possibly know which certificate to use.
Other than that it requires two separate ports to run a single service, which is unnecessary complication. Due to the fact that there is a limitation on the available privileged ports, this approach was soon obsoleted.
Other application protocols15 use a different approach to enable the secure layer. They use something called the “TLS upgrade” method. This method is quite tricky but it is more flexible. The idea is to extend the application protocol to have a “STARTTLS” request, whose purpose it to start the TLS protocols just after the client requests it. This is a really neat idea and does not require an extra port.
This method is used by almost all modern protocols and there is even the [RFC2817] (see Bibliography) paper which proposes extensions to HTTP to support it.
The tricky part, in this method, is that the “STARTTLS” request is sent in the clear, thus is vulnerable to modifications. A typical attack is to modify the messages in a way that the client is fooled and thinks that the server does not have the “STARTTLS” capability. See a typical conversation of a hypothetical protocol:
(client connects to the server)CLIENT: HELLO I'M MR. XXX
SERVER: NICE TO MEET YOU XXX
CLIENT: PLEASE START TLS
SERVER: OK
*** TLS STARTS
CLIENT: HERE ARE SOME CONFIDENTIAL DATA
And see an example of a conversation where someone is acting in between:
(client connects to the server)CLIENT: HELLO I'M MR. XXX
SERVER: NICE TO MEET YOU XXX
CLIENT: PLEASE START TLS
(here someone inserts this message)
SERVER: SORRY I DON'T HAVE THIS CAPABILITY
CLIENT: HERE ARE SOME CONFIDENTIAL DATA
As you can see above the client was fooled, and was dummy enough to send the confidential data in the clear.
How to avoid the above attack? As you may have already thought this one is easy to avoid. The client has to ask the user before it connects whether the user requests TLS or not. If the user answered that he certainly wants the secure layer the last conversation should be:
(client connects to the server)CLIENT: HELLO I'M MR. XXX
SERVER: NICE TO MEET YOU XXX
CLIENT: PLEASE START TLS
(here someone inserts this message)
SERVER: SORRY I DON'T HAVE THIS CAPABILITY
CLIENT: BYE
(the client notifies the user that the secure connection was not possible)
This method, if implemented properly, is far better than the traditional method, and the security properties remain the same, since only denial of service is possible. The benefit is that the server may request additional data before the TLS Handshake protocol starts, in order to send the correct certificate, use the correct password file16, or anything else!
To use GnuTLS, you have to perform some changes to your sources and your build system. The necessary changes are explained in the following subsections.
All the data types and functions of the GnuTLS library are defined in the header file gnutls/gnutls.h. This must be included in all programs that make use of the GnuTLS library.
The extra functionality of the GnuTLS-extra library is available by including the header file gnutls/extra.h in your programs.
It is often desirable to check that the version of `gnutls' used is indeed one which fits all requirements. Even with binary compatibility new features may have been introduced but due to problem with the dynamic linker an old version is actually used. So you may want to check that the version is okay right after program startup. See the function gnutls_check_version.
If you want to compile a source file including the `gnutls/gnutls.h' header file, you must make sure that the compiler can find it in the directory hierarchy. This is accomplished by adding the path to the directory in which the header file is located to the compilers include file search path (via the -I option).
However, the path to the include file is determined at the time the
source is configured. To solve this problem, GnuTLS ships
with two small helper programs libgnutls-config and
libgnutls-extra-config that knows about the path to the
include file and other configuration options. The options that need
to be added to the compiler invocation at compile time are output by
the --cflags option to libgnutls-config. The
following example shows how it can be used at the command line:
gcc -c foo.c `libgnutls-config --cflags`
Adding the output of libgnutls-config --cflags to the compilers command line will ensure that the compiler can find the GnuTLS header file.
A similar problem occurs when linking the program with the library.
Again, the compiler has to find the library files. For this to work,
the path to the library files has to be added to the library search
path (via the -L option). For this, the option --libs to
libgnutls-config can be used. For convenience, this option
also outputs all other options that are required to link the program
with the GnuTLS libararies. The example shows how to link
`foo.o' with the GnuTLS libraries to a program foo.
gcc -o foo foo.o `libgnutls-config --libs`
Of course you can also combine both examples to a single command by specifying both options to `libgnutls-config':
gcc -o foo foo.c `libgnutls-config --cflags --libs`
Although the GnuTLS library is thread safe by design, some parts of the crypto backend, such as the random generator, are not. Since libgcrypt 1.1.92 there was an automatic detection of the thread library used by the application, so most applications wouldn't need to do any changes to ensure thread-safety. Due to the unportability of the automatic thread detection, this was removed from later releases of libgcrypt, so applications have now to register callback functions to ensure proper locking in sensitive parts of libgcrypt.
There are helper macros to help you properly initialize the libraries. Examples are shown below.
#include <gnutls.h>
#include <gcrypt.h>
#include <errno.h>
#include <pthread.h>
GCRY_THREAD_OPTION_PTHREAD_IMPL;
int main()
{
/* The order matters.
*/
gcry_control (GCRYCTL_SET_THREAD_CBS, &gcry_threads_pthread);
gnutls_global_init();
}
#include <gnutls.h>
#include <gcrypt.h>
#include <errno.h>
#include <pth.h>
GCRY_THREAD_OPTION_PTH_IMPL;
int main()
{
gcry_control (GCRYCTL_SET_THREAD_CBS, &gcry_threads_pth);
gnutls_global_init();
}
/* The gcry_thread_cbs structure must have been
* initialized.
*/
static struct gcry_thread_cbs gcry_threads_other = { ... };
int main()
{
gcry_control (GCRYCTL_SET_THREAD_CBS, &gcry_threads_other);
}
This section contains examples of TLS and SSL clients, using GnuTLS. Note that these examples contain little or no error checking. Some of the examples require functions implemented by another example.
The simplest client using TLS is the one that doesn't do any authentication. This means no external certificates or passwords are needed to set up the connection. As could be expected, the connection is vulnerable to man-in-the-middle (active or redirection) attacks. However, the data is integrity and privacy protected.
#if HAVE_CONFIG_H
# include <config.h>
#endif
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/types.h>
#include <sys/socket.h>
#include <arpa/inet.h>
#include <unistd.h>
#include <gnutls/gnutls.h>
/* A very basic TLS client, with anonymous authentication.
*/
#define MAX_BUF 1024
#define SA struct sockaddr
#define MSG "GET / HTTP/1.0\r\n\r\n"
extern int tcp_connect (void);
extern void tcp_close (int sd);
int
main (void)
{
int ret, sd, ii;
gnutls_session_t session;
char buffer[MAX_BUF + 1];
gnutls_anon_client_credentials_t anoncred;
/* Need to enable anonymous KX specifically. */
const int kx_prio[] = { GNUTLS_KX_ANON_DH, 0 };
gnutls_global_init ();
gnutls_anon_allocate_client_credentials (&anoncred);
/* Initialize TLS session
*/
gnutls_init (&session, GNUTLS_CLIENT);
/* Use default priorities */
gnutls_set_default_priority (session);
gnutls_kx_set_priority (session, kx_prio);
/* put the anonymous credentials to the current session
*/
gnutls_credentials_set (session, GNUTLS_CRD_ANON, anoncred);
/* connect to the peer
*/
sd = tcp_connect ();
gnutls_transport_set_ptr (session, (gnutls_transport_ptr_t) sd);
/* Perform the TLS handshake
*/
ret = gnutls_handshake (session);
if (ret < 0)
{
fprintf (stderr, "*** Handshake failed\n");
gnutls_perror (ret);
goto end;
}
else
{
printf ("- Handshake was completed\n");
}
gnutls_record_send (session, MSG, strlen (MSG));
ret = gnutls_record_recv (session, buffer, MAX_BUF);
if (ret == 0)
{
printf ("- Peer has closed the TLS connection\n");
goto end;
}
else if (ret < 0)
{
fprintf (stderr, "*** Error: %s\n", gnutls_strerror (ret));
goto end;
}
printf ("- Received %d bytes: ", ret);
for (ii = 0; ii < ret; ii++)
{
fputc (buffer[ii], stdout);
}
fputs ("\n", stdout);
gnutls_bye (session, GNUTLS_SHUT_RDWR);
end:
tcp_close (sd);
gnutls_deinit (session);
gnutls_anon_free_client_credentials (anoncred);
gnutls_global_deinit ();
return 0;
}
Let's assume now that we want to create a TCP client which communicates with servers that use X.509 or OpenPGP certificate authentication. The following client is a very simple TLS client, it does not support session resuming, not even certificate verification. The TCP functions defined in this example are used in most of the other examples below, without redefining them.
#if HAVE_CONFIG_H
# include <config.h>
#endif
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/types.h>
#include <sys/socket.h>
#include <arpa/inet.h>
#include <unistd.h>
#include <gnutls/gnutls.h>
/* A very basic TLS client, with X.509 authentication.
*/
#define MAX_BUF 1024
#define CAFILE "ca.pem"
#define MSG "GET / HTTP/1.0\r\n\r\n"
extern int tcp_connect (void);
extern void tcp_close (int sd);
int
main (void)
{
int ret, sd, ii;
gnutls_session_t session;
char buffer[MAX_BUF + 1];
gnutls_certificate_credentials_t xcred;
gnutls_global_init ();
/* X509 stuff */
gnutls_certificate_allocate_credentials (&xcred);
/* sets the trusted cas file
*/
gnutls_certificate_set_x509_trust_file (xcred, CAFILE, GNUTLS_X509_FMT_PEM);
/* Initialize TLS session
*/
gnutls_init (&session, GNUTLS_CLIENT);
/* Use default priorities */
gnutls_set_default_priority (session);
/* put the x509 credentials to the current session
*/
gnutls_credentials_set (session, GNUTLS_CRD_CERTIFICATE, xcred);
/* connect to the peer
*/
sd = tcp_connect ();
gnutls_transport_set_ptr (session, (gnutls_transport_ptr_t) sd);
/* Perform the TLS handshake
*/
ret = gnutls_handshake (session);
if (ret < 0)
{
fprintf (stderr, "*** Handshake failed\n");
gnutls_perror (ret);
goto end;
}
else
{
printf ("- Handshake was completed\n");
}
gnutls_record_send (session, MSG, strlen (MSG));
ret = gnutls_record_recv (session, buffer, MAX_BUF);
if (ret == 0)
{
printf ("- Peer has closed the TLS connection\n");
goto end;
}
else if (ret < 0)
{
fprintf (stderr, "*** Error: %s\n", gnutls_strerror (ret));
goto end;
}
printf ("- Received %d bytes: ", ret);
for (ii = 0; ii < ret; ii++)
{
fputc (buffer[ii], stdout);
}
fputs ("\n", stdout);
gnutls_bye (session, GNUTLS_SHUT_RDWR);
end:
tcp_close (sd);
gnutls_deinit (session);
gnutls_certificate_free_credentials (xcred);
gnutls_global_deinit ();
return 0;
}
Most of the times it is desirable to know the security properties of the current established session. This includes the underlying ciphers and the protocols involved. That is the purpose of the following function. Note that this function will print meaningful values only if called after a successful gnutls_handshake.
#if HAVE_CONFIG_H
# include <config.h>
#endif
#include <stdio.h>
#include <stdlib.h>
#include <gnutls/gnutls.h>
#include <gnutls/x509.h>
extern void print_x509_certificate_info (gnutls_session_t);
/* This function will print some details of the
* given session.
*/
int
print_info (gnutls_session_t session)
{
const char *tmp;
gnutls_credentials_type_t cred;
gnutls_kx_algorithm_t kx;
/* print the key exchange's algorithm name
*/
kx = gnutls_kx_get (session);
tmp = gnutls_kx_get_name (kx);
printf ("- Key Exchange: %s\n", tmp);
/* Check the authentication type used and switch
* to the appropriate.
*/
cred = gnutls_auth_get_type (session);
switch (cred)
{
case GNUTLS_CRD_SRP:
printf ("- SRP session with username %s\n",
gnutls_srp_server_get_username (session));
break;
case GNUTLS_CRD_ANON: /* anonymous authentication */
printf ("- Anonymous DH using prime of %d bits\n",
gnutls_dh_get_prime_bits (session));
break;
case GNUTLS_CRD_CERTIFICATE: /* certificate authentication */
/* Check if we have been using ephemeral Diffie Hellman.
*/
if (kx == GNUTLS_KX_DHE_RSA || kx == GNUTLS_KX_DHE_DSS)
{
printf ("\n- Ephemeral DH using prime of %d bits\n",
gnutls_dh_get_prime_bits (session));
}
/* if the certificate list is available, then
* print some information about it.
*/
print_x509_certificate_info (session);
} /* switch */
/* print the protocol's name (ie TLS 1.0)
*/
tmp = gnutls_protocol_get_name (gnutls_protocol_get_version (session));
printf ("- Protocol: %s\n", tmp);
/* print the certificate type of the peer.
* ie X.509
*/
tmp =
gnutls_certificate_type_get_name (gnutls_certificate_type_get (session));
printf ("- Certificate Type: %s\n", tmp);
/* print the compression algorithm (if any)
*/
tmp = gnutls_compression_get_name (gnutls_compression_get (session));
printf ("- Compression: %s\n", tmp);
/* print the name of the cipher used.
* ie 3DES.
*/
tmp = gnutls_cipher_get_name (gnutls_cipher_get (session));
printf ("- Cipher: %s\n", tmp);
/* Print the MAC algorithms name.
* ie SHA1
*/
tmp = gnutls_mac_get_name (gnutls_mac_get (session));
printf ("- MAC: %s\n", tmp);
return 0;
}
A TLS session is not secure just after the handshake procedure has finished. It must be considered secure, only after the peer's certificate and identity have been verified. That is, you have to verify the signature in peer's certificate, the hostname in the certificate, and expiration dates. Just after this step you should treat the connection as being a secure one.
#if HAVE_CONFIG_H
# include <config.h>
#endif
#include <stdio.h>
#include <gnutls/gnutls.h>
#include <gnutls/x509.h>
/* This function will try to verify the peer's certificate, and
* also check if the hostname matches, and the activation, expiration dates.
*/
void
verify_certificate (gnutls_session_t session, const char *hostname)
{
unsigned int status;
const gnutls_datum_t *cert_list;
unsigned int cert_list_size;
int ret;
gnutls_x509_crt_t cert;
/* This verification function uses the trusted CAs in the credentials
* structure. So you must have installed one or more CA certificates.
*/
ret = gnutls_certificate_verify_peers2 (session, &status);
if (ret < 0)
{
printf ("Error\n");
return;
}
if (status & GNUTLS_CERT_INVALID)
printf ("The certificate is not trusted.\n");
if (status & GNUTLS_CERT_SIGNER_NOT_FOUND)
printf ("The certificate hasn't got a known issuer.\n");
if (status & GNUTLS_CERT_REVOKED)
printf ("The certificate has been revoked.\n");
/* Up to here the process is the same for X.509 certificates and
* OpenPGP keys. From now on X.509 certificates are assumed. This can
* be easily extended to work with openpgp keys as well.
*/
if (gnutls_certificate_type_get (session) != GNUTLS_CRT_X509)
return;
if (gnutls_x509_crt_init (&cert) < 0)
{
printf ("error in initialization\n");
return;
}
cert_list = gnutls_certificate_get_peers (session, &cert_list_size);
if (cert_list == NULL)
{
printf ("No certificate was found!\n");
return;
}
/* This is not a real world example, since we only check the first
* certificate in the given chain.
*/
if (gnutls_x509_crt_import (cert, &cert_list[0], GNUTLS_X509_FMT_DER) < 0)
{
printf ("error parsing certificate\n");
return;
}
/* Beware here we do not check for errors.
*/
if (gnutls_x509_crt_get_expiration_time (cert) < time (0))
{
printf ("The certificate has expired\n");
return;
}
if (gnutls_x509_crt_get_activation_time (cert) > time (0))
{
printf ("The certificate is not yet activated\n");
return;
}
if (!gnutls_x509_crt_check_hostname (cert, hostname))
{
printf ("The certificate's owner does not match hostname '%s'\n",
hostname);
return;
}
gnutls_x509_crt_deinit (cert);
return;
}
An other example is listed below which provides a more detailed
verification output.
#if HAVE_CONFIG_H
# include <config.h>
#endif
#include <stdio.h>
#include <stdlib.h>
#include <gnutls/gnutls.h>
#include <gnutls/x509.h>
/* All the available CRLs
*/
gnutls_x509_crl_t *crl_list;
int crl_list_size;
/* All the available trusted CAs
*/
gnutls_x509_crt_t *ca_list;
int ca_list_size;
static void verify_cert2 (gnutls_x509_crt_t crt,
gnutls_x509_crt_t issuer,
gnutls_x509_crl_t * crl_list, int crl_list_size);
static void verify_last_cert (gnutls_x509_crt_t crt,
gnutls_x509_crt_t * ca_list, int ca_list_size,
gnutls_x509_crl_t * crl_list,
int crl_list_size);
/* This function will try to verify the peer's certificate chain, and
* also check if the hostname matches, and the activation, expiration dates.
*/
void
verify_certificate_chain (gnutls_session_t session,
const char *hostname,
const gnutls_datum_t * cert_chain,
int cert_chain_length)
{
int i;
gnutls_x509_crt_t *cert;
cert = malloc (sizeof (*cert) * cert_chain_length);
/* Import all the certificates in the chain to
* native certificate format.
*/
for (i = 0; i < cert_chain_length; i++)
{
gnutls_x509_crt_init (&cert[i]);
gnutls_x509_crt_import (cert[i], &cert_chain[i], GNUTLS_X509_FMT_DER);
}
/* If the last certificate in the chain is self signed ignore it.
* That is because we want to check against our trusted certificate
* list.
*/
if (gnutls_x509_crt_check_issuer (cert[cert_chain_length - 1],
cert[cert_chain_length - 1]) > 0
&& cert_chain_length > 0)
{
cert_chain_length--;
}
/* Now verify the certificates against their issuers
* in the chain.
*/
for (i = 1; i < cert_chain_length; i++)
{
verify_cert2 (cert[i - 1], cert[i], crl_list, crl_list_size);
}
/* Here we must verify the last certificate in the chain against
* our trusted CA list.
*/
verify_last_cert (cert[cert_chain_length - 1],
ca_list, ca_list_size, crl_list, crl_list_size);
/* Check if the name in the first certificate matches our destination!
*/
if (!gnutls_x509_crt_check_hostname (cert[0], hostname))
{
printf ("The certificate's owner does not match hostname '%s'\n",
hostname);
}
for (i = 0; i < cert_chain_length; i++)
gnutls_x509_crt_deinit (cert[i]);
return;
}
/* Verifies a certificate against an other certificate
* which is supposed to be it's issuer. Also checks the
* crl_list if the certificate is revoked.
*/
static void
verify_cert2 (gnutls_x509_crt_t crt, gnutls_x509_crt_t issuer,
gnutls_x509_crl_t * crl_list, int crl_list_size)
{
unsigned int output;
int ret;
time_t now = time (0);
size_t name_size;
char name[64];
/* Print information about the certificates to
* be checked.
*/
name_size = sizeof (name);
gnutls_x509_crt_get_dn (crt, name, &name_size);
fprintf (stderr, "\nCertificate: %s\n", name);
name_size = sizeof (name);
gnutls_x509_crt_get_issuer_dn (crt, name, &name_size);
fprintf (stderr, "Issued by: %s\n", name);
/* Get the DN of the issuer cert.
*/
name_size = sizeof (name);
gnutls_x509_crt_get_dn (issuer, name, &name_size);
fprintf (stderr, "Checking against: %s\n", name);
/* Do the actual verification.
*/
gnutls_x509_crt_verify (crt, &issuer, 1, 0, &output);
if (output & GNUTLS_CERT_INVALID)
{
fprintf (stderr, "Not trusted");
if (output & GNUTLS_CERT_SIGNER_NOT_FOUND)
fprintf (stderr, ": no issuer was found");
if (output & GNUTLS_CERT_SIGNER_NOT_CA)
fprintf (stderr, ": issuer is not a CA");
fprintf (stderr, "\n");
}
else
fprintf (stderr, "Trusted\n");
/* Now check the expiration dates.
*/
if (gnutls_x509_crt_get_activation_time (crt) > now)
fprintf (stderr, "Not yet activated\n");
if (gnutls_x509_crt_get_expiration_time (crt) < now)
fprintf (stderr, "Expired\n");
/* Check if the certificate is revoked.
*/
ret = gnutls_x509_crt_check_revocation (crt, crl_list, crl_list_size);
if (ret == 1)
{ /* revoked */
fprintf (stderr, "Revoked\n");
}
}
/* Verifies a certificate against our trusted CA list.
* Also checks the crl_list if the certificate is revoked.
*/
static void
verify_last_cert (gnutls_x509_crt_t crt,
gnutls_x509_crt_t * ca_list, int ca_list_size,
gnutls_x509_crl_t * crl_list, int crl_list_size)
{
unsigned int output;
int ret;
time_t now = time (0);
size_t name_size;
char name[64];
/* Print information about the certificates to
* be checked.
*/
name_size = sizeof (name);
gnutls_x509_crt_get_dn (crt, name, &name_size);
fprintf (stderr, "\nCertificate: %s\n", name);
name_size = sizeof (name);
gnutls_x509_crt_get_issuer_dn (crt, name, &name_size);
fprintf (stderr, "Issued by: %s\n", name);
/* Do the actual verification.
*/
gnutls_x509_crt_verify (crt, ca_list, ca_list_size,
GNUTLS_VERIFY_ALLOW_X509_V1_CA_CRT, &output);
if (output & GNUTLS_CERT_INVALID)
{
fprintf (stderr, "Not trusted");
if (output & GNUTLS_CERT_SIGNER_NOT_CA)
fprintf (stderr, ": Issuer is not a CA\n");
else
fprintf (stderr, "\n");
}
else
fprintf (stderr, "Trusted\n");
/* Now check the expiration dates.
*/
if (gnutls_x509_crt_get_activation_time (crt) > now)
fprintf (stderr, "Not yet activated\n");
if (gnutls_x509_crt_get_expiration_time (crt) < now)
fprintf (stderr, "Expired\n");
/* Check if the certificate is revoked.
*/
ret = gnutls_x509_crt_check_revocation (crt, crl_list, crl_list_size);
if (ret == 1)
{ /* revoked */
fprintf (stderr, "Revoked\n");
}
}
There are cases where a client holds several certificate and key pairs, and may not want to load all of them in the credentials structure. The following example demonstrates the use of the certificate selection callback.
#if HAVE_CONFIG_H
# include <config.h>
#endif
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/types.h>
#include <sys/socket.h>
#include <arpa/inet.h>
#include <unistd.h>
#include <gnutls/gnutls.h>
#include <gnutls/x509.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
/* A TLS client that loads the certificate and key.
*/
#define MAX_BUF 1024
#define MSG "GET / HTTP/1.0\r\n\r\n"
#define CERT_FILE "cert.pem"
#define KEY_FILE "key.pem"
#define CAFILE "ca.pem"
extern int tcp_connect (void);
extern void tcp_close (int sd);
static int cert_callback (gnutls_session_t session,
const gnutls_datum_t * req_ca_rdn, int nreqs,
const gnutls_pk_algorithm_t * sign_algos,
int sign_algos_length, gnutls_retr_st * st);
gnutls_x509_crt_t crt;
gnutls_x509_privkey_t key;
/* Helper functions to load a certificate and key
* files into memory.
*/
static gnutls_datum
load_file (const char *file)
{
FILE *f;
gnutls_datum loaded_file = { NULL, 0 };
long filelen;
void *ptr;
if (!(f = fopen(file, "r"))
|| fseek(f, 0, SEEK_END) != 0
|| (filelen = ftell(f)) < 0
|| fseek(f, 0, SEEK_SET) != 0
|| !(ptr = malloc((size_t)filelen))
|| fread(ptr, 1, (size_t)filelen, f) < (size_t)filelen)
{
return loaded_file;
}
loaded_file.data = ptr;
loaded_file.size = (unsigned int)filelen;
return loaded_file;
}
static void unload_file(gnutls_datum data)
{
free(data.data);
}
/* Load the certificate and the private key.
*/
static void
load_keys (void)
{
int ret;
gnutls_datum_t data;
data = load_file (CERT_FILE);
if (data.data == NULL)
{
fprintf (stderr, "*** Error loading cert file.\n");
exit (1);
}
gnutls_x509_crt_init (&crt);
ret = gnutls_x509_crt_import (crt, &data, GNUTLS_X509_FMT_PEM);
if (ret < 0)
{
fprintf (stderr, "*** Error loading key file: %s\n",
gnutls_strerror (ret));
exit (1);
}
unload_file (data);
data = load_file (KEY_FILE);
if (data.data == NULL)
{
fprintf (stderr, "*** Error loading key file.\n");
exit (1);
}
gnutls_x509_privkey_init (&key);
ret = gnutls_x509_privkey_import (key, &data, GNUTLS_X509_FMT_PEM);
if (ret < 0)
{
fprintf (stderr, "*** Error loading key file: %s\n",
gnutls_strerror (ret));
exit (1);
}
unload_file (data);
}
int
main (void)
{
int ret, sd, ii;
gnutls_session_t session;
char buffer[MAX_BUF + 1];
gnutls_certificate_credentials_t xcred;
/* Allow connections to servers that have OpenPGP keys as well.
*/
gnutls_global_init ();
load_keys ();
/* X509 stuff */
gnutls_certificate_allocate_credentials (&xcred);
/* sets the trusted cas file
*/
gnutls_certificate_set_x509_trust_file (xcred, CAFILE, GNUTLS_X509_FMT_PEM);
gnutls_certificate_client_set_retrieve_function (xcred, cert_callback);
/* Initialize TLS session
*/
gnutls_init (&session, GNUTLS_CLIENT);
/* Use default priorities */
gnutls_set_default_priority (session);
/* put the x509 credentials to the current session
*/
gnutls_credentials_set (session, GNUTLS_CRD_CERTIFICATE, xcred);
/* connect to the peer
*/
sd = tcp_connect ();
gnutls_transport_set_ptr (session, (gnutls_transport_ptr_t) sd);
/* Perform the TLS handshake
*/
ret = gnutls_handshake (session);
if (ret < 0)
{
fprintf (stderr, "*** Handshake failed\n");
gnutls_perror (ret);
goto end;
}
else
{
printf ("- Handshake was completed\n");
}
gnutls_record_send (session, MSG, strlen (MSG));
ret = gnutls_record_recv (session, buffer, MAX_BUF);
if (ret == 0)
{
printf ("- Peer has closed the TLS connection\n");
goto end;
}
else if (ret < 0)
{
fprintf (stderr, "*** Error: %s\n", gnutls_strerror (ret));
goto end;
}
printf ("- Received %d bytes: ", ret);
for (ii = 0; ii < ret; ii++)
{
fputc (buffer[ii], stdout);
}
fputs ("\n", stdout);
gnutls_bye (session, GNUTLS_SHUT_RDWR);
end:
tcp_close (sd);
gnutls_deinit (session);
gnutls_certificate_free_credentials (xcred);
gnutls_global_deinit ();
return 0;
}
/* This callback should be associated with a session by calling
* gnutls_certificate_client_set_retrieve_function( session, cert_callback),
* before a handshake.
*/
static int
cert_callback (gnutls_session_t session,
const gnutls_datum_t * req_ca_rdn, int nreqs,
const gnutls_pk_algorithm_t * sign_algos,
int sign_algos_length, gnutls_retr_st * st)
{
char issuer_dn[256];
int i, ret;
size_t len;
gnutls_certificate_type_t type;
/* Print the server's trusted CAs
*/
if (nreqs > 0)
printf ("- Server's trusted authorities:\n");
else
printf ("- Server did not send us any trusted authorities names.\n");
/* print the names (if any) */
for (i = 0; i < nreqs; i++)
{
len = sizeof (issuer_dn);
ret = gnutls_x509_rdn_get (&req_ca_rdn[i], issuer_dn, &len);
if (ret >= 0)
{
printf (" [%d]: ", i);
printf ("%s\n", issuer_dn);
}
}
/* Select a certificate and return it.
* The certificate must be of any of the "sign algorithms"
* supported by the server.
*/
type = gnutls_certificate_type_get (session);
if (type == GNUTLS_CRT_X509)
{
st->type = type;
st->ncerts = 1;
st->cert.x509 = &crt;
st->key.x509 = key;
st->deinit_all = 0;
}
else
{
return -1;
}
return 0;
}
This is a modification of the simple client example. Here we demonstrate the use of session resumption. The client tries to connect once using TLS, close the connection and then try to establish a new connection using the previously negotiated data.
#if HAVE_CONFIG_H
# include <config.h>
#endif
#include <string.h>
#include <stdio.h>
#include <stdlib.h>
#include <gnutls/gnutls.h>
/* Those functions are defined in other examples.
*/
extern void check_alert (gnutls_session_t session, int ret);
extern int tcp_connect (void);
extern void tcp_close (int sd);
#define MAX_BUF 1024
#define CRLFILE "crl.pem"
#define CAFILE "ca.pem"
#define MSG "GET / HTTP/1.0\r\n\r\n"
int
main (void)
{
int ret;
int sd, ii;
gnutls_session_t session;
char buffer[MAX_BUF + 1];
gnutls_certificate_credentials_t xcred;
/* variables used in session resuming
*/
int t;
char *session_data;
size_t session_data_size;
gnutls_global_init ();
/* X509 stuff */
gnutls_certificate_allocate_credentials (&xcred);
gnutls_certificate_set_x509_trust_file (xcred, CAFILE, GNUTLS_X509_FMT_PEM);
for (t = 0; t < 2; t++)
{ /* connect 2 times to the server */
sd = tcp_connect ();
gnutls_init (&session, GNUTLS_CLIENT);
gnutls_set_default_priority (session);
gnutls_credentials_set (session, GNUTLS_CRD_CERTIFICATE, xcred);
if (t > 0)
{
/* if this is not the first time we connect */
gnutls_session_set_data (session, session_data, session_data_size);
free (session_data);
}
gnutls_transport_set_ptr (session, (gnutls_transport_ptr_t) sd);
/* Perform the TLS handshake
*/
ret = gnutls_handshake (session);
if (ret < 0)
{
fprintf (stderr, "*** Handshake failed\n");
gnutls_perror (ret);
goto end;
}
else
{
printf ("- Handshake was completed\n");
}
if (t == 0)
{ /* the first time we connect */
/* get the session data size */
gnutls_session_get_data (session, NULL, &session_data_size);
session_data = malloc (session_data_size);
/* put session data to the session variable */
gnutls_session_get_data (session, session_data, &session_data_size);
}
else
{ /* the second time we connect */
/* check if we actually resumed the previous session */
if (gnutls_session_is_resumed (session) != 0)
{
printf ("- Previous session was resumed\n");
}
else
{
fprintf (stderr, "*** Previous session was NOT resumed\n");
}
}
/* This function was defined in a previous example
*/
/* print_info(session); */
gnutls_record_send (session, MSG, strlen (MSG));
ret = gnutls_record_recv (session, buffer, MAX_BUF);
if (ret == 0)
{
printf ("- Peer has closed the TLS connection\n");
goto end;
}
else if (ret < 0)
{
fprintf (stderr, "*** Error: %s\n", gnutls_strerror (ret));
goto end;
}
printf ("- Received %d bytes: ", ret);
for (ii = 0; ii < ret; ii++)
{
fputc (buffer[ii], stdout);
}
fputs ("\n", stdout);
gnutls_bye (session, GNUTLS_SHUT_RDWR);
end:
tcp_close (sd);
gnutls_deinit (session);
} /* for() */
gnutls_certificate_free_credentials (xcred);
gnutls_global_deinit ();
return 0;
}
The following client is a very simple SRP TLS client which connects to a server and authenticates using a username and a password. The server may authenticate itself using a certificate, and in that case it has to be verified.
#if HAVE_CONFIG_H
# include <config.h>
#endif
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <gnutls/gnutls.h>
#include <gnutls/extra.h>
/* Those functions are defined in other examples.
*/
extern void check_alert (gnutls_session_t session, int ret);
extern int tcp_connect (void);
extern void tcp_close (int sd);
#define MAX_BUF 1024
#define USERNAME "user"
#define PASSWORD "pass"
#define CAFILE "ca.pem"
#define SA struct sockaddr
#define MSG "GET / HTTP/1.0\r\n\r\n"
int
main (void)
{
int ret;
int sd, ii;
gnutls_session_t session;
char buffer[MAX_BUF + 1];
gnutls_srp_client_credentials_t srp_cred;
gnutls_certificate_credentials_t cert_cred;
gnutls_global_init ();
/* now enable the gnutls-extra library which contains the
* SRP stuff.
*/
gnutls_global_init_extra ();
gnutls_srp_allocate_client_credentials (&srp_cred);
gnutls_certificate_allocate_credentials (&cert_cred);
gnutls_certificate_set_x509_trust_file (cert_cred, CAFILE,
GNUTLS_X509_FMT_PEM);
gnutls_srp_set_client_credentials (srp_cred, USERNAME, PASSWORD);
/* connects to server
*/
sd = tcp_connect ();
/* Initialize TLS session
*/
gnutls_init (&session, GNUTLS_CLIENT);
/* Set the priorities.
*/
gnutls_set_default_priority (session);
/* put the SRP credentials to the current session
*/
gnutls_credentials_set (session, GNUTLS_CRD_SRP, srp_cred);
gnutls_credentials_set (session, GNUTLS_CRD_CERTIFICATE, cert_cred);
gnutls_transport_set_ptr (session, (gnutls_transport_ptr_t) sd);
/* Perform the TLS handshake
*/
ret = gnutls_handshake (session);
if (ret < 0)
{
fprintf (stderr, "*** Handshake failed\n");
gnutls_perror (ret);
goto end;
}
else
{
printf ("- Handshake was completed\n");
}
gnutls_record_send (session, MSG, strlen (MSG));
ret = gnutls_record_recv (session, buffer, MAX_BUF);
if (gnutls_error_is_fatal (ret) == 1 || ret == 0)
{
if (ret == 0)
{
printf ("- Peer has closed the GNUTLS connection\n");
goto end;
}
else
{
fprintf (stderr, "*** Error: %s\n", gnutls_strerror (ret));
goto end;
}
}
else
check_alert (session, ret);
if (ret > 0)
{
printf ("- Received %d bytes: ", ret);
for (ii = 0; ii < ret; ii++)
{
fputc (buffer[ii], stdout);
}
fputs ("\n", stdout);
}
gnutls_bye (session, GNUTLS_SHUT_RDWR);
end:
tcp_close (sd);
gnutls_deinit (session);
gnutls_srp_free_client_credentials (srp_cred);
gnutls_certificate_free_credentials (cert_cred);
gnutls_global_deinit ();
return 0;
}
The following client is a simple client which uses the TLS/IA extension to authenticate with the server.
#if HAVE_CONFIG_H
# include <config.h>
#endif
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/types.h>
#include <sys/socket.h>
#include <arpa/inet.h>
#include <unistd.h>
#include <gnutls/gnutls.h>
#include <gnutls/extra.h>
/* A basic TLS client, with anonymous authentication and TLS/IA handshake.
*/
#define MAX_BUF 1024
#define SA struct sockaddr
#define MSG "GET / HTTP/1.0\r\n\r\n"
extern int tcp_connect (void);
extern void tcp_close (int sd);
int
client_avp (gnutls_session_t session, void *ptr,
const char *last, size_t lastlen,
char **new, size_t *newlen)
{
if (last)
printf ("- received %d bytes AVP: `%.*s'\n",
lastlen, lastlen, last);
else
printf ("- new application phase\n");
*new = gnutls_strdup ("client avp");
if (!*new)
return -1;
*newlen = strlen (*new);
printf ("- sending %d bytes AVP: `%s'\n", *newlen, *new);
gnutls_ia_permute_inner_secret (session, 3, "foo");
return 0;
}
int
main (void)
{
int ret, sd, ii;
gnutls_session_t session;
char buffer[MAX_BUF + 1];
gnutls_anon_client_credentials_t anoncred;
gnutls_ia_client_credentials_t iacred;
/* Need to enable anonymous KX specifically. */
const int kx_prio[] = { GNUTLS_KX_ANON_DH, 0 };
gnutls_global_init ();
gnutls_anon_allocate_client_credentials (&anoncred);
gnutls_ia_allocate_client_credentials (&iacred);
/* Set TLS/IA stuff
*/
gnutls_ia_set_client_avp_function (iacred, client_avp);
/* Initialize TLS session
*/
gnutls_init (&session, GNUTLS_CLIENT);
/* Use default priorities */
gnutls_set_default_priority (session);
gnutls_kx_set_priority (session, kx_prio);
/* put the anonymous and TLS/IA credentials to the current session
*/
gnutls_credentials_set (session, GNUTLS_CRD_ANON, anoncred);
gnutls_credentials_set (session, GNUTLS_CRD_IA, iacred);
/* connect to the peer
*/
sd = tcp_connect ();
gnutls_transport_set_ptr (session, (gnutls_transport_ptr_t) sd);
/* Perform the TLS handshake
*/
ret = gnutls_handshake (session);
if (ret < 0)
{
fprintf (stderr, "*** Handshake failed\n");
gnutls_perror (ret);
goto end;
}
else
{
printf ("- Handshake was completed\n");
}
if (!gnutls_ia_handshake_p (session))
{
fprintf (stderr, "*** TLS/IA not negotiated...\n");
goto end;
}
else
{
printf ("- Starting TLS/IA handshake...\n");
ret = gnutls_ia_handshake (session);
if (ret < 0)
{
fprintf (stderr, "*** TLS/IA handshake failed\n");
gnutls_perror (ret);
goto end;
}
else
{
printf ("- TLS/IA Handshake was completed\n");
}
}
gnutls_record_send (session, MSG, strlen (MSG));
ret = gnutls_record_recv (session, buffer, MAX_BUF);
if (ret == 0)
{
printf ("- Peer has closed the TLS connection\n");
goto end;
}
else if (ret < 0)
{
fprintf (stderr, "*** Error: %s\n", gnutls_strerror (ret));
goto end;
}
printf ("- Received %d bytes: ", ret);
for (ii = 0; ii < ret; ii++)
{
fputc (buffer[ii], stdout);
}
fputs ("\n", stdout);
gnutls_bye (session, GNUTLS_SHUT_RDWR);
end:
tcp_close (sd);
gnutls_deinit (session);
gnutls_ia_free_client_credentials (iacred);
gnutls_anon_free_client_credentials (anoncred);
gnutls_global_deinit ();
return 0;
}
The following client require that the server sends authorization data, and the client will send authorization data to the server as well. For authentication, X.509 is used.
#if HAVE_CONFIG_H
# include <config.h>
#endif
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/types.h>
#include <sys/socket.h>
#include <arpa/inet.h>
#include <unistd.h>
#include <gnutls/gnutls.h>
/* A basic TLS client, with X.509 authentication, and support for
the authorization extension.
*/
#define MAX_BUF 1024
#define CAFILE "ca.pem"
#define MSG "GET / HTTP/1.0\r\n\r\n"
extern int tcp_connect (void);
extern void tcp_close (int sd);
int server_authorized_p = 0;
int
authz_recv_callback (gnutls_session_t session,
const int *authz_formats,
gnutls_datum_t *infos,
const int *hashtypes,
gnutls_datum_t *hash)
{
size_t i, j;
/* This function receives authorization data. */
for (i = 0; authz_formats[i]; i++)
{
printf ("- Received authorization data, format %02x of %d bytes\n",
authz_formats[i], infos[i].size);
printf (" data: ");
for (j = 0; j < infos[i].size; j++)
printf ("%02x", infos[i].data[j]);
printf ("\n");
if (hash[i].size > 0)
{
printf (" hash: ");
for (j = 0; j < hash[i].size; j++)
printf ("%02x", hash[i].data[j]);
printf (" type %02x\n", hashtypes[i]);
}
}
/* You would typically actually _validate_ the data here... if you
need access to authentication details, store the authorization
data and do the validation inside main(). */
server_authorized_p = 1;
return 0;
}
int
authz_send_callback (gnutls_session_t session,
const int *client_formats,
const int *server_formats)
{
const char *str = "saml assertion";
/* Send the authorization data here. client_formats and
server_formats contains a list of negotiated authorization
formats. */
return gnutls_authz_send_saml_assertion (session, str, sizeof (str));
}
int
main (void)
{
int ret, sd, ii;
gnutls_session_t session;
char buffer[MAX_BUF + 1];
gnutls_certificate_credentials_t xcred;
const int authz_client_formats[] = {
GNUTLS_AUTHZ_SAML_ASSERTION,
};
const int authz_server_formats[] = {
GNUTLS_AUTHZ_X509_ATTR_CERT,
GNUTLS_AUTHZ_SAML_ASSERTION,
GNUTLS_AUTHZ_X509_ATTR_CERT_URL,
GNUTLS_AUTHZ_SAML_ASSERTION_URL
};
gnutls_global_init ();
/* X509 stuff */
gnutls_certificate_allocate_credentials (&xcred);
/* sets the trusted cas file
*/
gnutls_certificate_set_x509_trust_file (xcred, CAFILE, GNUTLS_X509_FMT_PEM);
/* Initialize TLS session
*/
gnutls_init (&session, GNUTLS_CLIENT);
/* Use default priorities */
gnutls_set_default_priority (session);
/* put the x509 credentials to the current session
*/
gnutls_credentials_set (session, GNUTLS_CRD_CERTIFICATE, xcred);
/* connect to the peer
*/
sd = tcp_connect ();
gnutls_transport_set_ptr (session, (gnutls_transport_ptr_t) sd);
gnutls_authz_enable (session, authz_client_formats, authz_server_formats,
authz_recv_callback, authz_send_callback);
/* Perform the TLS handshake
*/
ret = gnutls_handshake (session);
if (ret < 0)
{
fprintf (stderr, "*** Handshake failed\n");
gnutls_perror (ret);
goto end;
}
else
{
printf ("- Handshake was completed\n");
}
if (!server_authorized_p)
{
fprintf (stderr, "*** Not authorized, giving up...\n");
ret = gnutls_alert_send (session, GNUTLS_AL_FATAL,
GNUTLS_A_ACCESS_DENIED);
if (ret < 0)
{
gnutls_perror (ret);
goto end;
}
}
gnutls_record_send (session, MSG, strlen (MSG));
ret = gnutls_record_recv (session, buffer, MAX_BUF);
if (ret == 0)
{
printf ("- Peer has closed the TLS connection\n");
goto end;
}
else if (ret < 0)
{
fprintf (stderr, "*** Error: %s\n", gnutls_strerror (ret));
goto end;
}
printf ("- Received %d bytes: ", ret);
for (ii = 0; ii < ret; ii++)
{
fputc (buffer[ii], stdout);
}
fputs ("\n", stdout);
gnutls_bye (session, GNUTLS_SHUT_RDWR);
end:
tcp_close (sd);
gnutls_deinit (session);
gnutls_certificate_free_credentials (xcred);
gnutls_global_deinit ();
return 0;
}
This helper function abstracts away TCP connection handling from the other examples. It is required to build some examples.
#if HAVE_CONFIG_H
# include <config.h>
#endif
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/types.h>
#include <sys/socket.h>
#include <arpa/inet.h>
#include <netinet/in.h>
#include <unistd.h>
#define SA struct sockaddr
/* Connects to the peer and returns a socket
* descriptor.
*/
extern int
tcp_connect (void)
{
const char *PORT = "5556";
const char *SERVER = "127.0.0.1";
int err, sd;
struct sockaddr_in sa;
/* connects to server
*/
sd = socket (AF_INET, SOCK_STREAM, 0);
memset (&sa, '\0', sizeof (sa));
sa.sin_family = AF_INET;
sa.sin_port = htons (atoi (PORT));
inet_pton (AF_INET, SERVER, &sa.sin_addr);
err = connect (sd, (SA *) & sa, sizeof (sa));
if (err < 0)
{
fprintf (stderr, "Connect error\n");
exit (1);
}
return sd;
}
/* closes the given socket descriptor.
*/
extern void
tcp_close (int sd)
{
shutdown (sd, SHUT_RDWR); /* no more receptions */
close (sd);
}
This section contains examples of TLS and SSL servers, using GnuTLS.
This example is a very simple echo server which supports X.509 authentication, using the RSA ciphersuites.
#if HAVE_CONFIG_H
# include <config.h>
#endif
#include <stdio.h>
#include <stdlib.h>
#include <errno.h>
#include <sys/types.h>
#include <sys/socket.h>
#include <arpa/inet.h>
#include <netinet/in.h>
#include <string.h>
#include <unistd.h>
#include <gnutls/gnutls.h>
#define KEYFILE "key.pem"
#define CERTFILE "cert.pem"
#define CAFILE "ca.pem"
#define CRLFILE "crl.pem"
/* This is a sample TLS 1.0 echo server, using X.509 authentication.
*/
#define SA struct sockaddr
#define SOCKET_ERR(err,s) if(err==-1) {perror(s);return(1);}
#define MAX_BUF 1024
#define PORT 5556 /* listen to 5556 port */
#define DH_BITS 1024
/* These are global */
gnutls_certificate_credentials_t x509_cred;
gnutls_session_t
initialize_tls_session (void)
{
gnutls_session_t session;
gnutls_init (&session, GNUTLS_SERVER);
/* avoid calling all the priority functions, since the defaults
* are adequate.
*/
gnutls_set_default_priority (session);
gnutls_credentials_set (session, GNUTLS_CRD_CERTIFICATE, x509_cred);
/* request client certificate if any.
*/
gnutls_certificate_server_set_request (session, GNUTLS_CERT_REQUEST);
gnutls_dh_set_prime_bits (session, DH_BITS);
return session;
}
static gnutls_dh_params_t dh_params;
static int
generate_dh_params (void)
{
/* Generate Diffie Hellman parameters - for use with DHE
* kx algorithms. These should be discarded and regenerated
* once a day, once a week or once a month. Depending on the
* security requirements.
*/
gnutls_dh_params_init (&dh_params);
gnutls_dh_params_generate2 (dh_params, DH_BITS);
return 0;
}
int
main (void)
{
int err, listen_sd, i;
int sd, ret;
struct sockaddr_in sa_serv;
struct sockaddr_in sa_cli;
int client_len;
char topbuf[512];
gnutls_session_t session;
char buffer[MAX_BUF + 1];
int optval = 1;
/* this must be called once in the program
*/
gnutls_global_init ();
gnutls_certificate_allocate_credentials (&x509_cred);
gnutls_certificate_set_x509_trust_file (x509_cred, CAFILE,
GNUTLS_X509_FMT_PEM);
gnutls_certificate_set_x509_crl_file (x509_cred, CRLFILE,
GNUTLS_X509_FMT_PEM);
gnutls_certificate_set_x509_key_file (x509_cred, CERTFILE, KEYFILE,
GNUTLS_X509_FMT_PEM);
generate_dh_params ();
gnutls_certificate_set_dh_params (x509_cred, dh_params);
/* Socket operations
*/
listen_sd = socket (AF_INET, SOCK_STREAM, 0);
SOCKET_ERR (listen_sd, "socket");
memset (&sa_serv, '\0', sizeof (sa_serv));
sa_serv.sin_family = AF_INET;
sa_serv.sin_addr.s_addr = INADDR_ANY;
sa_serv.sin_port = htons (PORT); /* Server Port number */
setsockopt (listen_sd, SOL_SOCKET, SO_REUSEADDR, &optval, sizeof (int));
err = bind (listen_sd, (SA *) & sa_serv, sizeof (sa_serv));
SOCKET_ERR (err, "bind");
err = listen (listen_sd, 1024);
SOCKET_ERR (err, "listen");
printf ("Server ready. Listening to port '%d'.\n\n", PORT);
client_len = sizeof (sa_cli);
for (;;)
{
session = initialize_tls_session ();
sd = accept (listen_sd, (SA *) & sa_cli, &client_len);
printf ("- connection from %s, port %d\n",
inet_ntop (AF_INET, &sa_cli.sin_addr, topbuf,
sizeof (topbuf)), ntohs (sa_cli.sin_port));
gnutls_transport_set_ptr (session, (gnutls_transport_ptr_t) sd);
ret = gnutls_handshake (session);
if (ret < 0)
{
close (sd);
gnutls_deinit (session);
fprintf (stderr, "*** Handshake has failed (%s)\n\n",
gnutls_strerror (ret));
continue;
}
printf ("- Handshake was completed\n");
/* see the Getting peer's information example */
/* print_info(session); */
i = 0;
for (;;)
{
memset (buffer, 0, MAX_BUF + 1);
ret = gnutls_record_recv (session, buffer, MAX_BUF);
if (ret == 0)
{
printf ("\n- Peer has closed the GNUTLS connection\n");
break;
}
else if (ret < 0)
{
fprintf (stderr, "\n*** Received corrupted "
"data(%d). Closing the connection.\n\n", ret);
break;
}
else if (ret > 0)
{
/* echo data back to the client
*/
gnutls_record_send (session, buffer, strlen (buffer));
}
}
printf ("\n");
/* do not wait for the peer to close the connection.
*/
gnutls_bye (session, GNUTLS_SHUT_WR);
close (sd);
gnutls_deinit (session);
}
close (listen_sd);
gnutls_certificate_free_credentials (x509_cred);
gnutls_global_deinit ();
return 0;
}
The following example is a server which supports X.509 authentication. This server supports the export-grade cipher suites, the DHE ciphersuites and session resuming.
#if HAVE_CONFIG_H
# include <config.h>
#endif
#include <stdio.h>
#include <stdlib.h>
#include <errno.h>
#include <sys/types.h>
#include <sys/socket.h>
#include <arpa/inet.h>
#include <netinet/in.h>
#include <string.h>
#include <unistd.h>
#include <gnutls/gnutls.h>
#define KEYFILE "key.pem"
#define CERTFILE "cert.pem"
#define CAFILE "ca.pem"
#define CRLFILE "crl.pem"
/* This is a sample TLS 1.0 echo server.
* Export-grade ciphersuites and session resuming are supported.
*/
#define SA struct sockaddr
#define SOCKET_ERR(err,s) if(err==-1) {perror(s);return(1);}
#define MAX_BUF 1024
#define PORT 5556 /* listen to 5556 port */
#define DH_BITS 1024
/* These are global */
gnutls_certificate_credentials_t cert_cred;
static void wrap_db_init (void);
static void wrap_db_deinit (void);
static int wrap_db_store (void *dbf, gnutls_datum_t key, gnutls_datum_t data);
static gnutls_datum_t wrap_db_fetch (void *dbf, gnutls_datum_t key);
static int wrap_db_delete (void *dbf, gnutls_datum_t key);
#define TLS_SESSION_CACHE 50
gnutls_session_t
initialize_tls_session (void)
{
gnutls_session_t session;
gnutls_init (&session, GNUTLS_SERVER);
/* Use the default priorities, plus, export cipher suites.
*/
gnutls_set_default_export_priority (session);
gnutls_credentials_set (session, GNUTLS_CRD_CERTIFICATE, cert_cred);
/* request client certificate if any.
*/
gnutls_certificate_server_set_request (session, GNUTLS_CERT_REQUEST);
gnutls_dh_set_prime_bits (session, DH_BITS);
if (TLS_SESSION_CACHE != 0)
{
gnutls_db_set_retrieve_function (session, wrap_db_fetch);
gnutls_db_set_remove_function (session, wrap_db_delete);
gnutls_db_set_store_function (session, wrap_db_store);
gnutls_db_set_ptr (session, NULL);
}
return session;
}
gnutls_dh_params_t dh_params;
/* Export-grade cipher suites require temporary RSA
* keys.
*/
gnutls_rsa_params_t rsa_params;
int
generate_dh_params (void)
{
/* Generate Diffie Hellman parameters - for use with DHE
* kx algorithms. These should be discarded and regenerated
* once a day, once a week or once a month. Depends on the
* security requirements.
*/
gnutls_dh_params_init (&dh_params);
gnutls_dh_params_generate2 (dh_params, DH_BITS);
return 0;
}
static int
generate_rsa_params (void)
{
gnutls_rsa_params_init (&rsa_params);
/* Generate RSA parameters - for use with RSA-export
* cipher suites. These should be discarded and regenerated
* once a day, once every 500 transactions etc. Depends on the
* security requirements.
*/
gnutls_rsa_params_generate2 (rsa_params, 512);
return 0;
}
int
main (void)
{
int err, listen_sd, i;
int sd, ret;
struct sockaddr_in sa_serv;
struct sockaddr_in sa_cli;
int client_len;
char topbuf[512];
gnutls_session_t session;
char buffer[MAX_BUF + 1];
int optval = 1;
char name[256];
strcpy (name, "Echo Server");
/* this must be called once in the program
*/
gnutls_global_init ();
gnutls_certificate_allocate_credentials (&cert_cred);
gnutls_certificate_set_x509_trust_file (cert_cred, CAFILE,
GNUTLS_X509_FMT_PEM);
gnutls_certificate_set_x509_crl_file (cert_cred, CRLFILE,
GNUTLS_X509_FMT_PEM);
gnutls_certificate_set_x509_key_file (cert_cred, CERTFILE, KEYFILE,
GNUTLS_X509_FMT_PEM);
generate_dh_params ();
generate_rsa_params ();
if (TLS_SESSION_CACHE != 0)
{
wrap_db_init ();
}
gnutls_certificate_set_dh_params (cert_cred, dh_params);
gnutls_certificate_set_rsa_export_params (cert_cred, rsa_params);
/* Socket operations
*/
listen_sd = socket (AF_INET, SOCK_STREAM, 0);
SOCKET_ERR (listen_sd, "socket");
memset (&sa_serv, '\0', sizeof (sa_serv));
sa_serv.sin_family = AF_INET;
sa_serv.sin_addr.s_addr = INADDR_ANY;
sa_serv.sin_port = htons (PORT); /* Server Port number */
setsockopt (listen_sd, SOL_SOCKET, SO_REUSEADDR, &optval, sizeof (int));
err = bind (listen_sd, (SA *) & sa_serv, sizeof (sa_serv));
SOCKET_ERR (err, "bind");
err = listen (listen_sd, 1024);
SOCKET_ERR (err, "listen");
printf ("%s ready. Listening to port '%d'.\n\n", name, PORT);
client_len = sizeof (sa_cli);
for (;;)
{
session = initialize_tls_session ();
sd = accept (listen_sd, (SA *) & sa_cli, &client_len);
printf ("- connection from %s, port %d\n",
inet_ntop (AF_INET, &sa_cli.sin_addr, topbuf,
sizeof (topbuf)), ntohs (sa_cli.sin_port));
gnutls_transport_set_ptr (session, (gnutls_transport_ptr_t) sd);
ret = gnutls_handshake (session);
if (ret < 0)
{
close (sd);
gnutls_deinit (session);
fprintf (stderr, "*** Handshake has failed (%s)\n\n",
gnutls_strerror (ret));
continue;
}
printf ("- Handshake was completed\n");
/* print_info(session); */
i = 0;
for (;;)
{
memset (buffer, 0, MAX_BUF + 1);
ret = gnutls_record_recv (session, buffer, MAX_BUF);
if (ret == 0)
{
printf ("\n- Peer has closed the TLS connection\n");
break;
}
else if (ret < 0)
{
fprintf (stderr, "\n*** Received corrupted "
"data(%d). Closing the connection.\n\n", ret);
break;
}
else if (ret > 0)
{
/* echo data back to the client
*/
gnutls_record_send (session, buffer, strlen (buffer));
}
}
printf ("\n");
/* do not wait for the peer to close the connection.
*/
gnutls_bye (session, GNUTLS_SHUT_WR);
close (sd);
gnutls_deinit (session);
}
close (listen_sd);
gnutls_certificate_free_credentials (cert_cred);
gnutls_global_deinit ();
return 0;
}
/* Functions and other stuff needed for session resuming.
* This is done using a very simple list which holds session ids
* and session data.
*/
#define MAX_SESSION_ID_SIZE 32
#define MAX_SESSION_DATA_SIZE 512
typedef struct
{
char session_id[MAX_SESSION_ID_SIZE];
int session_id_size;
char session_data[MAX_SESSION_DATA_SIZE];
int session_data_size;
} CACHE;
static CACHE *cache_db;
static int cache_db_ptr = 0;
static void
wrap_db_init (void)
{
/* allocate cache_db */
cache_db = calloc (1, TLS_SESSION_CACHE * sizeof (CACHE));
}
static void
wrap_db_deinit (void)
{
return;
}
static int
wrap_db_store (void *dbf, gnutls_datum_t key, gnutls_datum_t data)
{
if (cache_db == NULL)
return -1;
if (key.size > MAX_SESSION_ID_SIZE)
return -1;
if (data.size > MAX_SESSION_DATA_SIZE)
return -1;
memcpy (cache_db[cache_db_ptr].session_id, key.data, key.size);
cache_db[cache_db_ptr].session_id_size = key.size;
memcpy (cache_db[cache_db_ptr].session_data, data.data, data.size);
cache_db[cache_db_ptr].session_data_size = data.size;
cache_db_ptr++;
cache_db_ptr %= TLS_SESSION_CACHE;
return 0;
}
static gnutls_datum_t
wrap_db_fetch (void *dbf, gnutls_datum_t key)
{
gnutls_datum_t res = { NULL, 0 };
int i;
if (cache_db == NULL)
return res;
for (i = 0; i < TLS_SESSION_CACHE; i++)
{
if (key.size == cache_db[i].session_id_size &&
memcmp (key.data, cache_db[i].session_id, key.size) == 0)
{
res.size = cache_db[i].session_data_size;
res.data = gnutls_malloc (res.size);
if (res.data == NULL)
return res;
memcpy (res.data, cache_db[i].session_data, res.size);
return res;
}
}
return res;
}
static int
wrap_db_delete (void *dbf, gnutls_datum_t key)
{
int i;
if (cache_db == NULL)
return -1;
for (i = 0; i < TLS_SESSION_CACHE; i++)
{
if (key.size == cache_db[i].session_id_size &&
memcmp (key.data, cache_db[i].session_id, key.size) == 0)
{
cache_db[i].session_id_size = 0;
cache_db[i].session_data_size = 0;
return 0;
}
}
return -1;
}
The following example is an echo server which supports OpenPGP key authentication. You can easily combine this functionality —that is have a server that supports both X.509 and OpenPGP certificates— but we separated them to keep these examples as simple as possible.
#if HAVE_CONFIG_H
# include <config.h>
#endif
#include <stdio.h>
#include <stdlib.h>
#include <errno.h>
#include <sys/types.h>
#include <sys/socket.h>
#include <arpa/inet.h>
#include <netinet/in.h>
#include <string.h>
#include <unistd.h>
#include <gnutls/gnutls.h>
/* Must be linked against gnutls-extra.
*/
#include <gnutls/extra.h>
#define KEYFILE "secret.asc"
#define CERTFILE "public.asc"
#define RINGFILE "ring.gpg"
/* This is a sample TLS 1.0-OpenPGP echo server.
*/
#define SA struct sockaddr
#define SOCKET_ERR(err,s) if(err==-1) {perror(s);return(1);}
#define MAX_BUF 1024
#define PORT 5556 /* listen to 5556 port */
#define DH_BITS 1024
/* These are global */
gnutls_certificate_credentials_t cred;
gnutls_dh_params_t dh_params;
static int
generate_dh_params (void)
{
/* Generate Diffie Hellman parameters - for use with DHE
* kx algorithms. These should be discarded and regenerated
* once a day, once a week or once a month. Depending on the
* security requirements.
*/
gnutls_dh_params_init (&dh_params);
gnutls_dh_params_generate2 (dh_params, DH_BITS);
return 0;
}
gnutls_session_t
initialize_tls_session (void)
{
gnutls_session_t session;
gnutls_init (&session, GNUTLS_SERVER);
/* avoid calling all the priority functions, since the defaults
* are adequate.
*/
gnutls_set_default_priority (session);
gnutls_credentials_set (session, GNUTLS_CRD_CERTIFICATE, cred);
/* request client certificate if any.
*/
gnutls_certificate_server_set_request (session, GNUTLS_CERT_REQUEST);
gnutls_dh_set_prime_bits (session, DH_BITS);
return session;
}
int
main (void)
{
int err, listen_sd, i;
int sd, ret;
struct sockaddr_in sa_serv;
struct sockaddr_in sa_cli;
int client_len;
char topbuf[512];
gnutls_session_t session;
char buffer[MAX_BUF + 1];
int optval = 1;
char name[256];
strcpy (name, "Echo Server");
/* this must be called once in the program
*/
gnutls_global_init ();
gnutls_certificate_allocate_credentials (&cred);
gnutls_certificate_set_openpgp_keyring_file (cred, RINGFILE);
gnutls_certificate_set_openpgp_key_file (cred, CERTFILE, KEYFILE);
generate_dh_params ();
gnutls_certificate_set_dh_params (cred, dh_params);
/* Socket operations
*/
listen_sd = socket (AF_INET, SOCK_STREAM, 0);
SOCKET_ERR (listen_sd, "socket");
memset (&sa_serv, '\0', sizeof (sa_serv));
sa_serv.sin_family = AF_INET;
sa_serv.sin_addr.s_addr = INADDR_ANY;
sa_serv.sin_port = htons (PORT); /* Server Port number */
setsockopt (listen_sd, SOL_SOCKET, SO_REUSEADDR, &optval, sizeof (int));
err = bind (listen_sd, (SA *) & sa_serv, sizeof (sa_serv));
SOCKET_ERR (err, "bind");
err = listen (listen_sd, 1024);
SOCKET_ERR (err, "listen");
printf ("%s ready. Listening to port '%d'.\n\n", name, PORT);
client_len = sizeof (sa_cli);
for (;;)
{
session = initialize_tls_session ();
sd = accept (listen_sd, (SA *) & sa_cli, &client_len);
printf ("- connection from %s, port %d\n",
inet_ntop (AF_INET, &sa_cli.sin_addr, topbuf,
sizeof (topbuf)), ntohs (sa_cli.sin_port));
gnutls_transport_set_ptr (session, (gnutls_transport_ptr_t) sd);
ret = gnutls_handshake (session);
if (ret < 0)
{
close (sd);
gnutls_deinit (session);
fprintf (stderr, "*** Handshake has failed (%s)\n\n",
gnutls_strerror (ret));
continue;
}
printf ("- Handshake was completed\n");
/* see the Getting peer's information example */
/* print_info(session); */
i = 0;
for (;;)
{
memset (buffer, 0, MAX_BUF + 1);
ret = gnutls_record_recv (session, buffer, MAX_BUF);
if (ret == 0)
{
printf ("\n- Peer has closed the GNUTLS connection\n");
break;
}
else if (ret < 0)
{
fprintf (stderr, "\n*** Received corrupted "
"data(%d). Closing the connection.\n\n", ret);
break;
}
else if (ret > 0)
{
/* echo data back to the client
*/
gnutls_record_send (session, buffer, strlen (buffer));
}
}
printf ("\n");
/* do not wait for the peer to close the connection.
*/
gnutls_bye (session, GNUTLS_SHUT_WR);
close (sd);
gnutls_deinit (session);
}
close (listen_sd);
gnutls_certificate_free_credentials (cred);
gnutls_global_deinit ();
return 0;
}
This is a server which supports SRP authentication. It is also possible to combine this functionality with a certificate server. Here it is separate for simplicity.
#if HAVE_CONFIG_H
# include <config.h>
#endif
#include <stdio.h>
#include <stdlib.h>
#include <errno.h>
#include <sys/types.h>
#include <sys/socket.h>
#include <arpa/inet.h>
#include <netinet/in.h>
#include <string.h>
#include <unistd.h>
#include <gnutls/gnutls.h>
#include <gnutls/extra.h>
#define SRP_PASSWD "tpasswd"
#define SRP_PASSWD_CONF "tpasswd.conf"
#define KEYFILE "key.pem"
#define CERTFILE "cert.pem"
#define CAFILE "ca.pem"
/* This is a sample TLS-SRP echo server.
*/
#define SA struct sockaddr
#define SOCKET_ERR(err,s) if(err==-1) {perror(s);return(1);}
#define MAX_BUF 1024
#define PORT 5556 /* listen to 5556 port */
/* These are global */
gnutls_srp_server_credentials_t srp_cred;
gnutls_certificate_credentials_t cert_cred;
gnutls_session_t
initialize_tls_session (void)
{
gnutls_session_t session;
const int kx_priority[] = { GNUTLS_KX_SRP, GNUTLS_KX_SRP_DSS,
GNUTLS_KX_SRP_RSA, 0
};
gnutls_init (&session, GNUTLS_SERVER);
gnutls_set_default_priority (session);
gnutls_kx_set_priority (session, kx_priority);
gnutls_credentials_set (session, GNUTLS_CRD_SRP, srp_cred);
/* for the certificate authenticated ciphersuites.
*/
gnutls_credentials_set (session, GNUTLS_CRD_CERTIFICATE, cert_cred);
/* request client certificate if any.
*/
gnutls_certificate_server_set_request (session, GNUTLS_CERT_IGNORE);
return session;
}
int
main (void)
{
int err, listen_sd, i;
int sd, ret;
struct sockaddr_in sa_serv;
struct sockaddr_in sa_cli;
int client_len;
char topbuf[512];
gnutls_session_t session;
char buffer[MAX_BUF + 1];
int optval = 1;
char name[256];
strcpy (name, "Echo Server");
/* these must be called once in the program
*/
gnutls_global_init ();
gnutls_global_init_extra (); /* for SRP */
/* SRP_PASSWD a password file (created with the included srptool utility)
*/
gnutls_srp_allocate_server_credentials (&srp_cred);
gnutls_srp_set_server_credentials_file (srp_cred, SRP_PASSWD,
SRP_PASSWD_CONF);
gnutls_certificate_allocate_credentials (&cert_cred);
gnutls_certificate_set_x509_trust_file (cert_cred, CAFILE,
GNUTLS_X509_FMT_PEM);
gnutls_certificate_set_x509_key_file (cert_cred, CERTFILE, KEYFILE,
GNUTLS_X509_FMT_PEM);
/* TCP socket operations
*/
listen_sd = socket (AF_INET, SOCK_STREAM, 0);
SOCKET_ERR (listen_sd, "socket");
memset (&sa_serv, '\0', sizeof (sa_serv));
sa_serv.sin_family = AF_INET;
sa_serv.sin_addr.s_addr = INADDR_ANY;
sa_serv.sin_port = htons (PORT); /* Server Port number */
setsockopt (listen_sd, SOL_SOCKET, SO_REUSEADDR, &optval, sizeof (int));
err = bind (listen_sd, (SA *) & sa_serv, sizeof (sa_serv));
SOCKET_ERR (err, "bind");
err = listen (listen_sd, 1024);
SOCKET_ERR (err, "listen");
printf ("%s ready. Listening to port '%d'.\n\n", name, PORT);
client_len = sizeof (sa_cli);
for (;;)
{
session = initialize_tls_session ();
sd = accept (listen_sd, (SA *) & sa_cli, &client_len);
printf ("- connection from %s, port %d\n",
inet_ntop (AF_INET, &sa_cli.sin_addr, topbuf,
sizeof (topbuf)), ntohs (sa_cli.sin_port));
gnutls_transport_set_ptr (session, (gnutls_transport_ptr_t) sd);
ret = gnutls_handshake (session);
if (ret < 0)
{
close (sd);
gnutls_deinit (session);
fprintf (stderr, "*** Handshake has failed (%s)\n\n",
gnutls_strerror (ret));
continue;
}
printf ("- Handshake was completed\n");
/* print_info(session); */
i = 0;
for (;;)
{
memset (buffer, 0, MAX_BUF + 1);
ret = gnutls_record_recv (session, buffer, MAX_BUF);
if (ret == 0)
{
printf ("\n- Peer has closed the GNUTLS connection\n");
break;
}
else if (ret < 0)
{
fprintf (stderr, "\n*** Received corrupted "
"data(%d). Closing the connection.\n\n", ret);
break;
}
else if (ret > 0)
{
/* echo data back to the client
*/
gnutls_record_send (session, buffer, strlen (buffer));
}
}
printf ("\n");
/* do not wait for the peer to close the connection. */
gnutls_bye (session, GNUTLS_SHUT_WR);
close (sd);
gnutls_deinit (session);
}
close (listen_sd);
gnutls_srp_free_server_credentials (srp_cred);
gnutls_certificate_free_credentials (cert_cred);
gnutls_global_deinit ();
return 0;
}
This example server support anonymous authentication, and could be used to serve the example client for anonymous authentication.
#if HAVE_CONFIG_H
# include <config.h>
#endif
#include <stdio.h>
#include <stdlib.h>
#include <errno.h>
#include <sys/types.h>
#include <sys/socket.h>
#include <arpa/inet.h>
#include <netinet/in.h>
#include <string.h>
#include <unistd.h>
#include <gnutls/gnutls.h>
/* This is a sample TLS 1.0 echo server, for anonymous authentication only.
*/
#define SA struct sockaddr
#define SOCKET_ERR(err,s) if(err==-1) {perror(s);return(1);}
#define MAX_BUF 1024
#define PORT 5556 /* listen to 5556 port */
#define DH_BITS 1024
/* These are global */
gnutls_anon_server_credentials_t anoncred;
gnutls_session_t
initialize_tls_session (void)
{
gnutls_session_t session;
const int kx_prio[] = { GNUTLS_KX_ANON_DH, 0 };
gnutls_init (&session, GNUTLS_SERVER);
/* avoid calling all the priority functions, since the defaults
* are adequate.
*/
gnutls_set_default_priority (session);
gnutls_kx_set_priority (session, kx_prio);
gnutls_credentials_set (session, GNUTLS_CRD_ANON, anoncred);
gnutls_dh_set_prime_bits (session, DH_BITS);
return session;
}
static gnutls_dh_params_t dh_params;
static int
generate_dh_params (void)
{
/* Generate Diffie Hellman parameters - for use with DHE
* kx algorithms. These should be discarded and regenerated
* once a day, once a week or once a month. Depending on the
* security requirements.
*/
gnutls_dh_params_init (&dh_params);
gnutls_dh_params_generate2 (dh_params, DH_BITS);
return 0;
}
int
main (void)
{
int err, listen_sd, i;
int sd, ret;
struct sockaddr_in sa_serv;
struct sockaddr_in sa_cli;
int client_len;
char topbuf[512];
gnutls_session_t session;
char buffer[MAX_BUF + 1];
int optval = 1;
/* this must be called once in the program
*/
gnutls_global_init ();
gnutls_anon_allocate_server_credentials (&anoncred);
generate_dh_params ();
gnutls_anon_set_server_dh_params (anoncred, dh_params);
/* Socket operations
*/
listen_sd = socket (AF_INET, SOCK_STREAM, 0);
SOCKET_ERR (listen_sd, "socket");
memset (&sa_serv, '\0', sizeof (sa_serv));
sa_serv.sin_family = AF_INET;
sa_serv.sin_addr.s_addr = INADDR_ANY;
sa_serv.sin_port = htons (PORT); /* Server Port number */
setsockopt (listen_sd, SOL_SOCKET, SO_REUSEADDR, &optval, sizeof (int));
err = bind (listen_sd, (SA *) & sa_serv, sizeof (sa_serv));
SOCKET_ERR (err, "bind");
err = listen (listen_sd, 1024);
SOCKET_ERR (err, "listen");
printf ("Server ready. Listening to port '%d'.\n\n", PORT);
client_len = sizeof (sa_cli);
for (;;)
{
session = initialize_tls_session ();
sd = accept (listen_sd, (SA *) & sa_cli, &client_len);
printf ("- connection from %s, port %d\n",
inet_ntop (AF_INET, &sa_cli.sin_addr, topbuf,
sizeof (topbuf)), ntohs (sa_cli.sin_port));
gnutls_transport_set_ptr (session, (gnutls_transport_ptr_t) sd);
ret = gnutls_handshake (session);
if (ret < 0)
{
close (sd);
gnutls_deinit (session);
fprintf (stderr, "*** Handshake has failed (%s)\n\n",
gnutls_strerror (ret));
continue;
}
printf ("- Handshake was completed\n");
/* see the Getting peer's information example */
/* print_info(session); */
i = 0;
for (;;)
{
memset (buffer, 0, MAX_BUF + 1);
ret = gnutls_record_recv (session, buffer, MAX_BUF);
if (ret == 0)
{
printf ("\n- Peer has closed the GNUTLS connection\n");
break;
}
else if (ret < 0)
{
fprintf (stderr, "\n*** Received corrupted "
"data(%d). Closing the connection.\n\n", ret);
break;
}
else if (ret > 0)
{
/* echo data back to the client
*/
gnutls_record_send (session, buffer, strlen (buffer));
}
}
printf ("\n");
/* do not wait for the peer to close the connection.
*/
gnutls_bye (session, GNUTLS_SHUT_WR);
close (sd);
gnutls_deinit (session);
}
close (listen_sd);
gnutls_anon_free_server_credentials (anoncred);
gnutls_global_deinit ();
return 0;
}
This example server support authorization data, and can be used to serve the example client with authorization support.
#if HAVE_CONFIG_H
# include <config.h>
#endif
#include <stdio.h>
#include <stdlib.h>
#include <errno.h>
#include <sys/types.h>
#include <sys/socket.h>
#include <arpa/inet.h>
#include <netinet/in.h>
#include <string.h>
#include <unistd.h>
#include <gnutls/gnutls.h>
#define KEYFILE "key.pem"
#define CERTFILE "cert.pem"
#define CAFILE "ca.pem"
#define CRLFILE "crl.pem"
/* This is a sample TLS 1.0 echo server, using X.509 authentication.
*/
#define SA struct sockaddr
#define SOCKET_ERR(err,s) if(err==-1) {perror(s);return(1);}
#define MAX_BUF 1024
#define PORT 5556 /* listen to 5556 port */
#define DH_BITS 1024
/* These are global */
gnutls_certificate_credentials_t x509_cred;
gnutls_session_t
initialize_tls_session (void)
{
gnutls_session_t session;
gnutls_init (&session, GNUTLS_SERVER);
/* avoid calling all the priority functions, since the defaults
* are adequate.
*/
gnutls_set_default_priority (session);
gnutls_credentials_set (session, GNUTLS_CRD_CERTIFICATE, x509_cred);
/* request client certificate if any.
*/
gnutls_certificate_server_set_request (session, GNUTLS_CERT_REQUEST);
gnutls_dh_set_prime_bits (session, DH_BITS);
return session;
}
static gnutls_dh_params_t dh_params;
static int
generate_dh_params (void)
{
/* Generate Diffie Hellman parameters - for use with DHE
* kx algorithms. These should be discarded and regenerated
* once a day, once a week or once a month. Depending on the
* security requirements.
*/
gnutls_dh_params_init (&dh_params);
gnutls_dh_params_generate2 (dh_params, DH_BITS);
return 0;
}
int server_authorized_p = 0;
int
authz_recv_callback (gnutls_session_t session,
const int *authz_formats,
gnutls_datum_t *infos,
const int *hashtypes,
gnutls_datum_t *hash)
{
size_t i, j;
/* This function receives authorization data. */
for (i = 0; authz_formats[i]; i++)
{
printf ("- Received authorization data, format %02x of %d bytes\n",
authz_formats[i], infos[i].size);
printf (" data: ");
for (j = 0; j < infos[i].size; j++)
printf ("%02x", infos[i].data[j]);
printf ("\n");
if (hash[i].size > 0)
{
printf (" hash: ");
for (j = 0; j < hash[i].size; j++)
printf ("%02x", hash[i].data[j]);
printf (" type %02x\n", hashtypes[i]);
}
}
/* You would typically actually _validate_ the data here... if you
need access to authentication details, store the authorization
data and do the validation inside main(). */
server_authorized_p = 1;
return 0;
}
int
authz_send_callback (gnutls_session_t session,
const int *client_formats,
const int *server_formats)
{
const char *str = "saml assertion";
/* Send the authorization data here. client_formats and
server_formats contains a list of negotiated authorization
formats. */
return gnutls_authz_send_saml_assertion (session, str, sizeof (str));
}
int
main (void)
{
int err, listen_sd, i;
int sd, ret;
struct sockaddr_in sa_serv;
struct sockaddr_in sa_cli;
int client_len;
char topbuf[512];
gnutls_session_t session;
char buffer[MAX_BUF + 1];
int optval = 1;
const int authz_server_formats[] = {
GNUTLS_AUTHZ_SAML_ASSERTION,
};
const int authz_client_formats[] = {
GNUTLS_AUTHZ_X509_ATTR_CERT,
GNUTLS_AUTHZ_SAML_ASSERTION,
GNUTLS_AUTHZ_X509_ATTR_CERT_URL,
GNUTLS_AUTHZ_SAML_ASSERTION_URL
};
/* this must be called once in the program
*/
gnutls_global_init ();
gnutls_certificate_allocate_credentials (&x509_cred);
gnutls_certificate_set_x509_trust_file (x509_cred, CAFILE,
GNUTLS_X509_FMT_PEM);
gnutls_certificate_set_x509_crl_file (x509_cred, CRLFILE,
GNUTLS_X509_FMT_PEM);
gnutls_certificate_set_x509_key_file (x509_cred, CERTFILE, KEYFILE,
GNUTLS_X509_FMT_PEM);
generate_dh_params ();
gnutls_certificate_set_dh_params (x509_cred, dh_params);
/* Socket operations
*/
listen_sd = socket (AF_INET, SOCK_STREAM, 0);
SOCKET_ERR (listen_sd, "socket");
memset (&sa_serv, '\0', sizeof (sa_serv));
sa_serv.sin_family = AF_INET;
sa_serv.sin_addr.s_addr = INADDR_ANY;
sa_serv.sin_port = htons (PORT); /* Server Port number */
setsockopt (listen_sd, SOL_SOCKET, SO_REUSEADDR, &optval, sizeof (int));
err = bind (listen_sd, (SA *) & sa_serv, sizeof (sa_serv));
SOCKET_ERR (err, "bind");
err = listen (listen_sd, 1024);
SOCKET_ERR (err, "listen");
printf ("Server ready. Listening to port '%d'.\n\n", PORT);
client_len = sizeof (sa_cli);
for (;;)
{
session = initialize_tls_session ();
sd = accept (listen_sd, (SA *) & sa_cli, &client_len);
printf ("- connection from %s, port %d\n",
inet_ntop (AF_INET, &sa_cli.sin_addr, topbuf,
sizeof (topbuf)), ntohs (sa_cli.sin_port));
gnutls_transport_set_ptr (session, (gnutls_transport_ptr_t) sd);
gnutls_authz_enable (session, authz_client_formats, authz_server_formats,
authz_recv_callback, authz_send_callback);
ret = gnutls_handshake (session);
if (ret < 0)
{
close (sd);
gnutls_deinit (session);
fprintf (stderr, "*** Handshake has failed (%s)\n\n",
gnutls_strerror (ret));
continue;
}
if (!server_authorized_p)
{
fprintf (stderr, "*** Not authorized, giving up...\n");
ret = gnutls_alert_send (session, GNUTLS_AL_FATAL,
GNUTLS_A_ACCESS_DENIED);
if (ret < 0)
continue;
}
printf ("- Handshake was completed\n");
/* see the Getting peer's information example */
/* print_info(session); */
i = 0;
for (;;)
{
memset (buffer, 0, MAX_BUF + 1);
ret = gnutls_record_recv (session, buffer, MAX_BUF);
if (ret == 0)
{
printf ("\n- Peer has closed the GNUTLS connection\n");
break;
}
else if (ret < 0)
{
fprintf (stderr, "\n*** Received corrupted "
"data(%d). Closing the connection.\n\n", ret);
break;
}
else if (ret > 0)
{
/* echo data back to the client
*/
gnutls_record_send (session, buffer, strlen (buffer));
}
}
printf ("\n");
/* do not wait for the peer to close the connection.
*/
gnutls_bye (session, GNUTLS_SHUT_WR);
close (sd);
gnutls_deinit (session);
}
close (listen_sd);
gnutls_certificate_free_credentials (x509_cred);
gnutls_global_deinit ();
return 0;
}
This is a function that checks if an alert has been received in the current session.
#if HAVE_CONFIG_H
# include <config.h>
#endif
#include <stdio.h>
#include <stdlib.h>
#include <gnutls/gnutls.h>
/* This function will check whether the given return code from
* a gnutls function (recv/send), is an alert, and will print
* that alert.
*/
void
check_alert (gnutls_session_t session, int ret)
{
int last_alert;
if (ret == GNUTLS_E_WARNING_ALERT_RECEIVED
|| ret == GNUTLS_E_FATAL_ALERT_RECEIVED)
{
last_alert = gnutls_alert_get (session);
/* The check for renegotiation is only useful if we are
* a server, and we had requested a rehandshake.
*/
if (last_alert == GNUTLS_A_NO_RENEGOTIATION &&
ret == GNUTLS_E_WARNING_ALERT_RECEIVED)
printf ("* Received NO_RENEGOTIATION alert. "
"Client Does not support renegotiation.\n");
else
printf ("* Received alert '%d': %s.\n", last_alert,
gnutls_alert_get_name (last_alert));
}
}
To demonstrate the X.509 parsing capabilities an example program is listed below. That program reads the peer's certificate, and prints information about it.
#if HAVE_CONFIG_H
# include <config.h>
#endif
#include <stdio.h>
#include <stdlib.h>
#include <gnutls/gnutls.h>
#include <gnutls/x509.h>
static const char *
bin2hex (const void *bin, size_t bin_size)
{
static char printable[110];
const unsigned char *_bin = bin;
char *print;
size_t i;
if (bin_size > 50)
bin_size = 50;
print = printable;
for (i = 0; i < bin_size; i++)
{
sprintf (print, "%.2x ", _bin[i]);
print += 2;
}
return printable;
}
/* This function will print information about this session's peer
* certificate.
*/
void
print_x509_certificate_info (gnutls_session_t session)
{
char serial[40];
char dn[128];
size_t size;
unsigned int algo, bits;
time_t expiration_time, activation_time;
const gnutls_datum_t *cert_list;
unsigned int cert_list_size = 0;
gnutls_x509_crt_t cert;
/* This function only works for X.509 certificates.
*/
if (gnutls_certificate_type_get (session) != GNUTLS_CRT_X509)
return;
cert_list = gnutls_certificate_get_peers (session, &cert_list_size);
printf ("Peer provided %d certificates.\n", cert_list_size);
if (cert_list_size > 0)
{
/* we only print information about the first certificate.
*/
gnutls_x509_crt_init (&cert);
gnutls_x509_crt_import (cert, &cert_list[0], GNUTLS_X509_FMT_DER);
printf ("Certificate info:\n");
expiration_time = gnutls_x509_crt_get_expiration_time (cert);
activation_time = gnutls_x509_crt_get_activation_time (cert);
printf ("\tCertificate is valid since: %s", ctime (&activation_time));
printf ("\tCertificate expires: %s", ctime (&expiration_time));
/* Print the serial number of the certificate.
*/
size = sizeof (serial);
gnutls_x509_crt_get_serial (cert, serial, &size);
size = sizeof (serial);
printf ("\tCertificate serial number: %s\n", bin2hex (serial, size));
/* Extract some of the public key algorithm's parameters
*/
algo = gnutls_x509_crt_get_pk_algorithm (cert, &bits);
printf ("Certificate public key: %s",
gnutls_pk_algorithm_get_name (algo));
/* Print the version of the X.509
* certificate.
*/
printf ("\tCertificate version: #%d\n",
gnutls_x509_crt_get_version (cert));
size = sizeof (dn);
gnutls_x509_crt_get_dn (cert, dn, &size);
printf ("\tDN: %s\n", dn);
size = sizeof (dn);
gnutls_x509_crt_get_issuer_dn (cert, dn, &size);
printf ("\tIssuer's DN: %s\n", dn);
gnutls_x509_crt_deinit (cert);
}
}
The following example is about generating a certificate request, and a private key. A certificate request can be later be processed by a CA, which should return a signed certificate.
#if HAVE_CONFIG_H
# include <config.h>
#endif
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <gnutls/gnutls.h>
#include <gnutls/x509.h>
#include <time.h>
/* This example will generate a private key and a certificate
* request.
*/
int
main (void)
{
gnutls_x509_crq_t crq;
gnutls_x509_privkey_t key;
unsigned char buffer[10 * 1024];
size_t buffer_size = sizeof (buffer);
gnutls_global_init ();
/* Initialize an empty certificate request, and
* an empty private key.
*/
gnutls_x509_crq_init (&crq);
gnutls_x509_privkey_init (&key);
/* Generate a 1024 bit RSA private key.
*/
gnutls_x509_privkey_generate (key, GNUTLS_PK_RSA, 1024, 0);
/* Add stuff to the distinguished name
*/
gnutls_x509_crq_set_dn_by_oid (crq, GNUTLS_OID_X520_COUNTRY_NAME,
0, "GR", 2);
gnutls_x509_crq_set_dn_by_oid (crq, GNUTLS_OID_X520_COMMON_NAME,
0, "Nikos", strlen ("Nikos"));
/* Set the request version.
*/
gnutls_x509_crq_set_version (crq, 1);
/* Set a challenge password.
*/
gnutls_x509_crq_set_challenge_password (crq, "something to remember here");
/* Associate the request with the private key
*/
gnutls_x509_crq_set_key (crq, key);
/* Self sign the certificate request.
*/
gnutls_x509_crq_sign (crq, key);
/* Export the PEM encoded certificate request, and
* display it.
*/
gnutls_x509_crq_export (crq, GNUTLS_X509_FMT_PEM, buffer, &buffer_size);
printf ("Certificate Request: \n%s", buffer);
/* Export the PEM encoded private key, and
* display it.
*/
buffer_size = sizeof (buffer);
gnutls_x509_privkey_export (key, GNUTLS_X509_FMT_PEM, buffer, &buffer_size);
printf ("\n\nPrivate key: \n%s", buffer);
gnutls_x509_crq_deinit (crq);
gnutls_x509_privkey_deinit (key);
return 0;
}
The following example is about generating a PKCS #12 structure.
#if HAVE_CONFIG_H
# include <config.h>
#endif
#include <stdio.h>
#include <stdlib.h>
#include <gnutls/gnutls.h>
#include <gnutls/pkcs12.h>
#define OUTFILE "out.p12"
/* This function will write a pkcs12 structure into a file.
* cert: is a DER encoded certificate
* pkcs8_key: is a PKCS #8 encrypted key (note that this must be
* encrypted using a PKCS #12 cipher, or some browsers will crash)
* password: is the password used to encrypt the PKCS #12 packet.
*/
int
write_pkcs12 (const gnutls_datum_t * cert,
const gnutls_datum_t * pkcs8_key, const char *password)
{
gnutls_pkcs12_t pkcs12;
int ret, bag_index;
gnutls_pkcs12_bag_t bag, key_bag;
char pkcs12_struct[10 * 1024];
size_t pkcs12_struct_size;
FILE *fd;
/* A good idea might be to use gnutls_x509_privkey_get_key_id()
* to obtain a unique ID.
*/
gnutls_datum_t key_id = { "\x00\x00\x07", 3 };
gnutls_global_init ();
/* Firstly we create two helper bags, which hold the certificate,
* and the (encrypted) key.
*/
gnutls_pkcs12_bag_init (&bag);
gnutls_pkcs12_bag_init (&key_bag);
ret = gnutls_pkcs12_bag_set_data (bag, GNUTLS_BAG_CERTIFICATE, cert);
if (ret < 0)
{
fprintf (stderr, "ret: %s\n", gnutls_strerror (ret));
return 1;
}
/* ret now holds the bag's index.
*/
bag_index = ret;
/* Associate a friendly name with the given certificate. Used
* by browsers.
*/
gnutls_pkcs12_bag_set_friendly_name (bag, bag_index, "My name");
/* Associate the certificate with the key using a unique key
* ID.
*/
gnutls_pkcs12_bag_set_key_id (bag, bag_index, &key_id);
/* use weak encryption for the certificate.
*/
gnutls_pkcs12_bag_encrypt (bag, password, GNUTLS_PKCS_USE_PKCS12_RC2_40);
/* Now the key.
*/
ret = gnutls_pkcs12_bag_set_data (key_bag,
GNUTLS_BAG_PKCS8_ENCRYPTED_KEY,
pkcs8_key);
if (ret < 0)
{
fprintf (stderr, "ret: %s\n", gnutls_strerror (ret));
return 1;
}
/* Note that since the PKCS #8 key is already encrypted we don't
* bother encrypting that bag.
*/
bag_index = ret;
gnutls_pkcs12_bag_set_friendly_name (key_bag, bag_index, "My name");
gnutls_pkcs12_bag_set_key_id (key_bag, bag_index, &key_id);
/* The bags were filled. Now create the PKCS #12 structure.
*/
gnutls_pkcs12_init (&pkcs12);
/* Insert the two bags in the PKCS #12 structure.
*/
gnutls_pkcs12_set_bag (pkcs12, bag);
gnutls_pkcs12_set_bag (pkcs12, key_bag);
/* Generate a message authentication code for the PKCS #12
* structure.
*/
gnutls_pkcs12_generate_mac (pkcs12, password);
pkcs12_struct_size = sizeof (pkcs12_struct);
ret =
gnutls_pkcs12_export (pkcs12, GNUTLS_X509_FMT_DER, pkcs12_struct,
&pkcs12_struct_size);
if (ret < 0)
{
fprintf (stderr, "ret: %s\n", gnutls_strerror (ret));
return 1;
}
fd = fopen (OUTFILE, "w");
if (fd == NULL)
{
fprintf (stderr, "cannot open file\n");
return 1;
}
fwrite (pkcs12_struct, 1, pkcs12_struct_size, fd);
fclose (fd);
gnutls_pkcs12_bag_deinit (bag);
gnutls_pkcs12_bag_deinit (key_bag);
gnutls_pkcs12_deinit (pkcs12);
return 0;
}
To ease GnuTLS' integration with existing applications, a
compatibility layer with the widely used OpenSSL library is included
in the gnutls-openssl library. This compatibility layer is not
complete and it is not intended to completely reimplement the OpenSSL
API with GnuTLS. It only provides source-level
compatibility. There is currently no attempt to make it
binary-compatible with OpenSSL.
The prototypes for the compatibility functions are in the gnutls/openssl.h header file.
Current limitations imposed by the compatibility layer include:
Included with GnuTLS are also a few command line tools that let you use the library for common tasks without writing an application. The applications are discussed in this chapter.
The srptool is a very simple program that emulates the programs in the Stanford SRP libraries. It is intended for use in places where you don't expect SRP authentication to be the used for system users. Traditionally libsrp used two files. One called 'tpasswd' which holds usernames and verifiers, and 'tpasswd.conf' which holds generators and primes.
How to use srptool:
$ srptool --create-conf /etc/tpasswd.conf
$ srptool --passwd /etc/tpasswd \
--passwd-conf /etc/tpasswd.conf -u test
$ srptool --passwd /etc/tpasswd \
--passwd-conf /etc/tpasswd.conf --verify -u test
Simple client program to set up a TLS connection to some other computer. It sets up a TLS connection and forwards data from the standard input to the secured socket and vice versa.
GNU TLS test client
Usage: gnutls-cli [options] hostname
-d, --debug integer Enable debugging
-r, --resume Connect, establish a session. Connect
again and resume this session.
-s, --starttls Connect, establish a plain session and
start TLS when EOF or a SIGALRM is
received.
--crlf Send CR LF instead of LF.
--x509fmtder Use DER format for certificates to read
from.
-f, --fingerprint Send the openpgp fingerprint, instead
of the key.
--disable-extensions Disable all the TLS extensions.
--xml Print the certificate information in
XML format.
--print-cert Print the certificate in PEM format.
-p, --port integer The port to connect to.
--recordsize integer The maximum record size to advertize.
-V, --verbose More verbose output.
--ciphers cipher1 cipher2...
Ciphers to enable.
--protocols protocol1 protocol2...
Protocols to enable.
--comp comp1 comp2... Compression methods to enable.
--macs mac1 mac2... MACs to enable.
--kx kx1 kx2... Key exchange methods to enable.
--ctypes certType1 certType2...
Certificate types to enable.
--x509cafile FILE Certificate file to use.
--x509crlfile FILE CRL file to use.
--pgpkeyfile FILE PGP Key file to use.
--pgpkeyring FILE PGP Key ring file to use.
--pgptrustdb FILE PGP trustdb file to use.
--pgpcertfile FILE PGP Public Key (certificate) file to
use.
--x509keyfile FILE X.509 key file to use.
--x509certfile FILE X.509 Certificate file to use.
--srpusername NAME SRP username to use.
--srppasswd PASSWD SRP password to use.
--insecure Don't abort program if server
certificate can't be validated.
-l, --list Print a list of the supported
algorithms and modes.
-h, --help prints this help
-v, --version prints the program's version number
--copyright prints the program's license
This program was created to assist in debugging GnuTLS, but it might be useful to extract a TLS server's capabilities. It's purpose is to connect onto a TLS server, perform some tests and print the server's capabilities. If called with the `-v' parameter a more checks will be performed. An example output is:
crystal:/cvs/gnutls/src$ ./gnutls-cli-debug localhost -p 5556
Resolving 'localhost'...
Connecting to '127.0.0.1:5556'...
Checking for TLS 1.1 support... yes
Checking fallback from TLS 1.1 to... N/A
Checking for TLS 1.0 support... yes
Checking for SSL 3.0 support... yes
Checking for version rollback bug in RSA PMS... no
Checking for version rollback bug in Client Hello... no
Checking whether we need to disable TLS 1.0... N/A
Checking whether the server ignores the RSA PMS version... no
Checking whether the server can accept Hello Extensions... yes
Checking whether the server can accept cipher suites not in SSL 3.0 spec... yes
Checking whether the server can accept a bogus TLS record version in the client hello... yes
Checking for certificate information... N/A
Checking for trusted CAs... N/A
Checking whether the server understands TLS closure alerts... yes
Checking whether the server supports session resumption... yes
Checking for export-grade ciphersuite support... no
Checking RSA-export ciphersuite info... N/A
Checking for anonymous authentication support... no
Checking anonymous Diffie Hellman group info... N/A
Checking for ephemeral Diffie Hellman support... no
Checking ephemeral Diffie Hellman group info... N/A
Checking for AES cipher support (TLS extension)... yes
Checking for 3DES cipher support... yes
Checking for ARCFOUR 128 cipher support... yes
Checking for ARCFOUR 40 cipher support... no
Checking for MD5 MAC support... yes
Checking for SHA1 MAC support... yes
Checking for ZLIB compression support (TLS extension)... yes
Checking for LZO compression support (GnuTLS extension)... yes
Checking for max record size (TLS extension)... yes
Checking for SRP authentication support (TLS extension)... yes
Checking for OpenPGP authentication support (TLS extension)... no
Simple server program that listens to incoming TLS connections.
GNU TLS test server
Usage: gnutls-serv [options]
-d, --debug integer Enable debugging
-g, --generate Generate Diffie Hellman Parameters.
-p, --port integer The port to connect to.
-q, --quiet Suppress some messages.
--nodb Does not use the resume database.
--http Act as an HTTP Server.
--echo Act as an Echo Server.
--dhparams FILE DH params file to use.
--x509fmtder Use DER format for certificates
--x509cafile FILE Certificate file to use.
--x509crlfile FILE CRL file to use.
--pgpkeyring FILE PGP Key ring file to use.
--pgptrustdb FILE PGP trustdb file to use.
--pgpkeyfile FILE PGP Key file to use.
--pgpcertfile FILE PGP Public Key (certificate) file to
use.
--x509keyfile FILE X.509 key file to use.
--x509certfile FILE X.509 Certificate file to use.
--x509dsakeyfile FILE Alternative X.509 key file to use.
--x509dsacertfile FILE Alternative X.509 certificate file to
use.
--srppasswd FILE SRP password file to use.
--srppasswdconf FILE SRP password conf file to use.
--ciphers cipher1 cipher2...
Ciphers to enable.
--protocols protocol1 protocol2...
Protocols to enable.
--comp comp1 comp2... Compression methods to enable.
--macs mac1 mac2... MACs to enable.
--kx kx1 kx2... Key exchange methods to enable.
--ctypes certType1 certType2...
Certificate types to enable.
-l, --list Print a list of the supported
algorithms and modes.
-h, --help prints this help
-v, --version prints the program's version number
--copyright prints the program's license
Running your own TLS server based on GnuTLS can be useful when
debugging clients and/or GnuTLS itself. This section describes how to
use gnutls-serv as a simple HTTPS server.
The most basic server can be started as:
gnutls-serv --http
It will only support anonymous ciphersuites, which many TLS clients refuse to use.
The next step is to add support for X.509. First we generate a CA:
certtool --generate-privkey > x509-ca-key.pem
echo 'cn = GnuTLS test CA' > ca.tmpl
echo 'ca' >> ca.tmpl
echo 'cert_signing_key' >> ca.tmpl
certtool --generate-self-signed --load-privkey x509-ca-key.pem \
--template ca.tmpl --outfile x509-ca.pem
...
Then generate a server certificate. Remember to change the dns_name value to the name of your server host, or skip that command to avoid the field.
certtool --generate-privkey > x509-server-key.pem
echo 'organization = GnuTLS test server' > server.tmpl
echo 'cn = test.gnutls.org' >> server.tmpl
echo 'tls_www_server' >> server.tmpl
echo 'encryption_key' >> server.tmpl
echo 'signing_key' >> server.tmpl
echo 'dns_name = test.gnutls.org' >> server.tmpl
certtool --generate-certificate --load-privkey x509-server-key.pem \
--load-ca-certificate x509-ca.pem --load-ca-privkey x509-ca-key.pem \
--template server.tmpl --outfile x509-server.pem
...
For use in the client, you may want to generate a client certificate as well.
certtool --generate-privkey > x509-client-key.pem
echo 'cn = GnuTLS test client' > client.tmpl
echo 'tls_www_client' >> client.tmpl
echo 'encryption_key' >> client.tmpl
echo 'signing_key' >> client.tmpl
certtool --generate-certificate --load-privkey x509-client-key.pem \
--load-ca-certificate x509-ca.pem --load-ca-privkey x509-ca-key.pem \
--template client.tmpl --outfile x509-client.pem
...
For icing, we'll create a proxy certificate for the client too.
certtool --generate-privkey > x509-proxy-key.pem
echo 'cn = GnuTLS test client proxy' > proxy.tmpl
certtool --generate-proxy --load-privkey x509-proxy-key.pem \
--load-ca-certificate x509-client.pem --load-ca-privkey x509-client-key.pem \
--load-certificate x509-client.pem --template proxy.tmpl \
--outfile x509-proxy.pem
...
Then start the server again:
gnutls-serv --http \
--x509cafile x509-ca.pem \
--x509keyfile x509-server-key.pem \
--x509certfile x509-server.pem
Try connecting to the server using your web browser. Note that the server listens to port 5556 by default.
While you are at it, to allow connections using DSA, you can also create a DSA key and certificate for the server. These credentials will be used in the final example below.
certtool --generate-privkey --dsa > x509-server-key-dsa.pem
certtool --generate-certificate --load-privkey x509-server-key-dsa.pem \
--load-ca-certificate x509-ca.pem --load-ca-privkey x509-ca-key.pem \
--template server.tmpl --outfile x509-server-dsa.pem
...
The next step is to create OpenPGP credentials for the server.
gpg --gen-key
...enter whatever details you want, use 'test.gnutls.org' as name...
Make a note of the OpenPGP key identifier of the newly generated key,
here it was 5D1D14D8. You will need to export the key for
GnuTLS to be able to use it.
gpg -a --export 5D1D14D8 > openpgp-server.txt
gpg --export 5D1D14D8 > openpgp-server.bin
gpg --export-secret-keys 5D1D14D8 > openpgp-server-key.bin
gpg -a --export-secret-keys 5D1D14D8 > openpgp-server-key.txt
Let's start the server with support for OpenPGP credentials:
gnutls-serv --http \
--pgpkeyfile openpgp-server-key.txt \
--pgpcertfile openpgp-server.txt
The next step is to add support for SRP authentication.
srptool --create-conf srp-tpasswd.conf
srptool --passwd-conf srp-tpasswd.conf --username jas --passwd srp-passwd.txt
Enter password: [TYPE "foo"]
Start the server with SRP support:
gnutls-serv --http \
--srppasswdconf srp-tpasswd.conf \
--srppasswd srp-passwd.txt
Let's also add support for PSK.
$ psktool --passwd psk-passwd.txt
Start the server with PSK support:
gnutls-serv --http \
--pskpasswd psk-passwd.txt
Finally, we start the server with all the earlier parameters and you get this command:
gnutls-serv --http \
--x509cafile x509-ca.pem \
--x509keyfile x509-server-key.pem \
--x509certfile x509-server.pem \
--x509dsakeyfile x509-server-key-dsa.pem \
--x509dsacertfile x509-server-dsa.pem \
--pgpkeyfile openpgp-server-key.txt \
--pgpcertfile openpgp-server.txt \
--srppasswdconf srp-tpasswd.conf \
--srppasswd srp-passwd.txt \
--pskpasswd psk-passwd.txt
This is a program to generate X.509 certificates, certificate requests, CRLs and private keys.
Certtool help
Usage: certtool [options]
-s, --generate-self-signed
Generate a self-signed certificate.
-c, --generate-certificate
Generate a signed certificate.
--generate-proxy Generate a proxy certificate.
--generate-crl Generate a CRL.
-u, --update-certificate
Update a signed certificate.
-p, --generate-privkey Generate a private key.
-q, --generate-request Generate a PKCS #10 certificate
request.
-e, --verify-chain Verify a PEM encoded certificate chain.
The last certificate in the chain must
be a self signed one.
--verify-crl Verify a CRL.
--generate-dh-params Generate PKCS #3 encoded Diffie Hellman
parameters.
--get-dh-params Get the included PKCS #3 encoded Diffie
Hellman parameters.
--load-privkey FILE Private key file to use.
--load-request FILE Certificate request file to use.
--load-certificate FILE
Certificate file to use.
--load-ca-privkey FILE Certificate authority's private key
file to use.
--load-ca-certificate FILE
Certificate authority's certificate
file to use.
--password PASSWORD Password to use.
-i, --certificate-info Print information on a certificate.
-l, --crl-info Print information on a CRL.
--p12-info Print information on a PKCS #12
structure.
--p7-info Print information on a PKCS #7
structure.
--smime-to-p7 Convert S/MIME to PKCS #7 structure.
-k, --key-info Print information on a private key.
--fix-key Regenerate the parameters in a private
key.
--to-p12 Generate a PKCS #12 structure.
-8, --pkcs8 Use PKCS #8 format for private keys.
--dsa Use DSA keys.
--hash STR Hash algorithm to use for signing
(MD5,SHA1,RMD160).
--export-ciphers Use weak encryption algorithms.
--inder Use DER format for input certificates
and private keys.
--xml Use XML format for output certificates.
--outder Use DER format for output certificates
and private keys.
--bits BITS specify the number of bits for key
generation.
--outfile FILE Output file.
--infile FILE Input file.
--template FILE Template file to use for non
interactive operation.
-d, --debug LEVEL specify the debug level. Default is 1.
-h, --help shows this help text
-v, --version shows the program's version
--copyright shows the program's license
The program can be used interactively or non interactively by
specifying the --template command line option. See below for an
example of a template file.
How to use certtool interactively:
$ certtool --generate-dh-params --outfile dh.pem
$ certtool --generate-privkey --bits 512 --outfile rsa.pem
$ certtool --generate-privkey --outfile ca-key.pem
$ certtool --generate-self-signed --load-privkey ca-key.pem \
--outfile ca-cert.pem
Note that a self-signed certificate usually belongs to a certificate authority, that signs other certificates.
$ certtool --generate-privkey --outfile key.pem
$ certtool --generate-request --load-privkey key.pem \
--outfile request.pem
$ certtool --generate-certificate --load-request request.pem \
--outfile cert.pem \
--load-ca-certificate ca-cert.pem --load-ca-privkey ca-key.pem
$ certtool --certificate-info --infile cert.pem
$ certtool --load-certificate cert.pem --load-privkey key.pem \
--to-p12 --outder --outfile key.p12
$ certtool --generate-privkey > proxy-key.pem
$ certtool --generate-proxy --load-ca-privkey key.pem \
--load-privkey proxy-key.pem --load-certificate cert.pem \
--outfile proxy-cert.pem
Certtool's template file format:
$ certtool --generate-certificate cert.pem --load-privkey key.pem \
--template cert.cfg \
--load-ca-certificate ca-cert.pem --load-ca-privkey ca-key.pem
An example certtool template file:
# X.509 Certificate options
#
# DN options
# The organization of the subject.
organization = "Koko inc."
# The organizational unit of the subject.
unit = "sleeping dept."
# The locality of the subject.
# locality =
# The state of the certificate owner.
state = "Attiki"
# The country of the subject. Two letter code.
country = GR
# The common name of the certificate owner.
cn = "Cindy Lauper"
# A user id of the certificate owner.
#uid = "clauper"
# If the supported DN OIDs are not adequate you can set
# any OID here.
# For example set the X.520 Title and the X.520 Pseudonym
# by using OID and string pairs.
#dn_oid = "2.5.4.12" "Dr." "2.5.4.65" "jackal"
# This is deprecated and should not be used in new
# certificates.
# pkcs9_email = "none@none.org"
# The serial number of the certificate
serial = 007
# In how many days, counting from today, this certificate will expire.
expiration_days = 700
# X.509 v3 extensions
# A dnsname in case of a WWW server.
#dns_name = "www.none.org"
# An IP address in case of a server.
#ip_address = "192.168.1.1"
# An email in case of a person
email = "none@none.org"
# An URL that has CRLs (certificate revocation lists)
# available. Needed in CA certificates.
#crl_dist_points = "http://www.getcrl.crl/getcrl/"
# Whether this is a CA certificate or not
#ca
# Whether this certificate will be used for a TLS client
#tls_www_client
# Whether this certificate will be used for a TLS server
#tls_www_server
# Whether this certificate will be used to sign data (needed
# in TLS DHE ciphersuites).
signing_key
# Whether this certificate will be used to encrypt data (needed
# in TLS RSA ciphersuites). Note that it is prefered to use different
# keys for encryption and signing.
#encryption_key
# Whether this key will be used to sign other certificates.
#cert_signing_key
# Whether this key will be used to sign CRLs.
#crl_signing_key
# Whether this key will be used to sign code.
#code_signing_key
# Whether this key will be used to sign OCSP data.
#ocsp_signing_key
# Whether this key will be used for time stamping.
#time_stamping_key
The prototypes for the following functions lie in gnutls/gnutls.h.
alert: is an alert number
gnutls_session_tstructure.This function will return a string that describes the given alert number or NULL. See
gnutls_alert_get().
session: is a
gnutls_session_tstructure.This function will return the last alert number received. This function should be called if GNUTLS_E_WARNING_ALERT_RECEIVED or GNUTLS_E_FATAL_ALERT_RECEIVED has been returned by a gnutls function. The peer may send alerts if he thinks some things were not right. Check gnutls.h for the available alert descriptions.
If no alert has been received the returned value is undefined.
session: is a
gnutls_session_tstructure.err: is an integer
Sends an alert to the peer depending on the error code returned by a gnutls function. This function will call
gnutls_error_to_alert()to determine the appropriate alert to send.This function may also return GNUTLS_E_AGAIN, or GNUTLS_E_INTERRUPTED.
If the return value is GNUTLS_E_INVALID_REQUEST, then no alert has been sent to the peer.
Returns zero on success.
session: is a
gnutls_session_tstructure.level: is the level of the alert
desc: is the alert description
This function will send an alert to the peer in order to inform him of something important (eg. his Certificate could not be verified). If the alert level is Fatal then the peer is expected to close the connection, otherwise he may ignore the alert and continue.
The error code of the underlying record send function will be returned, so you may also receive GNUTLS_E_INTERRUPTED or GNUTLS_E_AGAIN as well.
Returns 0 on success.
sc: is a pointer to an
gnutls_anon_client_credentials_tstructure.This structure is complex enough to manipulate directly thus this helper function is provided in order to allocate it.
Returns a negative value in case of an error.
sc: is a pointer to an
gnutls_anon_server_credentials_tstructure.This structure is complex enough to manipulate directly thus this helper function is provided in order to allocate it.
Returns a negative value in case of an error.
sc: is an
gnutls_anon_client_credentials_tstructure.This structure is complex enough to manipulate directly thus this helper function is provided in order to free (deallocate) it.
sc: is an
gnutls_anon_server_credentials_tstructure.This structure is complex enough to manipulate directly thus this helper function is provided in order to free (deallocate) it.
res: is a gnutls_anon_server_credentials_t structure
func: is the function to be called
This function will set a callback in order for the server to get the diffie hellman or RSA parameters for anonymous authentication. The callback should return zero on success.
res: is a gnutls_anon_server_credentials_t structure
dh_params: is a structure that holds diffie hellman parameters.
This function will set the diffie hellman parameters for an anonymous server to use. These parameters will be used in Anonymous Diffie Hellman cipher suites.
res: is a gnutls_certificate_credentials_t structure
func: is the function to be called
This function will set a callback in order for the server to get the diffie hellman parameters for anonymous authentication. The callback should return zero on success.
session: is a
gnutls_session_tstructure.Returns the type of credentials that were used for client authentication. The returned information is to be used to distinguish the function used to access authentication data.
session: is a
gnutls_session_tstructure.Returns type of credentials for the current authentication schema. The returned information is to be used to distinguish the function used to access authentication data.
Eg. for CERTIFICATE ciphersuites (key exchange algorithms: KX_RSA, KX_DHE_RSA), the same function are to be used to access the authentication data.
session: is a
gnutls_session_tstructure.Returns the type of credentials that were used for server authentication. The returned information is to be used to distinguish the function used to access authentication data.
session: is a
gnutls_session_tstructure.client_formats: zero-terminated list of
gnutls_authz_data_format_type_telements with authorization data formats.server_formats: zero-terminated list of
gnutls_authz_data_format_type_telements with authorization data formats.recv_callback: your callback function which will receive authz information when it is received.
send_callback: your callback function which is responsible for generating authorization data to send.
Indicate willingness to send and receive authorization data, and which formats.
For clients,
client_formatsindicate which formats the client is willing to send, andserver_formatsindicate which formats the client can receive.For servers,
client_formatsindicate which formats the server is willing to accept from the client, andserver_formatsindicate which formats the server is willing to send. Before the list is sent to the client, the formats which the client do not support are removed. If no supported formats remains, either or both of the extensions will not be sent.The
send_callbackis invoked during the handshake if negotiation of the authorization extension was successful. The function prototype is:int (*gnutls_authz_send_callback_func) (gnutls_session_t
session, const int *client_formats, const int *server_formats);The
client_formatcontains a list of successfully negotiated formats which the client may send data for to the server. Theserver_formatscontains a list of successfully neogitated formats which the server may send data for to the client. The callback is supposed to invokegnutls_authz_send_x509_attr_cert(),gnutls_authz_send_saml_assertion(),gnutls_authz_send_x509_attr_cert_url(), orgnutls_authz_send_saml_assertion_url()for the data it wishes to send, passing along thesessionparameter, and the data. Theclient_formatfunction should return 0 on success, or an error code, which may be used to abort the handshake on failures.The
recv_callbackis invoked during the handshake when authorization data is received. The prototype of the callback should be:int (*gnutls_authz_recv_callback_func) (gnutls_session_t session, const char *authz_formats, gnutls_datum_t *datums);
The
authz_formatscontains a list of formats for which data where received. The data for each format is stored in thedatumsarray, where the data associated with theauthz_formats[0] format is stored indatums[0]. The function should return 0 on success, but may return an error, which may cause the handshake to abort.Note that there is no guarantee that
send_callbackorrecv_callbackis invoked just because gnutls_authz_enable was invoked. Whether the callbacks are invoked depend on whether negotiation of the extension succeeds. Therefor, if verification of authorization data is done by therecv_callback, care should be made that if the callback is never invoked, it is not interpretetd as successful authorization verification. It is suggested to add some logic check whether authorization data was successfully verified after the call tognutls_handshake(). That logic could shut down the connection if the authorization data is insufficient.This function have no effect if it is called during a handshake.
session: is a
gnutls_session_tstructure.url: buffer with a URL pointing to a SAML assertion.
urllen: length of buffer.
hash_type: type of hash in
hash.hash: buffer with hash of URL target.
Send a URL to a SAML assertion as authorization data, including a hash used to make sure the retrieved data was the intended data. This function may only be called inside a
send_callbackset bygnutls_authz_enable().Returns: Returns 0 on success, or an error code on failures. If the supplied data was too long (the authorization extension only support 64kb large URLs),
GNUTLS_E_INVALID_REQUESTis returned.
session: is a
gnutls_session_tstructure.data: buffer with a SAML assertion.
len: length of buffer.
Send a SAML assertion as authorization data. This function may only be called inside a
send_callbackset bygnutls_authz_enable().Returns: Returns 0 on success, or an error code on failures. If the supplied data was too long (the authorization extension only support 64kb large SAML assertions),
GNUTLS_E_INVALID_REQUESTis returned.
session: is a
gnutls_session_tstructure.url: buffer with a URL pointing to X.509 attribute certificate.
urllen: length of buffer.
hash_type: type of hash in
hash.hash: buffer with hash of URL target.
Send a URL to an X.509 attribute certificate as authorization data, including a hash used to make sure the retrieved data was the intended data. This function may only be called inside a
send_callbackset bygnutls_authz_enable().Returns: Returns 0 on success, or an error code on failures. If the supplied data was too long (the authorization extension only support 64kb large URLs),
GNUTLS_E_INVALID_REQUESTis returned.
session: is a
gnutls_session_tstructure.data: buffer with a X.509 attribute certificate.
len: length of buffer.
Send a X.509 attribute certificate as authorization data. This function may only be called inside a
send_callbackset bygnutls_authz_enable().Returns: Returns 0 on success, or an error code on failures. If the supplied data was too long (the authorization extension only support 64kb large attribute certificates),
GNUTLS_E_INVALID_REQUESTis returned.
session: is a
gnutls_session_tstructure.how: is an integer
Terminates the current TLS/SSL connection. The connection should have been initiated using
gnutls_handshake().howshould be one of GNUTLS_SHUT_RDWR, GNUTLS_SHUT_WR.In case of GNUTLS_SHUT_RDWR then the TLS connection gets terminated and further receives and sends will be disallowed. If the return value is zero you may continue using the connection. GNUTLS_SHUT_RDWR actually sends an alert containing a close request and waits for the peer to reply with the same message.
In case of GNUTLS_SHUT_WR then the TLS connection gets terminated and further sends will be disallowed. In order to reuse the connection you should wait for an EOF from the peer. GNUTLS_SHUT_WR sends an alert containing a close request.
Note that not all implementations will properly terminate a TLS connection. Some of them, usually for performance reasons, will terminate only the underlying transport layer, thus causing a transmission error to the peer. This error cannot be distinguished from a malicious party prematurely terminating the session, thus this behavior is not recommended.
This function may also return GNUTLS_E_AGAIN or GNUTLS_E_INTERRUPTED; cf.
gnutls_record_get_direction().
session: is a gnutls session
This function will return the peer's certificate activation time. This is the creation time for openpgp keys.
Returns (time_t) -1 on error.
res: is a pointer to an
gnutls_certificate_credentials_tstructure.This structure is complex enough to manipulate directly thus this helper function is provided in order to allocate it.
Returns 0 on success.
session: is a gnutls session
This function will return 0 if the peer (server) did not request client authentication or 1 otherwise. Returns a negative value in case of an error.
cred: is a
gnutls_certificate_credentials_tstructure.func: is the callback function
This function sets a callback to be called in order to retrieve the certificate to be used in the handshake. The callback's function prototype is: int (*callback)(gnutls_session_t, const gnutls_datum_t* req_ca_dn, int nreqs, gnutls_pk_algorithm_t* pk_algos, int pk_algos_length, gnutls_retr_st* st);
stshould contain the certificates and private keys.
req_ca_cert, is only used in X.509 certificates. Contains a list with the CA names that the server considers trusted. Normally we should send a certificate that is signed by one of these CAs. These names are DER encoded. To get a more meaningful value use the functiongnutls_x509_rdn_get().
pk_algos, contains a list with server's acceptable signature algorithms. The certificate returned should support the server's given algorithms.If the callback function is provided then gnutls will call it, in the handshake, after the certificate request message has been received.
The callback function should set the certificate list to be sent, and return 0 on success. If no certificate was selected then the number of certificates should be set to zero. The value (-1) indicates error and the handshake will be terminated.
session: is a gnutls session
This function will return the peer's certificate expiration time.
Returns (time_t) -1 on error.
sc: is an
gnutls_certificate_credentials_tstructure.This function will delete all the CA name in the given credentials. Clients may call this to save some memory since in client side the CA names are not used.
CA names are used by servers to advertize the CAs they support to clients.
sc: is an
gnutls_certificate_credentials_tstructure.This function will delete all the CAs associated with the given credentials. Servers that do not use
gnutls_certificate_verify_peers2()may call this to save some memory.
sc: is an
gnutls_certificate_credentials_tstructure.This structure is complex enough to manipulate directly thus this helper function is provided in order to free (deallocate) it.
This function does not free any temporary parameters associated with this structure (ie RSA and DH parameters are not freed by this function).
sc: is an
gnutls_certificate_credentials_tstructure.This function will delete all the CRLs associated with the given credentials.
sc: is an
gnutls_certificate_credentials_tstructure.This function will delete all the keys and the certificates associated with the given credentials. This function must not be called when a TLS negotiation that uses the credentials is in progress.
session: is a gnutls session
This function will return the certificate as sent to the peer, in the last handshake. These certificates are in raw format. In X.509 this is a certificate list. In OpenPGP this is a single certificate. Returns NULL in case of an error, or if no certificate was used.
session: is a gnutls session
list_size: is the length of the certificate list
This function will return the peer's raw certificate (chain) as sent by the peer. These certificates are in raw format (DER encoded for X.509). In case of a X.509 then a certificate list may be present. The first certificate in the list is the peer's certificate, following the issuer's certificate, then the issuer's issuer etc.
In case of OpenPGP keys a single key will be returned in raw format.
Returns NULL in case of an error, or if no certificate was sent.
session: is a pointer to a
gnutls_session_tstructure.status: is 0 or 1
If status is non zero, this function will order gnutls not to send the rdnSequence in the certificate request message. That is the server will not advertize it's trusted CAs to the peer. If status is zero then the default behaviour will take effect, which is to advertize the server's trusted CAs.
This function has no effect in clients, and in authentication methods other than certificate with X.509 certificates.
session: is an
gnutls_session_tstructure.req: is one of GNUTLS_CERT_REQUEST, GNUTLS_CERT_REQUIRE
This function specifies if we (in case of a server) are going to send a certificate request message to the client. If
reqis GNUTLS_CERT_REQUIRE then the server will return an error if the peer does not provide a certificate. If you do not call this function then the client will not be asked to send a certificate.
cred: is a
gnutls_certificate_credentials_tstructure.func: is the callback function
This function sets a callback to be called in order to retrieve the certificate to be used in the handshake. The callback's function prototype is: int (*callback)(gnutls_session_t, gnutls_retr_st* st);
stshould contain the certificates and private keys.If the callback function is provided then gnutls will call it, in the handshake, after the certificate request message has been received.
The callback function should set the certificate list to be sent, and return 0 on success. The value (-1) indicates error and the handshake will be terminated.
res: is a gnutls_certificate_credentials_t structure
dh_params: is a structure that holds diffie hellman parameters.
This function will set the diffie hellman parameters for a certificate server to use. These parameters will be used in Ephemeral Diffie Hellman cipher suites. Note that only a pointer to the parameters are stored in the certificate handle, so if you deallocate the parameters before the certificate is deallocated, you must change the parameters stored in the certificate first.
res: is a gnutls_certificate_credentials_t structure
func: is the function to be called
This function will set a callback in order for the server to get the diffie hellman or RSA parameters for certificate authentication. The callback should return zero on success.
res: is a gnutls_certificate_credentials_t structure
rsa_params: is a structure that holds temporary RSA parameters.
This function will set the temporary RSA parameters for a certificate server to use. These parameters will be used in RSA-EXPORT cipher suites.
res: is a gnutls_certificate_credentials_t structure
flags: are the flags
This function will set the flags to be used at verification of the certificates. Flags must be OR of the
gnutls_certificate_verify_flagsenumerations.
res: is a gnutls_certificate_credentials structure
max_bits: is the number of bits of an acceptable certificate (default 8200)
max_depth: is maximum depth of the verification of a certificate chain (default 5)
This function will set some upper limits for the default verification function,
gnutls_certificate_verify_peers2(), to avoid denial of service attacks.
res: is an
gnutls_certificate_credentials_tstructure.crlfile: is a file containing the list of verified CRLs (DER or PEM list)
type: is PEM or DER
This function adds the trusted CRLs in order to verify client or server certificates. In case of a client this is not required to be called if the certificates are not verified using
gnutls_certificate_verify_peers2(). This function may be called multiple times.Returns the number of CRLs processed or a negative value on error.
res: is an
gnutls_certificate_credentials_tstructure.CRL: is a list of trusted CRLs. They should have been verified before.
type: is DER or PEM
This function adds the trusted CRLs in order to verify client or server certificates. In case of a client this is not required to be called if the certificates are not verified using
gnutls_certificate_verify_peers2(). This function may be called multiple times.Returns the number of CRLs processed or a negative value on error.
res: is an
gnutls_certificate_credentials_tstructure.crl_list: is a list of trusted CRLs. They should have been verified before.
crl_list_size: holds the size of the crl_list
This function adds the trusted CRLs in order to verify client or server certificates. In case of a client this is not required to be called if the certificates are not verified using
gnutls_certificate_verify_peers2(). This function may be called multiple times.Returns 0 on success.
res: is an
gnutls_certificate_credentials_tstructure.CERTFILE: is a file that containing the certificate list (path) for the specified private key, in PKCS7 format, or a list of certificates
KEYFILE: is a file that contains the private key
type: is PEM or DER
This function sets a certificate/private key pair in the gnutls_certificate_credentials_t structure. This function may be called more than once (in case multiple keys/certificates exist for the server).
Currently only PKCS-1 encoded RSA and DSA private keys are accepted by this function.
res: is an
gnutls_certificate_credentials_tstructure.cert: contains a certificate list (path) for the specified private key
key: is the private key, or
NULL.type: is PEM or DER
This function sets a certificate/private key pair in the gnutls_certificate_credentials_t structure. This function may be called more than once (in case multiple keys/certificates exist for the server).
Currently are supported: RSA PKCS-1 encoded private keys, DSA private keys.
DSA private keys are encoded the OpenSSL way, which is an ASN.1 DER sequence of 6 INTEGERs - version, p, q, g, pub, priv.
Note that the keyUsage (2.5.29.15) PKIX extension in X.509 certificates is supported. This means that certificates intended for signing cannot be used for ciphersuites that require encryption.
If the certificate and the private key are given in PEM encoding then the strings that hold their values must be null terminated.
res: is an
gnutls_certificate_credentials_tstructure.cert_list: contains a certificate list (path) for the specified private key
cert_list_size: holds the size of the certificate list
key: is a gnutls_x509_privkey_t key
This function sets a certificate/private key pair in the gnutls_certificate_credentials_t structure. This function may be called more than once (in case multiple keys/certificates exist for the server).
res: is an
gnutls_certificate_credentials_tstructure.pkcs12file: filename of file containing PKCS
12blob.type: is PEM or DER of the
pkcs12file.password: optional password used to decrypt PKCS
12file, bags and keys.This function sets a certificate/private key pair and/or a CRL in the gnutls_certificate_credentials_t structure. This function may be called more than once (in case multiple keys/certificates exist for the server).
MAC: ed PKCS
12files are supported. Encrypted PKCS12bags are supported. Encrypted PKCS8private keys are supported. However, only password based security, and the same password for all operations, are supported.The private keys may be RSA PKCS
1or DSA private keys encoded in the OpenSSL way.PKCS
12file may contain many keys and/or certificates, and there is no way to identify which key/certificate pair you want. You should make sure the PKCS12file only contain one key/certificate pair and/or one CRL.It is believed that the limitations of this function is acceptable for most usage, and that any more flexibility would introduce complexity that would make it harder to use this functionality at all.
Return value: Returns 0 on success, or an error code.
res: is an
gnutls_certificate_credentials_tstructure.cafile: is a file containing the list of trusted CAs (DER or PEM list)
type: is PEM or DER
This function adds the trusted CAs in order to verify client or server certificates. In case of a client this is not required to be called if the certificates are not verified using
gnutls_certificate_verify_peers2(). This function may be called multiple times.In case of a server the names of the CAs set here will be sent to the client if a certificate request is sent. This can be disabled using
gnutls_certificate_send_x509_rdn_sequence().Returns the number of certificates processed or a negative value on error.
res: is an
gnutls_certificate_credentials_tstructure.ca: is a list of trusted CAs or a DER certificate
type: is DER or PEM
This function adds the trusted CAs in order to verify client or server certificates. In case of a client this is not required to be called if the certificates are not verified using
gnutls_certificate_verify_peers2(). This function may be called multiple times.In case of a server the CAs set here will be sent to the client if a certificate request is sent. This can be disabled using
gnutls_certificate_send_x509_rdn_sequence().Returns the number of certificates processed or a negative value on error.
res: is an
gnutls_certificate_credentials_tstructure.ca_list: is a list of trusted CAs
ca_list_size: holds the size of the CA list
This function adds the trusted CAs in order to verify client or server certificates. In case of a client this is not required to be called if the certificates are not verified using
gnutls_certificate_verify_peers2(). This function may be called multiple times.In case of a server the CAs set here will be sent to the client if a certificate request is sent. This can be disabled using
gnutls_certificate_send_x509_rdn_sequence().Returns 0 on success.
type: is a certificate type
Returns a string (or NULL) that contains the name of the specified certificate type.
session: is a
gnutls_session_tstructure.Returns the currently used certificate type. The certificate type is by default X.509, unless it is negotiated as a TLS extension.
Get a list of certificate types. Note that to be able to use OpenPGP certificates, you must link to libgnutls-extra and call
gnutls_global_init_extra().Returns: Return a zero-terminated list of
gnutls_certificate_type_tintegers indicating the available certificate types.
session: is a
gnutls_session_tstructure.list: is a 0 terminated list of gnutls_certificate_type_t elements.
Sets the priority on the certificate types supported by gnutls. Priority is higher for types specified before others. After specifying the types you want, you must append a 0. Note that the certificate type priority is set on the client. The server does not use the cert type priority except for disabling types that were not specified.
Returns 0 on success.
session: is a gnutls session
status: is the output of the verification
This function will try to verify the peer's certificate and return its status (trusted, invalid etc.). The value of
statusshould be one or more of the gnutls_certificate_status_t enumerated elements bitwise or'd. To avoid denial of service attacks some default upper limits regarding the certificate key size and chain size are set. To override them usegnutls_certificate_set_verify_limits().Note that you must also check the peer's name in order to check if the verified certificate belongs to the actual peer.
Returns a negative error code on error and zero on success.
This is the same as
gnutls_x509_verify_certificate()and uses the loaded CAs in the credentials as trusted CAs.Note that some commonly used X.509 Certificate Authorities are still using Version 1 certificates. If you want to accept them, you need to call
gnutls_certificate_set_verify_flags()with, e.g.,GNUTLS_VERIFY_ALLOW_X509_V1_CA_CRTparameter.
session: is a gnutls session
This function will try to verify the peer's certificate and return its status (trusted, invalid etc.). However you must also check the peer's name in order to check if the verified certificate belongs to the actual peer.
The return value should be one or more of the gnutls_certificate_status_t enumerated elements bitwise or'd, or a negative value on error.
This is the same as
gnutls_x509_verify_certificate().Deprecated: Use
gnutls_certificate_verify_peers2()instead.
req_version: the version to check
Check that the version of the library is at minimum the requested one and return the version string; return NULL if the condition is not satisfied. If a NULL is passed to this function, no check is done, but the version string is simply returned.
See
LIBGNUTLS_VERSIONfor a suitablereq_versionstring.Return value: Version string of run-time library, or NULL if the run-time library does not meet the required version number. If
NULLis passed to this function no check is done and only the version string is returned.
algorithm: is an encryption algorithm
Returns the length (in bytes) of the given cipher's key size. Returns 0 if the given cipher is invalid.
algorithm: is an encryption algorithm
Returns a pointer to a string that contains the name of the specified cipher or NULL.
session: is a
gnutls_session_tstructure.Returns the currently used cipher.
Get a list of supported cipher algorithms. Note that not necessarily all ciphers are supported as TLS cipher suites. For example, DES is not supported as a cipher suite, but is supported for other purposes (e.g., PKCS
8or similar).Returns: Return a zero-terminated list of
gnutls_cipher_algorithm_tintegers indicating the available ciphers.
session: is a
gnutls_session_tstructure.list: is a 0 terminated list of gnutls_cipher_algorithm_t elements.
Sets the priority on the ciphers supported by gnutls. Priority is higher for ciphers specified before others. After specifying the ciphers you want, you must append a 0. Note that the priority is set on the client. The server does not use the algorithm's priority except for disabling algorithms that were not specified.
Returns 0 on success.
kx_algorithm: is a Key exchange algorithm
cipher_algorithm: is a cipher algorithm
mac_algorithm: is a MAC algorithm
Returns a string that contains the name of a TLS cipher suite, specified by the given algorithms, or NULL.
Note that the full cipher suite name must be prepended by TLS or SSL depending of the protocol in use.
idx: index of cipher suite to get information about, starts on 0.
cs_id: output buffer with room for 2 bytes, indicating cipher suite value
kx: output variable indicating key exchange algorithm, or
NULL.cipher: output variable indicating cipher, or
NULL.mac: output variable indicating MAC algorithm, or
NULL.version: output variable indicating TLS protocol version, or
NULL.Get information about supported cipher suites. Use the function iteratively to get information about all supported cipher suites. Call with idx=0 to get information about first cipher suite, then idx=1 and so on until the function returns NULL.
Returns: Returns the name of
idxcipher suite, and set the information about the cipher suite in the output variables. Ifidxis out of bounds,NULLis returned.
algorithm: is a Compression algorithm
Returns a pointer to a string that contains the name of the specified compression algorithm or NULL.
session: is a
gnutls_session_tstructure.Returns the currently used compression method.
Get a list of compression methods. Note that to be able to use LZO compression, you must link to libgnutls-extra and call
gnutls_global_init_extra().Returns: Return a zero-terminated list of
gnutls_compression_method_tintegers indicating the available compression methods.
session: is a
gnutls_session_tstructure.list: is a 0 terminated list of gnutls_compression_method_t elements.
Sets the priority on the compression algorithms supported by gnutls. Priority is higher for algorithms specified before others. After specifying the algorithms you want, you must append a 0. Note that the priority is set on the client. The server does not use the algorithm's priority except for disabling algorithms that were not specified.
TLS 1.0 does not define any compression algorithms except NULL. Other compression algorithms are to be considered as gnutls extensions.
Returns 0 on success.
session: is a
gnutls_session_tstructure.Clears all the credentials previously set in this session.
session: is a
gnutls_session_tstructure.type: is the type of the credentials
cred: is a pointer to a structure.
Sets the needed credentials for the specified type. Eg username, password - or public and private keys etc. The (void* cred) parameter is a structure that depends on the specified type and on the current session (client or server). [ In order to minimize memory usage, and share credentials between several threads gnutls keeps a pointer to cred, and not the whole cred structure. Thus you will have to keep the structure allocated until you call
gnutls_deinit(). ]For GNUTLS_CRD_ANON cred should be gnutls_anon_client_credentials_t in case of a client. In case of a server it should be gnutls_anon_server_credentials_t.
For GNUTLS_CRD_SRP cred should be gnutls_srp_client_credentials_t in case of a client, and gnutls_srp_server_credentials_t, in case of a server.
For GNUTLS_CRD_CERTIFICATE cred should be gnutls_certificate_credentials_t.
session: is a
gnutls_session_tstructure.session_entry: is the session data (not key)
This function returns GNUTLS_E_EXPIRED, if the database entry has expired or 0 otherwise. This function is to be used when you want to clear unnesessary session which occupy space in your backend.
session: is a
gnutls_session_tstructure.Returns the pointer that will be sent to db store, retrieve and delete functions, as the first argument.
session: is a
gnutls_session_tstructure.This function will remove the current session data from the session database. This will prevent future handshakes reusing these session data. This function should be called if a session was terminated abnormally, and before
gnutls_deinit()is called.Normally
gnutls_deinit()will remove abnormally terminated sessions.
session: is a
gnutls_session_tstructure.seconds: is the number of seconds.
Sets the expiration time for resumed sessions. The default is 3600 (one hour) at the time writing this.
session: is a
gnutls_session_tstructure.ptr: is the pointer
Sets the pointer that will be provided to db store, retrieve and delete functions, as the first argument.
session: is a
gnutls_session_tstructure.rem_func: is the function.
Sets the function that will be used to remove data from the resumed sessions database. This function must return 0 on success.
The first argument to
rem_func()will be null unlessgnutls_db_set_ptr()has been called.
session: is a
gnutls_session_tstructure.retr_func: is the function.
Sets the function that will be used to retrieve data from the resumed sessions database. This function must return a gnutls_datum_t containing the data on success, or a gnutls_datum_t containing null and 0 on failure.
The datum's data must be allocated using the function
gnutls_malloc().The first argument to
retr_func()will be null unlessgnutls_db_set_ptr()has been called.
session: is a
gnutls_session_tstructure.store_func: is the function
Sets the function that will be used to store data from the resumed sessions database. This function must remove 0 on success.
The first argument to
store_func()will be null unlessgnutls_db_set_ptr()has been called.
session: is a
gnutls_session_tstructure.This function clears all buffers associated with the
session. This function will also remove session data from the session database if the session was terminated abnormally.
session: is a gnutls session
raw_gen: will hold the generator.
raw_prime: will hold the prime.
This function will return the group parameters used in the last Diffie Hellman authentication with the peer. These are the prime and the generator used. This function should be used for both anonymous and ephemeral diffie Hellman. The output parameters must be freed with
gnutls_free().Returns a negative value in case of an error.
session: is a gnutls session
This function will return the bits used in the last Diffie Hellman authentication with the peer. Should be used for both anonymous and ephemeral diffie Hellman. Returns a negative value in case of an error.
session: is a gnutls session
This function will return the bits of the prime used in the last Diffie Hellman authentication with the peer. Should be used for both anonymous and ephemeral diffie Hellman. Returns a negative value in case of an error.
session: is a gnutls session
raw_key: will hold the public key.
This function will return the peer's public key used in the last Diffie Hellman authentication. This function should be used for both anonymous and ephemeral diffie Hellman. The output parameters must be freed with
gnutls_free().Returns a negative value in case of an error.
session: is a gnutls session
This function will return the bits used in the last Diffie Hellman authentication with the peer. Should be used for both anonymous and ephemeral diffie Hellman. Returns a negative value in case of an error.
dst: Is the destination structure, which should be initialized.
src: Is the source structure
This function will copy the DH parameters structure from source to destination.
dh_params: Is a structure that holds the prime numbers
This function will deinitialize the DH parameters structure.
params: Holds the DH parameters
format: the format of output params. One of PEM or DER.
params_data: will contain a PKCS3 DHParams structure PEM or DER encoded
params_data_size: holds the size of params_data (and will be replaced by the actual size of parameters)
This function will export the given dh parameters to a PKCS3 DHParams structure. This is the format generated by "openssl dhparam" tool. If the buffer provided is not long enough to hold the output, then GNUTLS_E_SHORT_MEMORY_BUFFER will be returned.
If the structure is PEM encoded, it will have a header of "BEGIN DH PARAMETERS".
In case of failure a negative value will be returned, and 0 on success.
params: Holds the DH parameters
prime: will hold the new prime
generator: will hold the new generator
bits: if non null will hold is the prime's number of bits
This function will export the pair of prime and generator for use in the Diffie-Hellman key exchange. The new parameters will be allocated using
gnutls_malloc()and will be stored in the appropriate datum.
params: Is the structure that the DH parameters will be stored
bits: is the prime's number of bits
This function will generate a new pair of prime and generator for use in the Diffie-Hellman key exchange. The new parameters will be allocated using
gnutls_malloc()and will be stored in the appropriate datum. This function is normally slow.Note that the bits value should be one of 768, 1024, 2048, 3072 or 4096. Also note that the DH parameters are only useful to servers. Since clients use the parameters sent by the server, it's of no use to call this in client side.
params: A structure where the parameters will be copied to
pkcs3_params: should contain a PKCS3 DHParams structure PEM or DER encoded
format: the format of params. PEM or DER.
This function will extract the DHParams found in a PKCS3 formatted structure. This is the format generated by "openssl dhparam" tool.
If the structure is PEM encoded, it should have a header of "BEGIN DH PARAMETERS".
In case of failure a negative value will be returned, and 0 on success.
dh_params: Is a structure that will hold the prime numbers
prime: holds the new prime
generator: holds the new generator
This function will replace the pair of prime and generator for use in the Diffie-Hellman key exchange. The new parameters should be stored in the appropriate gnutls_datum.
dh_params: Is a structure that will hold the prime numbers
This function will initialize the DH parameters structure.
session: is a
gnutls_session_tstructure.bits: is the number of bits
This function sets the number of bits, for use in an Diffie Hellman key exchange. This is used both in DH ephemeral and DH anonymous cipher suites. This will set the minimum size of the prime that will be used for the handshake.
In the client side it sets the minimum accepted number of bits. If a server sends a prime with less bits than that GNUTLS_E_DH_PRIME_UNACCEPTABLE will be returned by the handshake.
error: is an error returned by a gnutls function. Error should be a negative value.
If a function returns a negative value you may feed that value to this function to see if it is fatal. Returns 1 for a fatal error 0 otherwise. However you may want to check the error code manually, since some non-fatal errors to the protocol may be fatal for you (your program).
This is only useful if you are dealing with errors from the record layer or the handshake layer.
err: is a negative integer
level: the alert level will be stored there
Returns an alert depending on the error code returned by a gnutls function. All alerts sent by this function should be considered fatal. The only exception is when err == GNUTLS_E_REHANDSHAKE, where a warning alert should be sent to the peer indicating that no renegotiation will be performed.
If the return value is GNUTLS_E_INVALID_REQUEST, then there was no mapping to an alert.
algo: is a digest algorithm
data: is the data
result: is the place where the result will be copied (may be null).
result_size: should hold the size of the result. The actual size of the returned result will also be copied there.
This function will calculate a fingerprint (actually a hash), of the given data. The result is not printable data. You should convert it to hex, or to something else printable.
This is the usual way to calculate a fingerprint of an X.509 DER encoded certificate. Note however that the fingerprint of an OpenPGP is not just a hash and cannot be calculated with this function.
Returns a negative value in case of an error.
This function will free data pointed by ptr.
The deallocation function used is the one set by
gnutls_global_set_mem_functions().
This function deinitializes the global data, that were initialized using
gnutls_global_init().Note! This function is not thread safe. See the discussion for
gnutls_global_init()for more information.
This function initializes the global data to defaults. Every gnutls application has a global data which holds common parameters shared by gnutls session structures. You must call
gnutls_global_deinit()when gnutls usage is no longer needed Returns zero on success.Note that this function will also initialize libgcrypt, if it has not been initialized before. Thus if you want to manually initialize libgcrypt you must do it before calling this function. This is useful in cases you want to disable libgcrypt's internal lockings etc.
This function increment a global counter, so that
gnutls_global_deinit()only releases resources when it has been called as many times asgnutls_global_init(). This is useful when GnuTLS is used by more than one library in an application. This function can be called many times, but will only do something the first time.Note! This function is not thread safe. If two threads call this function simultaneously, they can cause a race between checking the global counter and incrementing it, causing both threads to execute the library initialization code. That would lead to a memory leak. To handle this, your application could invoke this function after aquiring a thread mutex. To ignore the potential memory leak is also an option.
log_func: it's a log function
This is the function where you set the logging function gnutls is going to use. This function only accepts a character array. Normally you may not use this function since it is only used for debugging purposes.
gnutls_log_func is of the form, void (*gnutls_log_func)( int level, const char*);
level: it's an integer from 0 to 9.
This is the function that allows you to set the log level. The level is an integer between 0 and 9. Higher values mean more verbosity. The default value is 0. Larger values should only be used with care, since they may reveal sensitive information.
Use a log level over 10 to enable all debugging options.
alloc_func: it's the default memory allocation function. Like
malloc().secure_alloc_func: This is the memory allocation function that will be used for sensitive data.
is_secure_func: a function that returns 0 if the memory given is not secure. May be NULL.
realloc_func: A realloc function
free_func: The function that frees allocated data. Must accept a NULL pointer.
This is the function were you set the memory allocation functions gnutls is going to use. By default the libc's allocation functions (
malloc(),free()), are used by gnutls, to allocate both sensitive and not sensitive data. This function is provided to set the memory allocation functions to something other than the defaults (ie the gcrypt allocation functions).This function must be called before
gnutls_global_init()is called.
session: is a
gnutls_session_tstructure.Returns the last handshake message received. This function is only useful to check where the last performed handshake failed. If the previous handshake succeed or was not performed at all then no meaningful value will be returned.
Check gnutls.h for the available handshake descriptions.
session: is a
gnutls_session_tstructure.Returns the last handshake message sent. This function is only useful to check where the last performed handshake failed. If the previous handshake succeed or was not performed at all then no meaningful value will be returned.
Check gnutls.h for the available handshake descriptions.
session: is a
gnutls_session_tstructure.max: is the maximum number.
This function will set the maximum size of a handshake message. Handshake messages over this size are rejected. The default value is 16kb which is large enough. Set this to 0 if you do not want to set an upper limit.
session: is a
gnutls_session_tstructure.allow: is an integer (0 or 1)
This function will enable or disable the use of private cipher suites (the ones that start with 0xFF). By default or if
allowis 0 then these cipher suites will not be advertized nor used.Unless this function is called with the option to allow (1), then no compression algorithms, like LZO. That is because these algorithms are not yet defined in any RFC or even internet draft.
Enabling the private ciphersuites when talking to other than gnutls servers and clients may cause interoperability problems.
session: is a
gnutls_session_tstructure.This function does the handshake of the TLS/SSL protocol, and initializes the TLS connection.
This function will fail if any problem is encountered, and will return a negative error code. In case of a client, if the client has asked to resume a session, but the server couldn't, then a full handshake will be performed.
The non-fatal errors such as GNUTLS_E_AGAIN and GNUTLS_E_INTERRUPTED interrupt the handshake procedure, which should be later be resumed. Call this function again, until it returns 0; cf.
gnutls_record_get_direction()andgnutls_error_is_fatal().If this function is called by a server after a rehandshake request then GNUTLS_E_GOT_APPLICATION_DATA or GNUTLS_E_WARNING_ALERT_RECEIVED may be returned. Note that these are non fatal errors, only in the specific case of a rehandshake. Their meaning is that the client rejected the rehandshake request.
hex_data: contain the encoded data
result: the place where decoded data will be copied
result_size: holds the size of the result
This function will decode the given encoded data, using the hex encoding used by PSK password files.
Note that hex_data should be null terminated.
Returns GNUTLS_E_SHORT_MEMORY_BUFFER if the buffer given is not long enough, or 0 on success.
data: contain the raw data
result: the place where hex data will be copied
result_size: holds the size of the result
This function will convert the given data to printable data, using the hex encoding, as used in the PSK password files.
Returns GNUTLS_E_SHORT_MEMORY_BUFFER if the buffer given is not long enough, or 0 on success.
session: is a pointer to a
gnutls_session_tstructure.con_end: is used to indicate if this session is to be used for server or client. Can be one of GNUTLS_CLIENT and GNUTLS_SERVER.
This function initializes the current session to null. Every session must be initialized before use, so internal structures can be allocated. This function allocates structures which can only be free'd by calling
gnutls_deinit(). Returns zero on success.
algorithm: is a key exchange algorithm
Returns a pointer to a string that contains the name of the specified key exchange algorithm or NULL.
session: is a
gnutls_session_tstructure.Returns the key exchange algorithm used in the last handshake.
Get a list of supported key exchange algorithms.
Returns: Return a zero-terminated list of
gnutls_kx_algorithm_tintegers indicating the available key exchange algorithms.
session: is a
gnutls_session_tstructure.list: is a 0 terminated list of gnutls_kx_algorithm_t elements.
Sets the priority on the key exchange algorithms supported by gnutls. Priority is higher for algorithms specified before others. After specifying the algorithms you want, you must append a 0. Note that the priority is set on the client. The server does not use the algorithm's priority except for disabling algorithms that were not specified.
Returns 0 on success.
algorithm: is a MAC algorithm
Returns a string that contains the name of the specified MAC algorithm or NULL.
session: is a
gnutls_session_tstructure.Returns the currently used mac algorithm.
Get a list of hash algorithms for use as MACs. Note that not necessarily all MACs are supported in TLS cipher suites. For example, MD2 is not supported as a cipher suite, but is supported for other purposes (e.g., X.509 signature verification or similar).
Returns: Return a zero-terminated list of
gnutls_mac_algorithm_tintegers indicating the available MACs.
session: is a
gnutls_session_tstructure.list: is a 0 terminated list of gnutls_mac_algorithm_t elements.
Sets the priority on the mac algorithms supported by gnutls. Priority is higher for algorithms specified before others. After specifying the algorithms you want, you must append a 0. Note that the priority is set on the client. The server does not use the algorithm's priority except for disabling algorithms that were not specified.
Returns 0 on success.
This function will allocate 's' bytes data, and return a pointer to memory. This function is supposed to be used by callbacks.
The allocation function used is the one set by
gnutls_global_set_mem_functions().
session: is a pointer to a
gnutls_session_tstructure.status: is one of OPENPGP_KEY, or OPENPGP_KEY_FINGERPRINT
This function will order gnutls to send the key fingerprint instead of the key in the initial handshake procedure. This should be used with care and only when there is indication or knowledge that the server can obtain the client's key.
header: The PEM header (eg. CERTIFICATE)
b64_data: contains the encoded data
result: the place where decoded data lie
This function will decode the given encoded data. The decoded data will be allocated, and stored into result. If the header given is non null this function will search for "——BEGIN header" and decode only this part. Otherwise it will decode the first PEM packet found.
You should use
gnutls_free()to free the returned data.
header: A null terminated string with the PEM header (eg. CERTIFICATE)
b64_data: contain the encoded data
result: the place where decoded data will be copied
result_size: holds the size of the result
This function will decode the given encoded data. If the header given is non null this function will search for "——BEGIN header" and decode only this part. Otherwise it will decode the first PEM packet found.
Returns GNUTLS_E_SHORT_MEMORY_BUFFER if the buffer given is not long enough, or 0 on success.
msg: is a message to be put in the encoded header
data: contains the raw data
result: will hold the newly allocated encoded data
This function will convert the given data to printable data, using the base64 encoding. This is the encoding used in PEM messages. This function will allocate the required memory to hold the encoded data.
You should use
gnutls_free()to free the returned data.
msg: is a message to be put in the header
data: contain the raw data
result: the place where base64 data will be copied
result_size: holds the size of the result
This function will convert the given data to printable data, using the base64 encoding. This is the encoding used in PEM messages. If the provided buffer is not long enough GNUTLS_E_SHORT_MEMORY_BUFFER is returned.
The output string will be null terminated, although the size will not include the terminating null.
error: is an error returned by a gnutls function. Error is always a negative value.
This function is like
perror(). The only difference is that it accepts an error number returned by a gnutls function.
algorithm: is a pk algorithm
Returns a string that contains the name of the specified public key algorithm or NULL.
session: is a
gnutls_session_tstructure.label_size: length of the
labelvariable.label: label used in PRF computation, typically a short string.
seed_size: length of the
seedvariable.seed: optional extra data to seed the PRF with.
outsize: size of pre-allocated output buffer to hold the output.
out: pre-allocate buffer to hold the generated data.
Apply the TLS Pseudo-Random-Function (PRF) using the master secret on some data.
The
labelvariable usually contain a string denoting the purpose for the generated data. Theseedusually contain data such as the client and server random, perhaps together with some additional data that is added to guarantee uniqueness of the output for a particular purpose.Because the output is not guaranteed to be unique for a particular session unless
seedinclude the client random and server random fields (the PRF would output the same data on another connection resumed from the first one), it is not recommended to use this function directly. Thegnutls_prf()function seed the PRF with the client and server random fields directly, and is recommended if you want to generate pseudo random data unique for each session.Return value: Return 0 on success, or an error code.
session: is a
gnutls_session_tstructure.label_size: length of the
labelvariable.label: label used in PRF computation, typically a short string.
server_random_first: non-0 if server random field should be first in seed
extra_size: length of the
extravariable.extra: optional extra data to seed the PRF with.
outsize: size of pre-allocated output buffer to hold the output.
out: pre-allocate buffer to hold the generated data.
Apply the TLS Pseudo-Random-Function (PRF) using the master secret on some data, seeded with the client and server random fields.
The
labelvariable usually contain a string denoting the purpose for the generated data. Theserver_random_firstindicate whether the client random field or the server random field should be first in the seed. Non-0 indicate that the server random field is first, 0 that the client random field is first.The
extravariable can be used to add more data to the seed, after the random variables. It can be used to tie make sure the generated output is strongly connected to some additional data (e.g., a string used in user authentication).The output is placed in *
OUT, which must be pre-allocated.Return value: Return 0 on success, or an error code.
version: is a (gnutls) version number
Returns a string that contains the name of the specified TLS version or NULL.
session: is a
gnutls_session_tstructure.Returns the version of the currently used protocol.
Get a list of supported protocols, e.g. SSL 3.0, TLS 1.0 etc.
Returns: Return a zero-terminated list of
gnutls_protocol_tintegers indicating the available protocols.
session: is a
gnutls_session_tstructure.list: is a 0 terminated list of gnutls_protocol_t elements.
Sets the priority on the protocol versions supported by gnutls. This function actually enables or disables protocols. Newer protocol versions always have highest priority.
Returns 0 on success.
sc: is a pointer to an
gnutls_psk_server_credentials_tstructure.This structure is complex enough to manipulate directly thus this helper function is provided in order to allocate it.
Returns 0 on success.
sc: is a pointer to an
gnutls_psk_server_credentials_tstructure.This structure is complex enough to manipulate directly thus this helper function is provided in order to allocate it.
Returns 0 on success.
sc: is an
gnutls_psk_client_credentials_tstructure.This structure is complex enough to manipulate directly thus this helper function is provided in order to free (deallocate) it.
sc: is an
gnutls_psk_server_credentials_tstructure.This structure is complex enough to manipulate directly thus this helper function is provided in order to free (deallocate) it.
session: is a gnutls session
This function will return the username of the peer. This should only be called in case of PSK authentication and in case of a server. Returns NULL in case of an error.
cred: is a
gnutls_psk_server_credentials_tstructure.func: is the callback function
This function can be used to set a callback to retrieve the username and password for client PSK authentication. The callback's function form is: int (*callback)(gnutls_session_t, char** username, gnutls_datum* key);
The
usernameandkeymust be allocated usinggnutls_malloc().usernameshould be ASCII strings or UTF-8 strings prepared using the "SASLprep" profile of "stringprep".The callback function will be called once per handshake.
The callback function should return 0 on success. -1 indicates an error.
res: is an
gnutls_psk_client_credentials_tstructure.username: is the user's zero-terminated userid
key: is the user's key
This function sets the username and password, in a gnutls_psk_client_credentials_t structure. Those will be used in PSK authentication.
usernameshould be an ASCII string or UTF-8 strings prepared using the "SASLprep" profile of "stringprep". The key can be either in raw byte format or in Hex (not with the '0x' prefix).Returns 0 on success.
res: is a gnutls_psk_server_credentials_t structure
func: is the function to be called
This function will set a callback in order for the server to get the diffie hellman or RSA parameters for psk authentication. The callback should return zero on success.
res: is an
gnutls_psk_server_credentials_tstructure.password_file: is the PSK password file (passwd.psk)
This function sets the password file, in a gnutls_psk_server_credentials_t structure. This password file holds usernames and keys and will be used for PSK authentication.
Returns 0 on success.
cred: is a
gnutls_psk_server_credentials_tstructure.func: is the callback function
This function can be used to set a callback to retrieve the user's PSK credentials. The callback's function form is: int (*callback)(gnutls_session_t, const char* username, gnutls_datum_t* key);
usernamecontains the actual username. Thekeymust be filled in using thegnutls_malloc().In case the callback returned a negative number then gnutls will assume that the username does not exist.
The callback function will only be called once per handshake. The callback function should return 0 on success, while -1 indicates an error.
res: is a gnutls_psk_server_credentials_t structure
dh_params: is a structure that holds diffie hellman parameters.
This function will set the diffie hellman parameters for an anonymous server to use. These parameters will be used in Diffie Hellman with PSK cipher suites.
res: is a gnutls_certificate_credentials_t structure
func: is the function to be called
This function will set a callback in order for the server to get the diffie hellman parameters for PSK authentication. The callback should return zero on success.
session: is a
gnutls_session_tstructure.This function checks if there are any data to receive in the gnutls buffers. Returns the size of that data or 0. Notice that you may also use
select()to check for data in a TCP connection, instead of this function. (gnutls leaves some data in the tcp buffer in order for select to work).
session: is a
gnutls_session_tstructure.This function provides information about the internals of the record protocol and is only useful if a prior gnutls function call (e.g.
gnutls_handshake()) was interrupted for some reason, that is, if a function returned GNUTLS_E_INTERRUPTED or GNUTLS_E_AGAIN. In such a case, you might want to callselect()orpoll()before calling the interrupted gnutls function again. To tell you whether a file descriptor should be selected for either reading or writing,gnutls_record_get_direction()returns 0 if the interrupted function was trying to read data, and 1 if it was trying to write data.
session: is a
gnutls_session_tstructure.This function returns the maximum record packet size in this connection. The maximum record size is negotiated by the client after the first handshake message.
session: is a
gnutls_session_tstructure.data: the buffer that the data will be read into
sizeofdata: the number of requested bytes
This function has the similar semantics with
recv(). The only difference is that is accepts a GNUTLS session, and uses different error codes.In the special case that a server requests a renegotiation, the client may receive an error code of
GNUTLS_E_REHANDSHAKE. This message may be simply ignored, replied with an alert containing NO_RENEGOTIATION, or replied with a new handshake, depending on the client's will.If
EINTRis returned by the internal push function (the default isrecv()) thenGNUTLS_E_INTERRUPTEDwill be returned. IfGNUTLS_E_INTERRUPTEDorGNUTLS_E_AGAINis returned, you must call this function again to get the data. See alsognutls_record_get_direction().A server may also receive
GNUTLS_E_REHANDSHAKEwhen a client has initiated a handshake. In that case the server can only initiate a handshake or terminate the connection.Returns the number of bytes received and zero on EOF. A negative error code is returned in case of an error. The number of bytes received might be less than
sizeofdata.
session: is a
gnutls_session_tstructure.data: contains the data to send
sizeofdata: is the length of the data
This function has the similar semantics with
send(). The only difference is that is accepts a GNUTLS session, and uses different error codes.Note that if the send buffer is full,
send()will block this function. See thesend()documentation for full information. You can replace the default push function by usinggnutls_transport_set_ptr2()with a call tosend()with a MSG_DONTWAIT flag if blocking is a problem.If the EINTR is returned by the internal push function (the default is
send()} thenGNUTLS_E_INTERRUPTEDwill be returned. IfGNUTLS_E_INTERRUPTEDorGNUTLS_E_AGAINis returned, you must call this function again, with the same parameters; alternatively you could provide aNULLpointer for data, and 0 for size. cf.gnutls_record_get_direction().Returns the number of bytes sent, or a negative error code. The number of bytes sent might be less than
sizeofdata. The maximum number of bytes this function can send in a single call depends on the negotiated maximum record size.
session: is a
gnutls_session_tstructure.size: is the new size
This function sets the maximum record packet size in this connection. This property can only be set to clients. The server may choose not to accept the requested size.
Acceptable values are 512(=2^9), 1024(=2^10), 2048(=2^11) and 4096(=2^12). Returns 0 on success. The requested record size does get in effect immediately only while sending data. The receive part will take effect after a successful handshake.
This function uses a TLS extension called 'max record size'. Not all TLS implementations use or even understand this extension.
session: is a
gnutls_session_tstructure.This function will renegotiate security parameters with the client. This should only be called in case of a server.
This message informs the peer that we want to renegotiate parameters (perform a handshake).
If this function succeeds (returns 0), you must call the
gnutls_handshake()function in order to negotiate the new parameters.If the client does not wish to renegotiate parameters he will should with an alert message, thus the return code will be GNUTLS_E_WARNING_ALERT_RECEIVED and the alert will be GNUTLS_A_NO_RENEGOTIATION. A client may also choose to ignore this message.
session: is a gnutls session
This function will return the bits used in the last RSA-EXPORT key exchange with the peer. Returns a negative value in case of an error.
session: is a gnutls session
exponent: will hold the exponent.
modulus: will hold the modulus.
This function will return the peer's public key exponent and modulus used in the last RSA-EXPORT authentication. The output parameters must be freed with
gnutls_free().Returns a negative value in case of an error.
dst: Is the destination structure, which should be initialized.
src: Is the source structure
This function will copy the RSA parameters structure from source to destination.
rsa_params: Is a structure that holds the parameters
This function will deinitialize the RSA parameters structure.
params: Holds the RSA parameters
format: the format of output params. One of PEM or DER.
params_data: will contain a PKCS1 RSAPublicKey structure PEM or DER encoded
params_data_size: holds the size of params_data (and will be replaced by the actual size of parameters)
This function will export the given RSA parameters to a PKCS1 RSAPublicKey structure. If the buffer provided is not long enough to hold the output, then GNUTLS_E_SHORT_MEMORY_BUFFER will be returned.
If the structure is PEM encoded, it will have a header of "BEGIN RSA PRIVATE KEY".
In case of failure a negative value will be returned, and 0 on success.
params: a structure that holds the rsa parameters
m: will hold the modulus
e: will hold the public exponent
d: will hold the private exponent
p: will hold the first prime (p)
q: will hold the second prime (q)
u: will hold the coefficient
bits: if non null will hold the prime's number of bits
This function will export the RSA parameters found in the given structure. The new parameters will be allocated using
gnutls_malloc()and will be stored in the appropriate datum.
params: The structure where the parameters will be stored
bits: is the prime's number of bits
This function will generate new temporary RSA parameters for use in RSA-EXPORT ciphersuites. This function is normally slow.
Note that if the parameters are to be used in export cipher suites the bits value should be 512 or less. Also note that the generation of new RSA parameters is only useful to servers. Clients use the parameters sent by the server, thus it's no use calling this in client side.
params: A structure where the parameters will be copied to
pkcs1_params: should contain a PKCS1 RSAPublicKey structure PEM or DER encoded
format: the format of params. PEM or DER.
This function will extract the RSAPublicKey found in a PKCS1 formatted structure.
If the structure is PEM encoded, it should have a header of "BEGIN RSA PRIVATE KEY".
In case of failure a negative value will be returned, and 0 on success.
rsa_params: Is a structure will hold the parameters
m: holds the modulus
e: holds the public exponent
d: holds the private exponent
p: holds the first prime (p)
q: holds the second prime (q)
u: holds the coefficient
This function will replace the parameters in the given structure. The new parameters should be stored in the appropriate gnutls_datum.
rsa_params: Is a structure that will hold the parameters
This function will initialize the temporary RSA parameters structure.
session: is a
gnutls_session_tstructure.data: will hold the data
data_length: will hold the data length. Must hold the maximum size of data.
type: will hold the server name indicator type
indx: is the index of the server_name
This function will allow you to get the name indication (if any), a client has sent. The name indication may be any of the enumeration gnutls_server_name_type_t.
If
typeis GNUTLS_NAME_DNS, then this function is to be used by servers that support virtual hosting, and the data will be a null terminated UTF-8 string.If
datahas not enough size to hold the server name GNUTLS_E_SHORT_MEMORY_BUFFER is returned, anddata_lengthwill hold the required size.
indexis used to retrieve more than one server names (if sent by the client). The first server name has an index of 0, the second 1 and so on. If no name with the given index exists GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE is returned.
session: is a
gnutls_session_tstructure.type: specifies the indicator type
name: is a string that contains the server name.
name_length: holds the length of name
This function is to be used by clients that want to inform (via a TLS extension mechanism) the server of the name they connected to. This should be used by clients that connect to servers that do virtual hosting.
The value of
namedepends on theindtype. In case of GNUTLS_NAME_DNS, an ASCII or UTF-8 null terminated string, without the trailing dot, is expected. IPv4 or IPv6 addresses are not permitted.
session: is a
gnutls_session_tstructure.Return a pointer to the 32-byte client random field used in the session. The pointer must not be modified or deallocated.
If a client random value has not yet been established, the output will be garbage; in particular, a
NULLreturn value should not be expected.Return value: pointer to client random.
session: is a
gnutls_session_tstructure.Returns all session parameters, in order to support resuming. The client should call this, and keep the returned session, if he wants to resume that current version later by calling
gnutls_session_set_data()This function must be called after a successful handshake. The returned datum must be freed withgnutls_free().Resuming sessions is really useful and speedups connections after a succesful one.
session: is a
gnutls_session_tstructure.session_data: is a pointer to space to hold the session.
session_data_size: is the session_data's size, or it will be set by the function.
Returns all session parameters, in order to support resuming. The client should call this, and keep the returned session, if he wants to resume that current version later by calling
gnutls_session_set_data()This function must be called after a successful handshake.Resuming sessions is really useful and speedups connections after a succesful one.
session: is a
gnutls_session_tstructure.session_id: is a pointer to space to hold the session id.
session_id_size: is the session id's size, or it will be set by the function.
Returns the current session id. This can be used if you want to check if the next session you tried to resume was actually resumed. This is because resumed sessions have the same sessionID with the original session.
Session id is some data set by the server, that identify the current session. In TLS 1.0 and SSL 3.0 session id is always less than 32 bytes.
Returns zero on success.
session: is a
gnutls_session_tstructure.Return a pointer to the 48-byte master secret in the session. The pointer must not be modified or deallocated.
If a master secret value has not yet been established, the output will be garbage; in particular, a
NULLreturn value should not be expected.Consider using
gnutls_prf()rather than extracting the master secret and use it to derive further data.Return value: pointer to master secret.
session: is a
gnutls_session_tstructure.This function will return the user given pointer from the session structure. This is the pointer set with
gnutls_session_set_ptr().
session: is a
gnutls_session_tstructure.Return a pointer to the 32-byte server random field used in the session. The pointer must not be modified or deallocated.
If a server random value has not yet been established, the output will be garbage; in particular, a
NULLreturn value should not be expected.Return value: pointer to server random.
session: is a
gnutls_session_tstructure.This function will return non zero if this session is a resumed one, or a zero if this is a new session.
session: is a
gnutls_session_tstructure.session_data: is a pointer to space to hold the session.
session_data_size: is the session's size
Sets all session parameters, in order to resume a previously established session. The session data given must be the one returned by
gnutls_session_get_data(). This function should be called beforegnutls_handshake().Keep in mind that session resuming is advisory. The server may choose not to resume the session, thus a full handshake will be performed.
Returns a negative value on error.
session: is a
gnutls_session_tstructure.ptr: is the user pointer
This function will set (associate) the user given pointer to the session structure. This is pointer can be accessed with
gnutls_session_get_ptr().
session: is a
gnutls_session_tstructure.Sets some default priority on the ciphers, key exchange methods, macs and compression methods. This is to avoid using the gnutls_*
_priority()functions, if these defaults are ok. This function also includes weak algorithms. The order is TLS1, SSL3 for protocols, RSA, DHE_DSS, DHE_RSA, RSA_EXPORT for key exchange algorithms. SHA, MD5, RIPEMD160 for MAC algorithms, AES_256_CBC, AES_128_CBC, and 3DES_CBC, ARCFOUR_128, ARCFOUR_40 for ciphers.Returns 0 on success.
session: is a
gnutls_session_tstructure.Sets some default priority on the ciphers, key exchange methods, macs and compression methods. This is to avoid using the gnutls_*
_priority()functions, if these defaults are ok. You may override any of the following priorities by calling the appropriate functions.Protocols: TLS 1.2, TLS 1.1, TLS 1.0, and SSL3.
Key exchange algorithm: DHE-PSK, PSK, SRP-RSA, SRP-DSS, SRP, DHE-RSA, DHE-DSS, RSA.
Cipher: AES_256_CBC, AES_128_CBC, 3DES_CBC, and ARCFOUR_128.
MAC algorithm: SHA, and MD5.
Certificate types: OpenPGP, X.509
Compression: DEFLATE, NULL.
Returns 0 on success.
Returns a string that contains the name of the specified sign algorithm or NULL.
sc: is a pointer to an
gnutls_srp_server_credentials_tstructure.This structure is complex enough to manipulate directly thus this helper function is provided in order to allocate it.
Returns 0 on success.
sc: is a pointer to an
gnutls_srp_server_credentials_tstructure.This structure is complex enough to manipulate directly thus this helper function is provided in order to allocate it.
Returns 0 on success.
b64_data: contains the encoded data
result: the place where decoded data lie
This function will decode the given encoded data. The decoded data will be allocated, and stored into result. It will decode using the base64 algorithm found in libsrp.
You should use
gnutls_free()to free the returned data.
b64_data: contain the encoded data
result: the place where decoded data will be copied
result_size: holds the size of the result
This function will decode the given encoded data, using the base64 encoding found in libsrp.
Note that b64_data should be null terminated.
Returns GNUTLS_E_SHORT_MEMORY_BUFFER if the buffer given is not long enough, or 0 on success.
data: contains the raw data
result: will hold the newly allocated encoded data
This function will convert the given data to printable data, using the base64 encoding. This is the encoding used in SRP password files. This function will allocate the required memory to hold the encoded data.
You should use
gnutls_free()to free the returned data.
data: contain the raw data
result: the place where base64 data will be copied
result_size: holds the size of the result
This function will convert the given data to printable data, using the base64 encoding, as used in the libsrp. This is the encoding used in SRP password files. If the provided buffer is not long enough GNUTLS_E_SHORT_MEMORY_BUFFER is returned.
sc: is an
gnutls_srp_client_credentials_tstructure.This structure is complex enough to manipulate directly thus this helper function is provided in order to free (deallocate) it.
sc: is an
gnutls_srp_server_credentials_tstructure.This structure is complex enough to manipulate directly thus this helper function is provided in order to free (deallocate) it.
session: is a gnutls session
This function will return the username of the peer. This should only be called in case of SRP authentication and in case of a server. Returns NULL in case of an error.
cred: is a
gnutls_srp_server_credentials_tstructure.func: is the callback function
This function can be used to set a callback to retrieve the username and password for client SRP authentication. The callback's function form is: int (*callback)(gnutls_session_t, unsigned int times, char** username, char** password);
The
usernameandpasswordmust be allocated usinggnutls_malloc().timeswill be 0 the first time called, and 1 the second.usernameandpasswordshould be ASCII strings or UTF-8 strings prepared using the "SASLprep" profile of "stringprep".The callback function will be called once or twice per handshake. The first time called, is before the ciphersuite is negotiated. At that time if the callback returns a negative error code, the callback will be called again if SRP has been negotiated. This uses a special TLS-SRP idiom in order to avoid asking the user for SRP password and username if the server does not support SRP.
The callback should not return a negative error code the second time called, since the handshake procedure will be aborted.
The callback function should return 0 on success. -1 indicates an error.
res: is an
gnutls_srp_client_credentials_tstructure.username: is the user's userid
password: is the user's password
This function sets the username and password, in a gnutls_srp_client_credentials_t structure. Those will be used in SRP authentication.
usernameandpasswordshould be ASCII strings or UTF-8 strings prepared using the "SASLprep" profile of "stringprep".Returns 0 on success.
res: is an
gnutls_srp_server_credentials_tstructure.password_file: is the SRP password file (tpasswd)
password_conf_file: is the SRP password conf file (tpasswd.conf)
This function sets the password files, in a gnutls_srp_server_credentials_t structure. Those password files hold usernames and verifiers and will be used for SRP authentication.
Returns 0 on success.
cred: is a
gnutls_srp_server_credentials_tstructure.func: is the callback function
This function can be used to set a callback to retrieve the user's SRP credentials. The callback's function form is: int (*callback)(gnutls_session_t, const char* username, gnutls_datum_t* salt, gnutls_datum_t *verifier, gnutls_datum_t* g, gnutls_datum_t* n);
usernamecontains the actual username. Thesalt,verifier,generatorandprimemust be filled in using thegnutls_malloc(). For convenienceprimeandgeneratormay also be one of the static parameters defined in extra.h.In case the callback returned a negative number then gnutls will assume that the username does not exist.
In order to prevent attackers from guessing valid usernames, if a user does not exist, g and n values should be filled in using a random user's parameters. In that case the callback must return the special value (1).
The callback function will only be called once per handshake. The callback function should return 0 on success, while -1 indicates an error.
username: is the user's name
password: is the user's password
salt: should be some randomly generated bytes
generator: is the generator of the group
prime: is the group's prime
res: where the verifier will be stored.
This function will create an SRP verifier, as specified in RFC2945. The
primeandgeneratorshould be one of the static parameters defined in gnutls/extra.h or may be generated using the GCRYPT functionsgcry_prime_generate()andgcry_prime_group_generator(). The verifier will be allocated withmallocand will be stored inresusing binary format.
error: is an error returned by a gnutls function. Error is always a negative value.
This function is similar to
strerror(). Differences: it accepts an error number returned by a gnutls function; In case of an unknown error a descriptive string is sent instead of NULL.
session: is a
gnutls_session_tstructure.recv_ptr: will hold the value for the pull function
send_ptr: will hold the value for the push function
Used to get the arguments of the transport functions (like PUSH and PULL). These should have been set using
gnutls_transport_set_ptr2().
session: is a
gnutls_session_tstructure.Used to get the first argument of the transport function (like PUSH and PULL). This must have been set using
gnutls_transport_set_ptr().
session: is a
gnutls_session_tstructure.err: error value to store in session-specific errno variable.
Store
errin the session-specific errno variable. Useful values forerris EAGAIN and EINTR, other values are treated will be treated as real errors in the push/pull function.This function is useful in replacement push/pull functions set by gnutls_transport_set_push_function and gnutls_transport_set_pullpush_function under Windows, where the replacement push/pull may not have access to the same
errnovariable that is used by GnuTLS (e.g., the application is linked to msvcr71.dll and gnutls is linked to msvcrt.dll).If you don't have the
sessionvariable easily accessible from the push/pull function, and don't worry about thread conflicts, you can also usegnutls_transport_set_global_errno().
err: error value to store in global errno variable.
Store
errin the global errno variable. Useful values forerris EAGAIN and EINTR, other values are treated will be treated as real errors in the push/pull function.This function is useful in replacement push/pull functions set by gnutls_transport_set_push_function and gnutls_transport_set_pullpush_function under Windows, where the replacement push/pull may not have access to the same
errnovariable that is used by GnuTLS (e.g., the application is linked to msvcr71.dll and gnutls is linked to msvcrt.dll).Whether this function is thread safe or not depends on whether the global variable errno is thread safe, some system libraries make it a thread-local variable. When feasible, using the guaranteed thread-safe
gnutls_transport_set_errno()may be better.
session: is a
gnutls_session_tstructure.num: is the low water value.
Used to set the lowat value in order for select to check if there are pending data to socket buffer. Used only if you have changed the default low water value (default is 1). Normally you will not need that function. This function is only useful if using berkeley style sockets. Otherwise it must be called and set lowat to zero.
session: is a
gnutls_session_tstructure.recv_ptr: is the value for the pull function
send_ptr: is the value for the push function
Used to set the first argument of the transport function (like PUSH and PULL). In berkeley style sockets this function will set the connection handle. With this function you can use two different pointers for receiving and sending.
session: is a
gnutls_session_tstructure.ptr: is the value.
Used to set the first argument of the transport function (like PUSH and PULL). In berkeley style sockets this function will set the connection handle.
session: gnutls session
pull_func: a callback function similar to
read()This is the function where you set a function for gnutls to receive data. Normally, if you use berkeley style sockets, do not need to use this function since the default (recv(2)) will probably be ok.
PULL_FUNC is of the form, ssize_t (*gnutls_pull_func)(gnutls_transport_ptr_t, void*, size_t);
session: gnutls session
push_func: a callback function similar to
write()This is the function where you set a push function for gnutls to use in order to send data. If you are going to use berkeley style sockets, you do not need to use this function since the default (send(2)) will probably be ok. Otherwise you should specify this function for gnutls to be able to send data.
PUSH_FUNC is of the form, ssize_t (*gnutls_push_func)(gnutls_transport_ptr_t, const void*, size_t);
The following functions are to be used for X.509 certificate handling. Their prototypes lie in gnutls/x509.h.
bag: The bag
pass: The password used for encryption. This can only be ASCII.
This function will decrypt the given encrypted bag and return 0 on success.
bag: The structure to be initialized
This function will deinitialize a PKCS12 Bag structure.
bag: The bag
pass: The password used for encryption. This can only be ASCII.
flags: should be one of gnutls_pkcs_encrypt_flags_t elements bitwise or'd
This function will encrypt the given bag and return 0 on success.
bag: The bag
This function will return the number of the elements withing the bag.
bag: The bag
indx: The element of the bag to get the data from
data: where the bag's data will be. Should be treated as constant.
This function will return the bag's data. The data is a constant that is stored into the bag. Should not be accessed after the bag is deleted.
Returns 0 on success and a negative error code on error.
bag: The bag
indx: The bag's element to add the id
name: will hold a pointer to the name (to be treated as const)
This function will return the friendly name, of the specified bag element. The key ID is usually used to distinguish the local private key and the certificate pair.
Returns 0 on success, or a negative value on error.
bag: The bag
indx: The bag's element to add the id
id: where the ID will be copied (to be treated as const)
This function will return the key ID, of the specified bag element. The key ID is usually used to distinguish the local private key and the certificate pair.
Returns 0 on success, or a negative value on error.
bag: The bag
indx: The element of the bag to get the type
This function will return the bag's type. One of the gnutls_pkcs12_bag_type_t enumerations.
bag: The structure to be initialized
This function will initialize a PKCS12 bag structure. PKCS12 Bags usually contain private keys, lists of X.509 Certificates and X.509 Certificate revocation lists.
Returns 0 on success.
bag: The bag
crl: the CRL to be copied.
This function will insert the given CRL into the bag. This is just a wrapper over
gnutls_pkcs12_bag_set_data().Returns the index of the added bag on success, or a negative value on failure.
bag: The bag
crt: the certificate to be copied.
This function will insert the given certificate into the bag. This is just a wrapper over
gnutls_pkcs12_bag_set_data().Returns the index of the added bag on success, or a negative value on failure.
bag: The bag
type: The data's type
data: the data to be copied.
This function will insert the given data of the given type into the bag.
Returns the index of the added bag on success, or a negative value on error.
bag: The bag
indx: The bag's element to add the id
name: the name
This function will add the given key friendly name, to the specified, by the index, bag element. The name will be encoded as a 'Friendly name' bag attribute, which is usually used to set a user name to the local private key and the certificate pair.
Returns 0 on success, or a negative value on error.
bag: The bag
indx: The bag's element to add the id
id: the ID
This function will add the given key ID, to the specified, by the index, bag element. The key ID will be encoded as a 'Local key identifier' bag attribute, which is usually used to distinguish the local private key and the certificate pair.
Returns 0 on success, or a negative value on error.
pkcs12: The structure to be initialized
This function will deinitialize a PKCS12 structure.
pkcs12: Holds the pkcs12 structure
format: the format of output params. One of PEM or DER.
output_data: will contain a structure PEM or DER encoded
output_data_size: holds the size of output_data (and will be replaced by the actual size of parameters)
This function will export the pkcs12 structure to DER or PEM format.
If the buffer provided is not long enough to hold the output, then *output_data_size will be updated and GNUTLS_E_SHORT_MEMORY_BUFFER will be returned.
If the structure is PEM encoded, it will have a header of "BEGIN PKCS12".
Return value: In case of failure a negative value will be returned, and 0 on success.
pkcs12: should contain a gnutls_pkcs12_t structure
pass: The password for the MAC
This function will generate a MAC for the PKCS12 structure. Returns 0 on success.
pkcs12: should contain a gnutls_pkcs12_t structure
indx: contains the index of the bag to extract
bag: An initialized bag, where the contents of the bag will be copied
This function will return a Bag from the PKCS12 structure. Returns 0 on success.
After the last Bag has been read GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE will be returned.
pkcs12: The structure to store the parsed PKCS12.
data: The DER or PEM encoded PKCS12.
format: One of DER or PEM
flags: an ORed sequence of gnutls_privkey_pkcs8_flags
This function will convert the given DER or PEM encoded PKCS12 to the native gnutls_pkcs12_t format. The output will be stored in 'pkcs12'.
If the PKCS12 is PEM encoded it should have a header of "PKCS12".
Returns 0 on success.
pkcs12: The structure to be initialized
This function will initialize a PKCS12 structure. PKCS12 structures usually contain lists of X.509 Certificates and X.509 Certificate revocation lists.
Returns 0 on success.
pkcs12: should contain a gnutls_pkcs12_t structure
bag: An initialized bag
This function will insert a Bag into the PKCS12 structure. Returns 0 on success.
pkcs12: should contain a gnutls_pkcs12_t structure
pass: The password for the MAC
This function will verify the MAC for the PKCS12 structure. Returns 0 on success.
pkcs7: The structure to be initialized
This function will deinitialize a PKCS7 structure.
indx: the index of the crl to delete
This function will delete a crl from a PKCS7 or RFC2630 crl set. Index starts from 0. Returns 0 on success.
indx: the index of the certificate to delete
This function will delete a certificate from a PKCS7 or RFC2630 certificate set. Index starts from 0. Returns 0 on success.
pkcs7: Holds the pkcs7 structure
format: the format of output params. One of PEM or DER.
output_data: will contain a structure PEM or DER encoded
output_data_size: holds the size of output_data (and will be replaced by the actual size of parameters)
This function will export the pkcs7 structure to DER or PEM format.
If the buffer provided is not long enough to hold the output, then *output_data_size is updated and GNUTLS_E_SHORT_MEMORY_BUFFER will be returned.
If the structure is PEM encoded, it will have a header of "BEGIN PKCS7".
Return value: In case of failure a negative value will be returned, and 0 on success.
This function will return the number of certifcates in the PKCS7 or RFC2630 crl set.
Returns a negative value on failure.
indx: contains the index of the crl to extract
crl: the contents of the crl will be copied there (may be null)
crl_size: should hold the size of the crl
This function will return a crl of the PKCS7 or RFC2630 crl set. Returns 0 on success. If the provided buffer is not long enough, then
crl_sizeis updated and GNUTLS_E_SHORT_MEMORY_BUFFER is returned.After the last crl has been read GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE will be returned.
This function will return the number of certifcates in the PKCS7 or RFC2630 certificate set.
Returns a negative value on failure.
indx: contains the index of the certificate to extract
certificate: the contents of the certificate will be copied there (may be null)
certificate_size: should hold the size of the certificate
This function will return a certificate of the PKCS7 or RFC2630 certificate set. Returns 0 on success. If the provided buffer is not long enough, then
certificate_sizeis updated and GNUTLS_E_SHORT_MEMORY_BUFFER is returned.After the last certificate has been read GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE will be returned.
pkcs7: The structure to store the parsed PKCS7.
data: The DER or PEM encoded PKCS7.
format: One of DER or PEM
This function will convert the given DER or PEM encoded PKCS7 to the native gnutls_pkcs7_t format. The output will be stored in 'pkcs7'.
If the PKCS7 is PEM encoded it should have a header of "PKCS7".
Returns 0 on success.
pkcs7: The structure to be initialized
This function will initialize a PKCS7 structure. PKCS7 structures usually contain lists of X.509 Certificates and X.509 Certificate revocation lists.
Returns 0 on success.
crl: the DER encoded crl to be added
This function will add a crl to the PKCS7 or RFC2630 crl set. Returns 0 on success.
crl: the DER encoded crl to be added
This function will add a parsed crl to the PKCS7 or RFC2630 crl set. Returns 0 on success.
crt: the DER encoded certificate to be added
This function will add a certificate to the PKCS7 or RFC2630 certificate set. Returns 0 on success.
crt: the certificate to be copied.
This function will add a parsed certificate to the PKCS7 or RFC2630 certificate set. This is a wrapper function over
gnutls_pkcs7_set_crt_raw().Returns 0 on success.
issuer: is the certificate of a possible issuer
This function will check if the given CRL was issued by the given issuer certificate. It will return true (1) if the given CRL was issued by the given issuer, and false (0) if not.
A negative value is returned in case of an error.
crl: The structure to be initialized
This function will deinitialize a CRL structure.
crl: Holds the revocation list
format: the format of output params. One of PEM or DER.
output_data: will contain a private key PEM or DER encoded
output_data_size: holds the size of output_data (and will be replaced by the actual size of parameters)
This function will export the revocation list to DER or PEM format.
If the buffer provided is not long enough to hold the output, then GNUTLS_E_SHORT_MEMORY_BUFFER will be returned.
If the structure is PEM encoded, it will have a header of "BEGIN X509 CRL".
Returns 0 on success, and a negative value on failure.
crl: should contain a gnutls_x509_crl_t structure
This function will return the number of revoked certificates in the given CRL.
Returns a negative value on failure.
crl: should contain a gnutls_x509_crl_t structure
indx: the index of the certificate to extract (starting from 0)
serial: where the serial number will be copied
serial_size: initially holds the size of serial
t: if non null, will hold the time this certificate was revoked
This function will return the serial number of the specified, by the index, revoked certificate.
Returns a negative value on failure.
crl: should contain a gnutls_x509_crl_t structure
indx: Specifies which DN OID to send. Use zero to get the first one.
oid: a pointer to a structure to hold the name (may be null)
sizeof_oid: initially holds the size of 'oid'
This function will extract the requested OID of the name of the CRL issuer, specified by the given index.
If oid is null then only the size will be filled.
Returns GNUTLS_E_SHORT_MEMORY_BUFFER if the provided buffer is not long enough, and in that case the sizeof_oid will be updated with the required size. On success 0 is returned.
crl: should contain a gnutls_x509_crl_t structure
oid: holds an Object Identified in null terminated string
indx: In case multiple same OIDs exist in the RDN, this specifies which to send. Use zero to get the first one.
raw_flag: If non zero returns the raw DER data of the DN part.
buf: a pointer to a structure to hold the peer's name (may be null)
sizeof_buf: initially holds the size of
bufThis function will extract the part of the name of the CRL issuer specified by the given OID. The output will be encoded as described in RFC2253. The output string will be ASCII or UTF-8 encoded, depending on the certificate data.
Some helper macros with popular OIDs can be found in gnutls/x509.h If raw flag is zero, this function will only return known OIDs as text. Other OIDs will be DER encoded, as described in RFC2253 – in hex format with a '\#' prefix. You can check about known OIDs using
gnutls_x509_dn_oid_known().If buf is null then only the size will be filled.
Returns GNUTLS_E_SHORT_MEMORY_BUFFER if the provided buffer is not long enough, and in that case the sizeof_buf will be updated with the required size, and 0 on success.
crl: should contain a gnutls_x509_crl_t structure
buf: a pointer to a structure to hold the peer's name (may be null)
sizeof_buf: initially holds the size of
bufThis function will copy the name of the CRL issuer in the provided buffer. The name will be in the form "C=xxxx,O=yyyy,CN=zzzz" as described in RFC2253. The output string will be ASCII or UTF-8 encoded, depending on the certificate data.
If buf is null then only the size will be filled.
Returns GNUTLS_E_SHORT_MEMORY_BUFFER if the provided buffer is not long enough, and in that case the sizeof_buf will be updated with the required size, and 0 on success.
crl: should contain a gnutls_x509_crl_t structure
This function will return the time the next CRL will be issued. This field is optional in a CRL so it might be normal to get an error instead.
Returns (time_t)-1 on error.
crl: should contain a gnutls_x509_crl_t structure
This function will return a value of the gnutls_sign_algorithm_t enumeration that is the signature algorithm.
Returns a negative value on error.
crl: should contain a gnutls_x509_crl_t structure
sig: a pointer where the signature part will be copied (may be null).
sizeof_sig: initially holds the size of
sigThis function will extract the signature field of a CRL.
Returns 0 on success, and a negative value on error.
crl: should contain a gnutls_x509_crl_t structure
This function will return the time this CRL was issued.
Returns (time_t)-1 on error.
crl: should contain a gnutls_x509_crl_t structure
This function will return the version of the specified CRL.
Returns a negative value on error.
crl: The structure to store the parsed CRL.
data: The DER or PEM encoded CRL.
format: One of DER or PEM
This function will convert the given DER or PEM encoded CRL to the native gnutls_x509_crl_t format. The output will be stored in 'crl'.
If the CRL is PEM encoded it should have a header of "X509 CRL".
Returns 0 on success.
crl: The structure to be initialized
This function will initialize a CRL structure. CRL stands for Certificate Revocation List. A revocation list usually contains lists of certificate serial numbers that have been revoked by an Authority. The revocation lists are always signed with the authority's private key.
Returns 0 on success.
crl: The structure to be printed
format: Indicate the format to use
out: Newly allocated datum with zero terminated string.
This function will pretty print a X.509 certificate revocation list, suitable for display to a human.
The output
outneeds to be deallocate usinggnutls_free().Returns 0 on success.
crl: should contain a gnutls_x509_crl_t structure
serial: The revoked certificate's serial number
serial_size: Holds the size of the serial field.
revocation_time: The time this certificate was revoked
This function will set a revoked certificate's serial number to the CRL.
Returns 0 on success, or a negative value in case of an error.
crl: should contain a gnutls_x509_crl_t structure
crt: should contain a gnutls_x509_crt_t structure with the revoked certificate
revocation_time: The time this certificate was revoked
This function will set a revoked certificate's serial number to the CRL.
Returns 0 on success, or a negative value in case of an error.
crl: should contain a gnutls_x509_crl_t structure
exp_time: The actual time
This function will set the time this CRL will be updated.
Returns 0 on success, or a negative value in case of an error.
crl: should contain a gnutls_x509_crl_t structure
act_time: The actual time
This function will set the time this CRL was issued.
Returns 0 on success, or a negative value in case of an error.
crl: should contain a gnutls_x509_crl_t structure
version: holds the version number. For CRLv1 crls must be 1.
This function will set the version of the CRL. This must be one for CRL version 1, and so on. The CRLs generated by gnutls should have a version number of 2.
Returns 0 on success.
crl: should contain a gnutls_x509_crl_t structure
issuer: is the certificate of the certificate issuer
issuer_key: holds the issuer's private key
dig: The message digest to use. GNUTLS_DIG_SHA1 is the safe choice unless you know what you're doing.
flags: must be 0
This function will sign the CRL with the issuer's private key, and will copy the issuer's information into the CRL.
This must be the last step in a certificate CRL since all the previously set parameters are now signed.
Returns 0 on success.
crl: should contain a gnutls_x509_crl_t structure
issuer: is the certificate of the certificate issuer
issuer_key: holds the issuer's private key
This function is the same a
gnutls_x509_crl_sign2()with no flags, and SHA1 as the hash algorithm.Returns 0 on success.
crl: is the crl to be verified
CA_list: is a certificate list that is considered to be trusted one
CA_list_length: holds the number of CA certificates in CA_list
flags: Flags that may be used to change the verification algorithm. Use OR of the gnutls_certificate_verify_flags enumerations.
verify: will hold the crl verification output.
This function will try to verify the given crl and return its status. See
gnutls_x509_crt_list_verify()for a detailed description of return values.Returns 0 on success and a negative value in case of an error.
crq: The structure to be initialized
This function will deinitialize a CRL structure.
crq: Holds the request
format: the format of output params. One of PEM or DER.
output_data: will contain a certificate request PEM or DER encoded
output_data_size: holds the size of output_data (and will be replaced by the actual size of parameters)
This function will export the certificate request to a PKCS10
If the buffer provided is not long enough to hold the output, then GNUTLS_E_SHORT_MEMORY_BUFFER will be returned and *output_data_size will be updated.
If the structure is PEM encoded, it will have a header of "BEGIN NEW CERTIFICATE REQUEST".
Return value: In case of failure a negative value will be returned, and 0 on success.
crq: should contain a gnutls_x509_crq_t structure
oid: holds an Object Identified in null terminated string
indx: In case multiple same OIDs exist in the attribute list, this specifies which to send. Use zero to get the first one.
buf: a pointer to a structure to hold the attribute data (may be null)
sizeof_buf: initially holds the size of
bufThis function will return the attribute in the certificate request specified by the given Object ID. The attribute will be DER encoded.
Returns 0 on success.
crq: should contain a gnutls_x509_crq_t structure
pass: will hold a null terminated password
sizeof_pass: Initially holds the size of
pass.This function will return the challenge password in the request.
Returns 0 on success.
crq: should contain a gnutls_x509_crq_t structure
oid: holds an Object Identified in null terminated string
indx: In case multiple same OIDs exist in the RDN, this specifies which to send. Use zero to get the first one.
raw_flag: If non zero returns the raw DER data of the DN part.
buf: a pointer to a structure to hold the name (may be null)
sizeof_buf: initially holds the size of
bufThis function will extract the part of the name of the Certificate request subject, specified by the given OID. The output will be encoded as described in RFC2253. The output string will be ASCII or UTF-8 encoded, depending on the certificate data.
Some helper macros with popular OIDs can be found in gnutls/x509.h If raw flag is zero, this function will only return known OIDs as text. Other OIDs will be DER encoded, as described in RFC2253 – in hex format with a '\#' prefix. You can check about known OIDs using
gnutls_x509_dn_oid_known().If
bufis null then only the size will be filled.Returns GNUTLS_E_SHORT_MEMORY_BUFFER if the provided buffer is not long enough, and in that case the *sizeof_buf will be updated with the required size. On success 0 is returned.
crq: should contain a gnutls_x509_crq_t structure
indx: Specifies which DN OID to send. Use zero to get the first one.
oid: a pointer to a structure to hold the name (may be null)
sizeof_oid: initially holds the size of
oidThis function will extract the requested OID of the name of the Certificate request subject, specified by the given index.
If oid is null then only the size will be filled.
Returns GNUTLS_E_SHORT_MEMORY_BUFFER if the provided buffer is not long enough, and in that case the *sizeof_oid will be updated with the required size. On success 0 is returned.
crq: should contain a gnutls_x509_crq_t structure
buf: a pointer to a structure to hold the name (may be null)
sizeof_buf: initially holds the size of
bufThis function will copy the name of the Certificate request subject in the provided buffer. The name will be in the form "C=xxxx,O=yyyy,CN=zzzz" as described in RFC2253. The output string will be ASCII or UTF-8 encoded, depending on the certificate data.
If
bufis null then only the size will be filled.Returns GNUTLS_E_SHORT_MEMORY_BUFFER if the provided buffer is not long enough, and in that case the *sizeof_buf will be updated with the required size. On success 0 is returned.
crq: should contain a gnutls_x509_crq_t structure
bits: if bits is non null it will hold the size of the parameters' in bits
This function will return the public key algorithm of a PKCS \
10certificate request.If bits is non null, it should have enough size to hold the parameters size in bits. For RSA the bits returned is the modulus. For DSA the bits returned are of the public exponent.
Returns a member of the gnutls_pk_algorithm_t enumeration on success, or a negative value on error.
crq: should contain a gnutls_x509_crq_t structure
This function will return the version of the specified Certificate request.
Returns a negative value on error.
crq: The structure to store the parsed certificate request.
data: The DER or PEM encoded certificate.
format: One of DER or PEM
This function will convert the given DER or PEM encoded Certificate to the native gnutls_x509_crq_t format. The output will be stored in
cert.If the Certificate is PEM encoded it should have a header of "NEW CERTIFICATE REQUEST".
Returns 0 on success.
crq: The structure to be initialized
This function will initialize a PKCS10 certificate request structure.
Returns 0 on success.
crq: should contain a gnutls_x509_crq_t structure
oid: holds an Object Identified in null terminated string
buf: a pointer to a structure that holds the attribute data
sizeof_buf: holds the size of
bufThis function will set the attribute in the certificate request specified by the given Object ID. The attribute must be be DER encoded.
Returns 0 on success.
crq: should contain a gnutls_x509_crq_t structure
pass: holds a null terminated password
This function will set a challenge password to be used when revoking the request.
Returns 0 on success.
crq: should contain a gnutls_x509_crq_t structure
oid: holds an Object Identifier in a null terminated string
raw_flag: must be 0, or 1 if the data are DER encoded
data: a pointer to the input data
sizeof_data: holds the size of
dataThis function will set the part of the name of the Certificate request subject, specified by the given OID. The input string should be ASCII or UTF-8 encoded.
Some helper macros with popular OIDs can be found in gnutls/x509.h With this function you can only set the known OIDs. You can test for known OIDs using
gnutls_x509_dn_oid_known(). For OIDs that are not known (by gnutls) you should properly DER encode your data, and call this function with raw_flag set.Returns 0 on success.
crq: should contain a gnutls_x509_crq_t structure
key: holds a private key
This function will set the public parameters from the given private key to the request. Only RSA keys are currently supported.
Returns 0 on success.
crq: should contain a gnutls_x509_crq_t structure
version: holds the version number. For v1 Requests must be 1.
This function will set the version of the certificate request. For version 1 requests this must be one.
Returns 0 on success.
crq: should contain a gnutls_x509_crq_t structure
key: holds a private key
dig: The message digest to use. GNUTLS_DIG_SHA1 is the safe choice unless you know what you're doing.
flags: must be 0
This function will sign the certificate request with a private key. This must be the same key as the one used in
gnutls_x509_crt_set_key()since a certificate request is self signed.This must be the last step in a certificate request generation since all the previously set parameters are now signed.
Returns 0 on success.
crq: should contain a gnutls_x509_crq_t structure
key: holds a private key
This function is the same a
gnutls_x509_crq_sign2()with no flags, and SHA1 as the hash algorithm.Returns 0 on success.
cert: should contain an gnutls_x509_crt_t structure
hostname: A null terminated string that contains a DNS name
This function will check if the given certificate's subject matches the given hostname. This is a basic implementation of the matching described in RFC2818 (HTTPS), which takes into account wildcards, and the DNSName/IPAddress subject alternative name PKIX extension.
Returns non zero for a successful match, and zero on failure.
cert: is the certificate to be checked
issuer: is the certificate of a possible issuer
This function will check if the given certificate was issued by the given issuer. It will return true (1) if the given certificate is issued by the given issuer, and false (0) if not.
A negative value is returned in case of an error.
cert: should contain a gnutls_x509_crt_t structure
crl_list: should contain a list of gnutls_x509_crl_t structures
crl_list_length: the length of the crl_list
This function will return check if the given certificate is revoked. It is assumed that the CRLs have been verified before.
Returns 0 if the certificate is NOT revoked, and 1 if it is. A negative value is returned on error.
dst: should contain a gnutls_x509_crt_t structure
src: the certificate where the dist points will be copied from
This function will copy the CRL distribution points certificate extension, from the source to the destination certificate. This may be useful to copy from a CA certificate to issued ones.
Returns 0 on success.
cert: The structure to be initialized
This function will deinitialize a CRL structure.
cert: Holds the certificate
format: the format of output params. One of PEM or DER.
output_data: will contain a certificate PEM or DER encoded
output_data_size: holds the size of output_data (and will be replaced by the actual size of parameters)
This function will export the certificate to DER or PEM format.
If the buffer provided is not long enough to hold the output, then *output_data_size is updated and GNUTLS_E_SHORT_MEMORY_BUFFER will be returned.
If the structure is PEM encoded, it will have a header of "BEGIN CERTIFICATE".
Return value: In case of failure a negative value will be returned, and 0 on success.
cert: should contain a gnutls_x509_crt_t structure
This function will return the time this Certificate was or will be activated.
Returns (time_t)-1 on error.
cert: should contain a gnutls_x509_crt_t structure
critical: will be non zero if the extension is marked as critical (may be null)
This function will return the X.509v3 certificate authority's key identifier. This is obtained by the X.509 Authority Key identifier extension field (2.5.29.35). Note that this function only returns the keyIdentifier field of the extension.
Returns 0 on success and a negative value in case of an error.
cert: should contain a gnutls_x509_crt_t structure
critical: will be non zero if the extension is marked as critical
ca: pointer to output integer indicating CA status, may be NULL, value is 1 if the certificate CA flag is set, 0 otherwise.
pathlen: pointer to output integer indicating path length (may be NULL), non-negative values indicate a present pathLenConstraint field and the actual value, -1 indicate that the field is absent.
This function will read the certificate's basic constraints, and return the certificates CA status. It reads the basicConstraints X.509 extension (2.5.29.19).
Return value: If the certificate is a CA a positive value will be returned, or zero if the certificate does not have CA flag set. A negative value may be returned in case of errors. If the certificate does not contain the basicConstraints extension GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE will be returned.
cert: should contain a gnutls_x509_crt_t structure
critical: will be non zero if the extension is marked as critical
This function will return certificates CA status, by reading the basicConstraints X.509 extension (2.5.29.19). If the certificate is a CA a positive value will be returned, or zero if the certificate does not have CA flag set.
Use
gnutls_x509_crt_get_basic_constraints()if you want to read the pathLenConstraint field too.A negative value may be returned in case of parsing error. If the certificate does not contain the basicConstraints extension GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE will be returned.
cert: should contain a gnutls_x509_crt_t structure
seq: specifies the sequence number of the distribution point (0 for the first one, 1 for the second etc.)
ret: is the place where the distribution point will be copied to
ret_size: holds the size of ret.
reason_flags: Revocation reasons flags.
critical: will be non zero if the extension is marked as critical (may be null)
This function will return the CRL distribution points (2.5.29.31), contained in the given certificate.
reason_flagsshould be an ORed sequence of GNUTLS_CRL_REASON_UNUSED, GNUTLS_CRL_REASON_KEY_COMPROMISE, GNUTLS_CRL_REASON_CA_COMPROMISE, GNUTLS_CRL_REASON_AFFILIATION_CHANGED, GNUTLS_CRL_REASON_SUPERSEEDED, GNUTLS_CRL_REASON_CESSATION_OF_OPERATION, GNUTLS_CRL_REASON_CERTIFICATE_HOLD, GNUTLS_CRL_REASON_PRIVILEGE_WITHDRAWN, GNUTLS_CRL_REASON_AA_COMPROMISE, or zero for all possible reasons.This is specified in X509v3 Certificate Extensions. GNUTLS will return the distribution point type, or a negative error code on error.
Returns GNUTLS_E_SHORT_MEMORY_BUFFER and updates &ret_size if &ret_size is not enough to hold the distribution point, or the type of the distribution point if everything was ok. The type is one of the enumerated gnutls_x509_subject_alt_name_t.
If the certificate does not have an Alternative name with the specified sequence number then returns GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE;
cert: should contain a gnutls_x509_crt_t structure
oid: holds an Object Identified in null terminated string
indx: In case multiple same OIDs exist in the RDN, this specifies which to send. Use zero to get the first one.
raw_flag: If non zero returns the raw DER data of the DN part.
buf: a pointer where the DN part will be copied (may be null).
sizeof_buf: initially holds the size of
bufThis function will extract the part of the name of the Certificate subject specified by the given OID. The output, if the raw flag is not used, will be encoded as described in RFC2253. Thus a string that is ASCII or UTF-8 encoded, depending on the certificate data.
Some helper macros with popular OIDs can be found in gnutls/x509.h If raw flag is zero, this function will only return known OIDs as text. Other OIDs will be DER encoded, as described in RFC2253 – in hex format with a '\#' prefix. You can check about known OIDs using
gnutls_x509_dn_oid_known().If
bufis null then only the size will be filled.Returns GNUTLS_E_SHORT_MEMORY_BUFFER if the provided buffer is not long enough, and in that case the *sizeof_buf will be updated with the required size. On success 0 is returned.
cert: should contain a gnutls_x509_crt_t structure
indx: This specifies which OID to return. Use zero to get the first one.
oid: a pointer to a buffer to hold the OID (may be null)
sizeof_oid: initially holds the size of
oidThis function will extract the OIDs of the name of the Certificate subject specified by the given index.
If oid is null then only the size will be filled.
Returns GNUTLS_E_SHORT_MEMORY_BUFFER if the provided buffer is not long enough, and in that case the *sizeof_oid will be updated with the required size. On success 0 is returned.
cert: should contain a gnutls_x509_crt_t structure
buf: a pointer to a structure to hold the name (may be null)
sizeof_buf: initially holds the size of
bufThis function will copy the name of the Certificate in the provided buffer. The name will be in the form "C=xxxx,O=yyyy,CN=zzzz" as described in RFC2253. The output string will be ASCII or UTF-8 encoded, depending on the certificate data.
If
bufis null then only the size will be filled.Returns GNUTLS_E_SHORT_MEMORY_BUFFER if the provided buffer is not long enough, and in that case the *sizeof_buf will be updated with the required size. On success 0 is returned.
cert: should contain a gnutls_x509_crt_t structure
This function will return the time this Certificate was or will be expired.
Returns (time_t)-1 on error.
cert: should contain a gnutls_x509_crt_t structure
oid: holds an Object Identified in null terminated string
indx: In case multiple same OIDs exist in the extensions, this specifies which to send. Use zero to get the first one.
buf: a pointer to a structure to hold the name (may be null)
sizeof_buf: initially holds the size of
bufcritical: will be non zero if the extension is marked as critical
This function will return the extension specified by the OID in the certificate. The extensions will be returned as binary data DER encoded, in the provided buffer.
A negative value may be returned in case of parsing error. If the certificate does not contain the specified extension GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE will be returned.
cert: should contain a gnutls_x509_crt_t structure
indx: Specifies which extension OID to send. Use zero to get the first one.
data: a pointer to a structure to hold the data (may be null)
sizeof_data: initially holds the size of
oidThis function will return the requested extension data in the certificate. The extension data will be stored as a string in the provided buffer.
Use
gnutls_x509_crt_get_extension_info()to extract the OID and critical flag. Usegnutls_x509_crt_get_extension_by_oid()instead, if you want to get data indexed by the extension OID rather than sequence.Return 0 on success. A negative value may be returned in case of parsing error. If you have reached the last extension available GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE will be returned.
cert: should contain a gnutls_x509_crt_t structure
indx: Specifies which extension OID to send. Use zero to get the first one.
oid: a pointer to a structure to hold the OID
sizeof_oid: initially holds the size of
oidcritical: output variable with critical flag, may be NULL.
This function will return the requested extension OID in the certificate, and the critical flag for it. The extension OID will be stored as a string in the provided buffer. Use
gnutls_x509_crt_get_extension_data()to extract the data.Return 0 on success. A negative value may be returned in case of parsing error. If you have reached the last extension available GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE will be returned.
cert: should contain a gnutls_x509_crt_t structure
indx: Specifies which extension OID to send. Use zero to get the first one.
oid: a pointer to a structure to hold the OID (may be null)
sizeof_oid: initially holds the size of
oidThis function will return the requested extension OID in the certificate. The extension OID will be stored as a string in the provided buffer.
A negative value may be returned in case of parsing error. If your have reached the last extension available GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE will be returned.
cert: should contain a gnutls_x509_crt_t structure
algo: is a digest algorithm
buf: a pointer to a structure to hold the fingerprint (may be null)
sizeof_buf: initially holds the size of
bufThis function will calculate and copy the certificate's fingerprint in the provided buffer.
If the buffer is null then only the size will be filled.
Returns GNUTLS_E_SHORT_MEMORY_BUFFER if the provided buffer is not long enough, and in that case the *sizeof_buf will be updated with the required size. On success 0 is returned.
cert: should contain a gnutls_x509_crt_t structure
oid: holds an Object Identified in null terminated string
indx: In case multiple same OIDs exist in the RDN, this specifies which to send. Use zero to get the first one.
raw_flag: If non zero returns the raw DER data of the DN part.
buf: a pointer to a structure to hold the name (may be null)
sizeof_buf: initially holds the size of
bufThis function will extract the part of the name of the Certificate issuer specified by the given OID. The output, if the raw flag is not used, will be encoded as described in RFC2253. Thus a string that is ASCII or UTF-8 encoded, depending on the certificate data.
Some helper macros with popular OIDs can be found in gnutls/x509.h If raw flag is zero, this function will only return known OIDs as text. Other OIDs will be DER encoded, as described in RFC2253 – in hex format with a '\#' prefix. You can check about known OIDs using
gnutls_x509_dn_oid_known().If
bufis null then only the size will be filled.Returns GNUTLS_E_SHORT_MEMORY_BUFFER if the provided buffer is not long enough, and in that case the *sizeof_buf will be updated with the required size. On success 0 is returned.
cert: should contain a gnutls_x509_crt_t structure
indx: This specifies which OID to return. Use zero to get the first one.
oid: a pointer to a buffer to hold the OID (may be null)
sizeof_oid: initially holds the size of
oidThis function will extract the OIDs of the name of the Certificate issuer specified by the given index.
If
oidis null then only the size will be filled.Returns GNUTLS_E_SHORT_MEMORY_BUFFER if the provided buffer is not long enough, and in that case the *sizeof_oid will be updated with the required size. On success 0 is returned.
cert: should contain a gnutls_x509_crt_t structure
buf: a pointer to a structure to hold the name (may be null)
sizeof_buf: initially holds the size of
bufThis function will copy the name of the Certificate issuer in the provided buffer. The name will be in the form "C=xxxx,O=yyyy,CN=zzzz" as described in RFC2253. The output string will be ASCII or UTF-8 encoded, depending on the certificate data.
If
bufis null then only the size will be filled.Returns GNUTLS_E_SHORT_MEMORY_BUFFER if the provided buffer is not long enough, and in that case the *sizeof_buf will be updated with the required size. On success 0 is returned.
cert: should contain a gnutls_x509_crt_t structure
dn: output variable with pointer to opaque DN
Return the Certificate's Issuer DN as an opaque data type. You may use
gnutls_x509_dn_get_rdn_ava()to decode the DN.Note that
dnpoints into thecertobject, and thus you may not deallocatecertand continue to accessdn.Returns: Returns 0 on success, or an error code.
crt: Holds the certificate
flags: should be 0 for now
output_data: will contain the key ID
output_data_size: holds the size of output_data (and will be replaced by the actual size of parameters)
This function will return a unique ID the depends on the public key parameters. This ID can be used in checking whether a certificate corresponds to the given private key.
If the buffer provided is not long enough to hold the output, then *output_data_size is updated and GNUTLS_E_SHORT_MEMORY_BUFFER will be returned. The output will normally be a SHA-1 hash output, which is 20 bytes.
Return value: In case of failure a negative value will be returned, and 0 on success.
cert: should contain a gnutls_x509_crt_t structure
indx: This specifies which OID to return. Use zero to get the first one.
oid: a pointer to a buffer to hold the OID (may be null)
sizeof_oid: initially holds the size of
oidThis function will extract the key purpose OIDs of the Certificate specified by the given index. These are stored in the Extended Key Usage extension (2.5.29.37) See the GNUTLS_KP_* definitions for human readable names.
If
oidis null then only the size will be filled.Returns GNUTLS_E_SHORT_MEMORY_BUFFER if the provided buffer is not long enough, and in that case the *sizeof_oid will be updated with the required size. On success 0 is returned.
cert: should contain a gnutls_x509_crt_t structure
key_usage: where the key usage bits will be stored
critical: will be non zero if the extension is marked as critical
This function will return certificate's key usage, by reading the keyUsage X.509 extension (2.5.29.15). The key usage value will ORed values of the: GNUTLS_KEY_DIGITAL_SIGNATURE, GNUTLS_KEY_NON_REPUDIATION, GNUTLS_KEY_KEY_ENCIPHERMENT, GNUTLS_KEY_DATA_ENCIPHERMENT, GNUTLS_KEY_KEY_AGREEMENT, GNUTLS_KEY_KEY_CERT_SIGN, GNUTLS_KEY_CRL_SIGN, GNUTLS_KEY_ENCIPHER_ONLY, GNUTLS_KEY_DECIPHER_ONLY.
A negative value may be returned in case of parsing error. If the certificate does not contain the keyUsage extension GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE will be returned.
cert: should contain a gnutls_x509_crt_t structure
bits: if bits is non null it will hold the size of the parameters' in bits
This function will return the public key algorithm of an X.509 certificate.
If bits is non null, it should have enough size to hold the parameters size in bits. For RSA the bits returned is the modulus. For DSA the bits returned are of the public exponent.
Returns a member of the gnutls_pk_algorithm_t enumeration on success, or a negative value on error.
crt: Holds the certificate
p: will hold the p
q: will hold the q
g: will hold the g
y: will hold the y
This function will export the DSA private key's parameters found in the given certificate. The new parameters will be allocated using
gnutls_malloc()and will be stored in the appropriate datum.
crt: Holds the certificate
m: will hold the modulus
e: will hold the public exponent
This function will export the RSA private key's parameters found in the given structure. The new parameters will be allocated using
gnutls_malloc()and will be stored in the appropriate datum.
cert: should contain a gnutls_x509_crt_t structure
critical: will be non zero if the extension is marked as critical
pathlen: pointer to output integer indicating path length (may be NULL), non-negative values indicate a present pCPathLenConstraint field and the actual value, -1 indicate that the field is absent.
This function will read the certificate's basic constraints, and return the certificates CA status. It reads the basicConstraints X.509 extension (2.5.29.19).
Return value: If the certificate is a CA a positive value will be returned, or zero if the certificate does not have CA flag set. A negative value may be returned in case of errors. If the certificate does not contain the basicConstraints extension GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE will be returned.
cert: should contain a gnutls_x509_crt_t structure
result: The place where the serial number will be copied
result_size: Holds the size of the result field.
This function will return the X.509 certificate's serial number. This is obtained by the X509 Certificate serialNumber field. Serial is not always a 32 or 64bit number. Some CAs use large serial numbers, thus it may be wise to handle it as something opaque.
Returns 0 on success and a negative value in case of an error.
cert: should contain a gnutls_x509_crt_t structure
This function will return a value of the gnutls_sign_algorithm_t enumeration that is the signature algorithm.
Returns a negative value on error.
cert: should contain a gnutls_x509_crt_t structure
sig: a pointer where the signature part will be copied (may be null).
sizeof_sig: initially holds the size of
sigThis function will extract the signature field of a certificate.
Returns 0 on success, and a negative value on error.
cert: should contain a gnutls_x509_crt_t structure
seq: specifies the sequence number of the alt name (0 for the first one, 1 for the second etc.)
ret: is the place where the alternative name will be copied to
ret_size: holds the size of ret.
critical: will be non zero if the extension is marked as critical (may be null)
This function will return the alternative names, contained in the given certificate.
This is specified in X509v3 Certificate Extensions. GNUTLS will return the Alternative name (2.5.29.17), or a negative error code.
When the SAN type is otherName, it will extract the data in the otherName's value field, and
GNUTLS_SAN_OTHERNAMEis returned. You may usegnutls_x509_crt_get_subject_alt_othername_oid()to get the corresponding OID and the "virtual" SAN types (e.g.,GNUTLS_SAN_OTHERNAME_XMPP).If an otherName OID is known, the data will be decoded. Otherwise the returned data will be DER encoded, and you will have to decode it yourself. Currently, only the RFC 3920 id-on-xmppAddr SAN is recognized.
Returns the alternative subject name type on success. The type is one of the enumerated gnutls_x509_subject_alt_name_t. It will return
GNUTLS_E_SHORT_MEMORY_BUFFERifret_sizeis not large enough to hold the value. In that caseret_sizewill be updated with the required size. If the certificate does not have an Alternative name with the specified sequence number thenGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLEis returned.
cert: should contain a gnutls_x509_crt_t structure
seq: specifies the sequence number of the alt name (0 for the first one, 1 for the second etc.)
ret: is the place where the otherName OID will be copied to
ret_size: holds the size of ret.
This function will extract the type OID of an otherName Subject Alternative Name, contained in the given certificate, and return the type as an enumerated element.
This function is only useful if
gnutls_x509_crt_get_subject_alt_name()returnedGNUTLS_SAN_OTHERNAME.Returns the alternative subject name type on success. The type is one of the enumerated gnutls_x509_subject_alt_name_t. For supported OIDs, it will return one of the virtual (GNUTLS_SAN_OTHERNAME_*) types, e.g.
GNUTLS_SAN_OTHERNAME_XMPP, andGNUTLS_SAN_OTHERNAMEfor unknown OIDs. It will returnGNUTLS_E_SHORT_MEMORY_BUFFERifret_sizeis not large enough to hold the value. In that caseret_sizewill be updated with the required size. If the certificate does not have an Alternative name with the specified sequence number and with the otherName type thenGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLEis returned.
cert: should contain a gnutls_x509_crt_t structure
ret: The place where the identifier will be copied
ret_size: Holds the size of the result field.
critical: will be non zero if the extension is marked as critical (may be null)
This function will return the X.509v3 certificate's subject key identifier. This is obtained by the X.509 Subject Key identifier extension field (2.5.29.14).
Returns 0 on success and a negative value in case of an error.
cert: should contain a gnutls_x509_crt_t structure
dn: output variable with pointer to opaque DN.
Return the Certificate's Subject DN as an opaque data type. You may use
gnutls_x509_dn_get_rdn_ava()to decode the DN.Returns: Returns 0 on success, or an error code.
cert: should contain a gnutls_x509_crt_t structure
This function will return the version of the specified Certificate.
Returns a negative value on error.
cert: The structure to store the parsed certificate.
data: The DER or PEM encoded certificate.
format: One of DER or PEM
This function will convert the given DER or PEM encoded Certificate to the native gnutls_x509_crt_t format. The output will be stored in
cert.If the Certificate is PEM encoded it should have a header of "X509 CERTIFICATE", or "CERTIFICATE".
Returns 0 on success.
cert: The structure to be initialized
This function will initialize an X.509 certificate structure.
Returns 0 on success.
certs: The structures to store the parsed certificate. Must not be initialized.
cert_max: Initially must hold the maximum number of certs. It will be updated with the number of certs available.
data: The PEM encoded certificate.
format: One of DER or PEM.
flags: must be zero or an OR'd sequence of gnutls_certificate_import_flags.
This function will convert the given PEM encoded certificate list to the native gnutls_x509_crt_t format. The output will be stored in
certs. They will be automatically initialized.If the Certificate is PEM encoded it should have a header of "X509 CERTIFICATE", or "CERTIFICATE".
Returns the number of certificates read or a negative error value.
cert_list: is the certificate list to be verified
cert_list_length: holds the number of certificate in cert_list
CA_list: is the CA list which will be used in verification
CA_list_length: holds the number of CA certificate in CA_list
CRL_list: holds a list of CRLs.
CRL_list_length: the length of CRL list.
flags: Flags that may be used to change the verification algorithm. Use OR of the gnutls_certificate_verify_flags enumerations.
verify: will hold the certificate verification output.
This function will try to verify the given certificate list and return its status. Note that expiration and activation dates are not checked by this function, you should check them using the appropriate functions.
If no flags are specified (0), this function will use the basicConstraints (2.5.29.19) PKIX extension. This means that only a certificate authority is allowed to sign a certificate.
You must also check the peer's name in order to check if the verified certificate belongs to the actual peer.
The certificate verification output will be put in
verifyand will be one or more of the gnutls_certificate_status_t enumerated elements bitwise or'd. For a more detailed verification status usegnutls_x509_crt_verify()per list element.GNUTLS_CERT_INVALID: the certificate chain is not valid.
GNUTLS_CERT_REVOKED: a certificate in the chain has been revoked.
Returns 0 on success and a negative value in case of an error.
cert: The structure to be printed
format: Indicate the format to use
out: Newly allocated datum with zero terminated string.
This function will pretty print a X.509 certificate, suitable for display to a human.
If the format is
GNUTLS_X509_CRT_FULLthen all fields of the certificate will be output, on multiple lines. TheGNUTLS_X509_CRT_ONELINEformat will generate one line with some selected fields, which is useful for logging purposes.The output
outneeds to be deallocate usinggnutls_free().Returns 0 on success.
cert: should contain a gnutls_x509_crt_t structure
act_time: The actual time
This function will set the time this Certificate was or will be activated.
Returns 0 on success, or a negative value in case of an error.
cert: should contain a gnutls_x509_crt_t structure
id: The key ID
id_size: Holds the size of the serial field.
This function will set the X.509 certificate's authority key ID extension. Only the keyIdentifier field can be set with this function.
Returns 0 on success, or a negative value in case of an error.
crt: should contain a gnutls_x509_crt_t structure
ca: true(1) or false(0). Depending on the Certificate authority status.
pathLenConstraint: non-negative values indicate maximum length of path, and negative values indicate that the pathLenConstraints field should not be present.
This function will set the basicConstraints certificate extension.
Returns 0 on success.
crt: should contain a gnutls_x509_crt_t structure
ca: true(1) or false(0). Depending on the Certificate authority status.
This function will set the basicConstraints certificate extension. Use
gnutls_x509_crt_set_basic_constraints()if you want to control the pathLenConstraint field too.Returns 0 on success.
crt: should contain a gnutls_x509_crt_t structure
type: is one of the gnutls_x509_subject_alt_name_t enumerations
data_string: The data to be set
reason_flags: revocation reasons
This function will set the CRL distribution points certificate extension.
Returns 0 on success.
crt: should contain a gnutls_x509_crt_t structure
crq: holds a certificate request
This function will set the name and public parameters from the given certificate request to the certificate. Only RSA keys are currently supported.
Returns 0 on success.
crt: should contain a gnutls_x509_crt_t structure
oid: holds an Object Identifier in a null terminated string
raw_flag: must be 0, or 1 if the data are DER encoded
name: a pointer to the name
sizeof_name: holds the size of
nameThis function will set the part of the name of the Certificate subject, specified by the given OID. The input string should be ASCII or UTF-8 encoded.
Some helper macros with popular OIDs can be found in gnutls/x509.h With this function you can only set the known OIDs. You can test for known OIDs using
gnutls_x509_dn_oid_known(). For OIDs that are not known (by gnutls) you should properly DER encode your data, and call this function with raw_flag set.Returns 0 on success.
cert: should contain a gnutls_x509_crt_t structure
exp_time: The actual time
This function will set the time this Certificate will expire.
Returns 0 on success, or a negative value in case of an error.
crt: should contain a gnutls_x509_crt_t structure
oid: holds an Object Identified in null terminated string
buf: a pointer to a DER encoded data
sizeof_buf: holds the size of
bufcritical: should be non zero if the extension is to be marked as critical
This function will set an the extension, by the specified OID, in the certificate. The extension data should be binary data DER encoded.
Returns 0 on success and a negative value in case of an error.
crt: should contain a gnutls_x509_crt_t structure
oid: holds an Object Identifier in a null terminated string
raw_flag: must be 0, or 1 if the data are DER encoded
name: a pointer to the name
sizeof_name: holds the size of
nameThis function will set the part of the name of the Certificate issuer, specified by the given OID. The input string should be ASCII or UTF-8 encoded.
Some helper macros with popular OIDs can be found in gnutls/x509.h With this function you can only set the known OIDs. You can test for known OIDs using
gnutls_x509_dn_oid_known(). For OIDs that are not known (by gnutls) you should properly DER encode your data, and call this function with raw_flag set.Normally you do not need to call this function, since the signing operation will copy the signer's name as the issuer of the certificate.
Returns 0 on success.
cert: should contain a gnutls_x509_crt_t structure
oid: a pointer to a null terminated string that holds the OID
critical: Whether this extension will be critical or not
This function will set the key purpose OIDs of the Certificate. These are stored in the Extended Key Usage extension (2.5.29.37) See the GNUTLS_KP_* definitions for human readable names.
Subsequent calls to this function will append OIDs to the OID list.
On success 0 is returned.
crt: should contain a gnutls_x509_crt_t structure
usage: an ORed sequence of the GNUTLS_KEY_* elements.
This function will set the keyUsage certificate extension.
Returns 0 on success.
crt: should contain a gnutls_x509_crt_t structure
key: holds a private key
This function will set the public parameters from the given private key to the certificate. Only RSA keys are currently supported.
Returns 0 on success.
crt: a gnutls_x509_crt_t structure with the new proxy cert
eecrt: the end entity certificate that will be issuing the proxy
raw_flag: must be 0, or 1 if the CN is DER encoded
name: a pointer to the CN name, may be NULL (but MUST then be added later)
sizeof_name: holds the size of
nameThis function will set the subject in
crtto the end entity'seecrtsubject name, and add a single Common Name componentnameof sizesizeof_name. This corresponds to the required proxy certificate naming style. Note that ifnameisNULL, you MUST set it later by usinggnutls_x509_crt_set_dn_by_oid()or similar.Returns 0 on success.
crt: should contain a gnutls_x509_crt_t structure
pathLenConstraint: non-negative values indicate maximum length of path, and negative values indicate that the pathLenConstraints field should not be present.
policyLanguage: OID describing the language of
policy.policy: opaque byte array with policy language, can be
NULLsizeof_policy: size of
policy.This function will set the proxyCertInfo extension.
Returns 0 on success.
cert: should contain a gnutls_x509_crt_t structure
serial: The serial number
serial_size: Holds the size of the serial field.
This function will set the X.509 certificate's serial number. Serial is not always a 32 or 64bit number. Some CAs use large serial numbers, thus it may be wise to handle it as something opaque.
Returns 0 on success, or a negative value in case of an error.
crt: should contain a gnutls_x509_crt_t structure
type: is one of the gnutls_x509_subject_alt_name_t enumerations
data_string: The data to be set
This function will set the subject alternative name certificate extension.
Returns 0 on success.
cert: should contain a gnutls_x509_crt_t structure
id: The key ID
id_size: Holds the size of the serial field.
This function will set the X.509 certificate's subject key ID extension.
Returns 0 on success, or a negative value in case of an error.
crt: should contain a gnutls_x509_crt_t structure
version: holds the version number. For X.509v1 certificates must be 1.
This function will set the version of the certificate. This must be one for X.509 version 1, and so on. Plain certificates without extensions must have version set to one.
To create well-formed certificates, you must specify version 3 if you use any certificate extensions. Extensions are created by functions such as gnutls_x509_crt_set_subject_alternative_name or gnutls_x509_crt_set_key_usage.
Returns 0 on success.
crt: should contain a gnutls_x509_crt_t structure
issuer: is the certificate of the certificate issuer
issuer_key: holds the issuer's private key
dig: The message digest to use. GNUTLS_DIG_SHA1 is the safe choice unless you know what you're doing.
flags: must be 0
This function will sign the certificate with the issuer's private key, and will copy the issuer's information into the certificate.
This must be the last step in a certificate generation since all the previously set parameters are now signed.
Returns 0 on success.
crt: should contain a gnutls_x509_crt_t structure
issuer: is the certificate of the certificate issuer
issuer_key: holds the issuer's private key
This function is the same a
gnutls_x509_crt_sign2()with no flags, and SHA1 as the hash algorithm.Returns 0 on success.
cert: should contain a gnutls_x509_crt_t structure
res: The datum that will hold the result
detail: The detail level (must be GNUTLS_XML_SHOW_ALL or GNUTLS_XML_NORMAL)
This function will return the XML structures of the given X.509 certificate. The XML structures are allocated internally (with malloc) and stored into res.
Returns a negative error code in case of an error.
Deprecated: This function is currently not implemented. See the NEWS entry for GnuTLS version 1.3.5.
crt: Holds the certificate
flags: should be 0 for now
data: holds the data to be signed
signature: contains the signature
This function will verify the given signed data, using the parameters from the certificate.
In case of a verification failure 0 is returned, and 1 on success.
cert: is the certificate to be verified
CA_list: is one certificate that is considered to be trusted one
CA_list_length: holds the number of CA certificate in CA_list
flags: Flags that may be used to change the verification algorithm. Use OR of the gnutls_certificate_verify_flags enumerations.
verify: will hold the certificate verification output.
This function will try to verify the given certificate and return its status. The verification output in this functions cannot be GNUTLS_CERT_NOT_VALID.
Returns 0 on success and a negative value in case of an error.
dn: input variable with opaque DN pointer
irdn: index of RDN
iava: index of AVA.
ava: Pointer to structure which will hold output information.
Get pointers to data within the DN.
Note that
avawill contain pointers into thednstructure, so you should not modify any data or deallocate it. Note also that the DN in turn points into the original certificate structure, and thus you may not deallocate the certificate and continue to accessdn.Returns: Returns 0 on success, or an error code.
oid: holds an Object Identifier in a null terminated string
This function will inform about known DN OIDs. This is useful since functions like
gnutls_x509_crt_set_dn_by_oid()use the information on known OIDs to properly encode their input. Object Identifiers that are not known are not encoded by these functions, and their input is stored directly into the ASN.1 structure. In that case of unknown OIDs, you have the responsibility of DER encoding your data.Returns 1 on known OIDs and 0 otherwise.
dst: The destination key, which should be initialized.
src: The source key
This function will copy a private key from source to destination key.
key: The structure to be initialized
This function will deinitialize a private key structure.
p: will hold the p
q: will hold the q
g: will hold the g
y: will hold the y
x: will hold the x
This function will export the DSA private key's parameters found in the given structure. The new parameters will be allocated using
gnutls_malloc()and will be stored in the appropriate datum.
key: Holds the key
format: the format of output params. One of PEM or DER.
password: the password that will be used to encrypt the key.
flags: an ORed sequence of gnutls_pkcs_encrypt_flags_t
output_data: will contain a private key PEM or DER encoded
output_data_size: holds the size of output_data (and will be replaced by the actual size of parameters)
This function will export the private key to a PKCS8 structure. Currently only RSA keys can be exported since there is no documented standard for other keys. If the flags do not specify the encryption cipher, then the default 3DES (PBES2) will be used.
The
passwordcan be either ASCII or UTF-8 in the default PBES2 encryption schemas, or ASCII for the PKCS12 schemas.If the buffer provided is not long enough to hold the output, then *output_data_size is updated and GNUTLS_E_SHORT_MEMORY_BUFFER will be returned.
If the structure is PEM encoded, it will have a header of "BEGIN ENCRYPTED PRIVATE KEY" or "BEGIN PRIVATE KEY" if encryption is not used.
Return value: In case of failure a negative value will be returned, and 0 on success.
key: a structure that holds the rsa parameters
m: will hold the modulus
e: will hold the public exponent
d: will hold the private exponent
p: will hold the first prime (p)
q: will hold the second prime (q)
u: will hold the coefficient
This function will export the RSA private key's parameters found in the given structure. The new parameters will be allocated using
gnutls_malloc()and will be stored in the appropriate datum.
key: Holds the key
format: the format of output params. One of PEM or DER.
output_data: will contain a private key PEM or DER encoded
output_data_size: holds the size of output_data (and will be replaced by the actual size of parameters)
This function will export the private key to a PKCS1 structure for RSA keys, or an integer sequence for DSA keys. The DSA keys are in the same format with the parameters used by openssl.
If the buffer provided is not long enough to hold the output, then *output_data_size is updated and GNUTLS_E_SHORT_MEMORY_BUFFER will be returned.
If the structure is PEM encoded, it will have a header of "BEGIN RSA PRIVATE KEY".
Return value: In case of failure a negative value will be returned, and 0 on success.
key: Holds the key
This function will recalculate the secondary parameters in a key. In RSA keys, this can be the coefficient and exponent1,2.
Return value: In case of failure a negative value will be returned, and 0 on success.
key: should contain a gnutls_x509_privkey_t structure
algo: is one of RSA or DSA.
bits: the size of the modulus
flags: unused for now. Must be 0.
This function will generate a random private key. Note that this function must be called on an empty private key.
Returns 0 on success or a negative value on error.
key: Holds the key
flags: should be 0 for now
output_data: will contain the key ID
output_data_size: holds the size of output_data (and will be replaced by the actual size of parameters)
This function will return a unique ID the depends on the public key parameters. This ID can be used in checking whether a certificate corresponds to the given key.
If the buffer provided is not long enough to hold the output, then *output_data_size is updated and GNUTLS_E_SHORT_MEMORY_BUFFER will be returned. The output will normally be a SHA-1 hash output, which is 20 bytes.
Return value: In case of failure a negative value will be returned, and 0 on success.
key: should contain a gnutls_x509_privkey_t structure
This function will return the public key algorithm of a private key.
Returns a member of the gnutls_pk_algorithm_t enumeration on success, or a negative value on error.
key: The structure to store the parsed key
p: holds the p
q: holds the q
g: holds the g
y: holds the y
x: holds the x
This function will convert the given DSA raw parameters to the native gnutls_x509_privkey_t format. The output will be stored in
key.
key: The structure to store the parsed key
data: The DER or PEM encoded key.
format: One of DER or PEM
password: the password to decrypt the key (if it is encrypted).
flags: 0 if encrypted or GNUTLS_PKCS_PLAIN if not encrypted.
This function will convert the given DER or PEM encoded PKCS8 2.0 encrypted key to the native gnutls_x509_privkey_t format. The output will be stored in
key. Currently only RSA keys can be imported, and flags can only be used to indicate an unencrypted key.The
passwordcan be either ASCII or UTF-8 in the default PBES2 encryption schemas, or ASCII for the PKCS12 schemas.If the Certificate is PEM encoded it should have a header of "ENCRYPTED PRIVATE KEY", or "PRIVATE KEY". You only need to specify the flags if the key is DER encoded, since in that case the encryption status cannot be auto-detected.
Returns 0 on success.
key: The structure to store the parsed key
m: holds the modulus
e: holds the public exponent
d: holds the private exponent
p: holds the first prime (p)
q: holds the second prime (q)
u: holds the coefficient
This function will convert the given RSA raw parameters to the native gnutls_x509_privkey_t format. The output will be stored in
key.
key: The structure to store the parsed key
data: The DER or PEM encoded certificate.
format: One of DER or PEM
This function will convert the given DER or PEM encoded key to the native gnutls_x509_privkey_t format. The output will be stored in
key.If the key is PEM encoded it should have a header of "RSA PRIVATE KEY", or "DSA PRIVATE KEY".
Returns 0 on success.
key: The structure to be initialized
This function will initialize an private key structure.
Returns 0 on success.
key: Holds the key
digest: should be MD5 or SHA1
flags: should be 0 for now
data: holds the data to be signed
signature: will contain the signature
signature_size: holds the size of signature (and will be replaced by the new size)
This function will sign the given data using a signature algorithm supported by the private key. Signature algorithms are always used together with a hash functions. Different hash functions may be used for the RSA algorithm, but only SHA-1 for the DSA keys.
If the buffer provided is not long enough to hold the output, then *signature_size is updated and GNUTLS_E_SHORT_MEMORY_BUFFER will be returned.
In case of failure a negative value will be returned, and 0 on success.
key: Holds the key
flags: should be 0 for now
data: holds the data to be signed
signature: contains the signature
This function will verify the given signed data, using the parameters in the private key.
In case of a verification failure 0 is returned, and 1 on success.
idn: should contain a DER encoded RDN sequence
oid: an Object Identifier
indx: In case multiple same OIDs exist in the RDN indicates which to send. Use 0 for the first one.
raw_flag: If non zero then the raw DER data are returned.
buf: a pointer to a structure to hold the peer's name
sizeof_buf: holds the size of
bufThis function will return the name of the given Object identifier, of the RDN sequence. The name will be encoded using the rules from RFC2253.
Returns GNUTLS_E_SHORT_MEMORY_BUFFER and updates *sizeof_buf if the provided buffer is not long enough, and 0 on success.
idn: should contain a DER encoded RDN sequence
indx: Indicates which OID to return. Use 0 for the first one.
This function will return the specified Object identifier, of the RDN sequence.
Returns GNUTLS_E_SHORT_MEMORY_BUFFER and updates *sizeof_buf if the provided buffer is not long enough, and 0 on success.
idn: should contain a DER encoded RDN sequence
buf: a pointer to a structure to hold the peer's name
sizeof_buf: holds the size of
bufThis function will return the name of the given RDN sequence. The name will be in the form "C=xxxx,O=yyyy,CN=zzzz" as described in RFC2253.
If the provided buffer is not long enough, returns GNUTLS_E_SHORT_MEMORY_BUFFER and *sizeof_buf will be updated. On success 0 is returned.
These functions are only available in the GPL version of the library
called gnutls-extra. The prototypes for this library lie in
gnutls/extra.h.
req_version: the version to check
Check that the version of the gnutls-extra library is at minimum the requested one and return the version string; return NULL if the condition is not satisfied. If a NULL is passed to this function, no check is done, but the version string is simply returned.
This function initializes the global state of gnutls-extra library to defaults. Returns zero on success.
Note that
gnutls_global_init()has to be called before this function. If this function is not called then the gnutls-extra library will not be usable.
The following functions are to be used for OpenPGP certificate handling. Their prototypes lie in gnutls/openpgp.h. You need to link with libgnutls-extra to be able to use these functions (see GnuTLS-extra functions).
res: the destination context to save the data.
certfile: the file that contains the public key.
keyfile: the file that contains the secret key.
This funtion is used to load OpenPGP keys into the GnuTLS credentials structure. It doesn't matter whether the keys are armored or not, but the files should only contain one key which should not be encrypted.
res: the destination context to save the data.
cert: the datum that contains the public key.
key: the datum that contains the secret key.
This funtion is used to load OpenPGP keys into the GnuTLS credential structure. It doesn't matter whether the keys are armored or not, but the files should only contain one key which should not be encrypted.
c: A certificate credentials structure
file: filename of the keyring.
The function is used to set keyrings that will be used internally by various OpenPGP functions. For example to find a key when it is needed for an operations. The keyring will also be used at the verification functions.
c: A certificate credentials structure
data: buffer with keyring data.
dlen: length of data buffer.
The function is used to set keyrings that will be used internally by various OpenPGP functions. For example to find a key when it is needed for an operations. The keyring will also be used at the verification functions.
res: the destination context to save the data.
keyserver: is the key server address
port: is the key server port to connect to
This funtion will set a key server for use with openpgp keys. This key server will only be used if the peer sends a key fingerprint instead of a key in the handshake. Using a key server may delay the handshake process.
res: is an
gnutls_certificate_credentials_tstructure.key: contains an openpgp public key
pkey: is an openpgp private key
This function sets a certificate/private key pair in the gnutls_certificate_credentials_t structure. This function may be called more than once (in case multiple keys/certificates exist for the server).
res: the destination context to save the data.
trustdb: is the trustdb filename
This funtion will set a GnuPG trustdb which will be used in key verification functions. Only version 3 trustdb files are supported.
key: should contain an gnutls_openpgp_key_t structure
hostname: A null terminated string that contains a DNS name
This function will check if the given key's owner matches the given hostname. This is a basic implementation of the matching described in RFC2818 (HTTPS), which takes into account wildcards.
Returns non zero on success, and zero on failure.
key: The structure to be initialized
This function will deinitialize a key structure.
key: Holds the key.
format: One of gnutls_openpgp_key_fmt_t elements.
output_data: will contain the key base64 encoded or raw
output_data_size: holds the size of output_data (and will be replaced by the actual size of parameters)
This function will convert the given key to RAW or Base64 format. If the buffer provided is not long enough to hold the output, then GNUTLS_E_SHORT_MEMORY_BUFFER will be returned.
Returns 0 on success.
key: the structure that contains the OpenPGP public key.
Returns the timestamp when the OpenPGP key was created.
key: the structure that contains the OpenPGP public key.
Returns the time when the OpenPGP key expires. A value of '0' means that the key doesn't expire at all.
key: the raw data that contains the OpenPGP public key.
fpr: the buffer to save the fingerprint, must hold at least 20 bytes.
fprlen: the integer to save the length of the fingerprint.
Returns the fingerprint of the OpenPGP key. Depends on the algorithm, the fingerprint can be 16 or 20 bytes.
key: the structure that contains the OpenPGP public key.
Returns the 64-bit keyID of the OpenPGP key.
key: should contain a gnutls_openpgp_key_t structure
key_usage: where the key usage bits will be stored
This function will return certificate's key usage, by checking the key algorithm. The key usage value will ORed values of the: GNUTLS_KEY_DIGITAL_SIGNATURE, GNUTLS_KEY_KEY_ENCIPHERMENT.
A negative value may be returned in case of parsing error.
key: the structure that contains the OpenPGP public key.
idx: the index of the ID to extract
buf: a pointer to a structure to hold the name
sizeof_buf: holds the maximum size of
buf, on return hold the actual/required size ofbuf.Extracts the userID from the parsed OpenPGP key.
Returns 0 on success, and GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE if the index of the ID does not exist.
key: is an OpenPGP key
bits: if bits is non null it will hold the size of the parameters' in bits
This function will return the public key algorithm of an OpenPGP certificate.
If bits is non null, it should have enough size to hold the parameters size in bits. For RSA the bits returned is the modulus. For DSA the bits returned are of the public exponent.
Returns a member of the GNUTLS_PKAlgorithm enumeration on success, or a negative value on error.
key: the structure that contains the OpenPGP public key.
Extract the version of the OpenPGP key.
key: The structure to store the parsed key.
data: The RAW or BASE64 encoded key.
format: One of gnutls_openpgp_key_fmt_t elements.
This function will convert the given RAW or Base64 encoded key to the native gnutls_openpgp_key_t format. The output will be stored in 'key'.
Returns 0 on success.
key: The structure to be initialized
This function will initialize an OpenPGP key structure.
Returns 0 on success.
xmlkey: he datum struct to store the XML result.
ext: extension mode (1/0), 1 means include key signatures and key data.
This function will return the all OpenPGP key information encapsulated as a XML string.
key: the structure that holds the key.
keyring: holds the keyring to check against
flags: unused (should be 0)
verify: will hold the certificate verification output.
Verify all signatures in the key, using the given set of keys (keyring).
The key verification output will be put in
verifyand will be one or more of the gnutls_certificate_status_t enumerated elements bitwise or'd.GNUTLS_CERT_INVALID: A signature on the key is invalid.
GNUTLS_CERT_REVOKED: The key has been revoked.
Note that this function does not verify using any "web of trust". You may use GnuPG for that purpose, or any other external PGP application.
Returns 0 on success.
key: the structure that holds the key.
flags: unused (should be 0)
verify: will hold the key verification output.
Verifies the self signature in the key. The key verification output will be put in
verifyand will be one or more of the gnutls_certificate_status_t enumerated elements bitwise or'd.GNUTLS_CERT_INVALID: The self signature on the key is invalid.
Returns 0 on success.
key: the structure that holds the key.
trustdb: holds the trustdb to check against
flags: unused (should be 0)
verify: will hold the certificate verification output.
Checks if the key is revoked or disabled, in the trustdb. The verification output will be put in
verifyand will be one or more of the gnutls_certificate_status_t enumerated elements bitwise or'd.GNUTLS_CERT_INVALID: A signature on the key is invalid.
GNUTLS_CERT_REVOKED: The key has been revoked.
Note that this function does not verify using any "web of trust". You may use GnuPG for that purpose, or any other external PGP application.
Returns 0 on success.
ring: holds the keyring to check against
flags: unused (should be 0)
Check if a given key ID exists in the keyring.
Returns 0 on success (if keyid exists) and a negative error code on failure.
keyring: The structure to be initialized
This function will deinitialize a CRL structure.
keyring: The structure to store the parsed key.
data: The RAW or BASE64 encoded keyring.
format: One of gnutls_openpgp_keyring_fmt elements.
This function will convert the given RAW or Base64 encoded keyring to the native gnutls_openpgp_keyring_t format. The output will be stored in 'keyring'.
Returns 0 on success.
keyring: The structure to be initialized
This function will initialize an OpenPGP keyring structure.
Returns 0 on success.
key: The structure to be initialized
This function will deinitialize a key structure.
key: is an OpenPGP key
bits: if bits is non null it will hold the size of the parameters' in bits
This function will return the public key algorithm of an OpenPGP certificate.
If bits is non null, it should have enough size to hold the parameters size in bits. For RSA the bits returned is the modulus. For DSA the bits returned are of the public exponent.
Returns a member of the GNUTLS_PKAlgorithm enumeration on success, or a negative value on error.
key: The structure to store the parsed key.
data: The RAW or BASE64 encoded key.
format: One of gnutls_openpgp_key_fmt_t elements.
pass: Unused for now
flags: should be zero
This function will convert the given RAW or Base64 encoded key to the native gnutls_openpgp_privkey_t format. The output will be stored in 'key'.
Returns 0 on success.
key: The structure to be initialized
This function will initialize an OpenPGP key structure.
Returns 0 on success.
session: a TLS session
func: the callback
This funtion will set a key retrieval function for OpenPGP keys. This callback is only useful in server side, and will be used if the peer sent a key fingerprint instead of a full key.
trustdb: The structure to be initialized
This function will deinitialize a CRL structure.
trustdb: The structure to store the parsed key.
file: The file that holds the trustdb.
This function will convert the given RAW or Base64 encoded trustdb to the native gnutls_openpgp_trustdb_t format. The output will be stored in 'trustdb'.
Returns 0 on success.
trustdb: The structure to be initialized
This function will initialize an OpenPGP trustdb structure.
Returns 0 on success.
The following functions are used for TLS Inner Application (TLS/IA). Their prototypes lie in gnutls/extra.h. You need to link with libgnutls-extra to be able to use these functions (see GnuTLS-extra functions).
The typical control flow in an TLS/IA client (that would not require an Application Phase for resumed sessions) would be similar to the following:
int client_avp (gnuls_session_t *session, void *ptr,
const char *last, size_t lastlen,
char **new, size_t *newlen)
{
...
}
...
int main ()
{
gnutls_ia_client_credentials_t iacred;
...
gnutls_init (&session, GNUTLS_CLIENT);
...
/* Enable TLS/IA. */
gnutls_ia_allocate_client_credentials(&iacred);
gnutls_ia_set_client_avp_function(iacred, client_avp);
gnutls_credentials_set (session, GNUTLS_CRD_IA, iacred);
...
ret = gnutls_handshake (session);
// Error handling...
...
if (gnutls_ia_handshake_p (session))
{
ret = gnutls_ia_handshake (session);
// Error handling...
...
See below for detailed descriptions of all the functions used above.
The function client_avp would have to be implemented by your
application. The function is responsible for handling the AVP data.
See gnutls_ia_set_client_avp_function below for more
information on how that function should be implemented.
The control flow in a typical server is similar to the above, use
gnutls_ia_server_credentials_t instead of
gnutls_ia_client_credentials_t, and replace the call to the
client functions with the corresponding server functions.
sc: is a pointer to an
gnutls_ia_server_credentials_tstructure.This structure is complex enough to manipulate directly thus this helper function is provided in order to allocate it.
Adding this credential to a session will enable TLS/IA, and will require an Application Phase after the TLS handshake (if the server support TLS/IA). Use
gnutls_ia_require_inner_phase()to toggle the TLS/IA mode.Returns 0 on success.
sc: is a pointer to an
gnutls_ia_server_credentials_tstructure.This structure is complex enough to manipulate directly thus this helper function is provided in order to allocate it.
Adding this credential to a session will enable TLS/IA, and will require an Application Phase after the TLS handshake (if the client support TLS/IA). Use
gnutls_ia_require_inner_phase()to toggle the TLS/IA mode.Returns 0 on success.
session: is a
gnutls_session_tstructure.allow_skip_on_resume: non-zero if local party allows to skip the TLS/IA application phases for a resumed session.
Specify whether we must advertise support for the TLS/IA extension during the handshake.
At the client side, we always advertise TLS/IA if gnutls_ia_enable was called before the handshake; at the server side, we also require that the client has advertised that it wants to run TLS/IA before including the advertisement, as required by the protocol.
Similarly, at the client side we always advertise that we allow TLS/IA to be skipped for resumed sessions if
allow_skip_on_resumeis non-zero; at the server side, we also require that the session is indeed resumable and that the client has also advertised that it allows TLS/IA to be skipped for resumed sessions.After the TLS handshake, call
gnutls_ia_handshake_p()to find out whether both parties agreed to do a TLS/IA handshake, before callinggnutls_ia_handshake()or one of the lower level gnutls_ia_* functions.
session: is a
gnutls_session_tstructure.final_p: Set iff this should signal the final phase.
Send a TLS/IA end phase message.
In the client, this should only be used to acknowledge an end phase message sent by the server.
In the server, this can be called instead of
gnutls_ia_send()if the server wishes to end an application phase.Return value: Return 0 on success, or an error code.
session: is a
gnutls_session_tstructure.buffer: pre-allocated buffer to hold 48 bytes of inner secret.
Copy the 48 bytes large inner secret into the specified buffer
This function is typically used after the TLS/IA handshake has concluded. The TLS/IA inner secret can be used as input to a PRF to derive session keys. Do not use the inner secret directly as a session key, because for a resumed session that does not include an application phase, the inner secret will be identical to the inner secret in the original session. It is important to include, for example, the client and server randomness when deriving a sesssion key from the inner secret.
sc: is an
gnutls_ia_client_credentials_tstructure.This structure is complex enough to manipulate directly thus this helper function is provided in order to free (deallocate) it.
sc: is an
gnutls_ia_server_credentials_tstructure.This structure is complex enough to manipulate directly thus this helper function is provided in order to free (deallocate) it.
session: is a
gnutls_session_tstructure.buffer_size: size of output buffer.
buffer: pre-allocated buffer to contain
buffer_sizebytes of output.Generate an application challenge that the client cannot control or predict, based on the TLS/IA inner secret.
Return value: Returns 0 on success, or an negative error code.
cred: is a
gnutls_ia_client_credentials_tstructure.Returns the pointer that will be provided to the TLS/IA callback function as the first argument.
cred: is a
gnutls_ia_client_credentials_tstructure.Returns the pointer that will be provided to the TLS/IA callback function as the first argument.
session: is a
gnutls_session_tstructure.Predicate to be used after
gnutls_handshake()to decide whether to invokegnutls_ia_handshake(). Usable by both clients and servers.Return value: non-zero if TLS/IA handshake is expected, zero otherwise.
session: is a
gnutls_session_tstructure.Perform a TLS/IA handshake. This should be called after
gnutls_handshake()iffgnutls_ia_handshake_p().Return 0 on success, or an error code.
session: is a
gnutls_session_tstructure.session_keys_size: Size of generated session keys (0 if none).
session_keys: Generated session keys, used to permute inner secret (NULL if none).
Permute the inner secret using the generated session keys.
This can be called in the TLS/IA AVP callback to mix any generated session keys with the TLS/IA inner secret.
Return value: Return zero on success, or a negative error code.
session: is a
gnutls_session_tstructure.data: the buffer that the data will be read into, must hold >= 12 bytes.
sizeofdata: the number of requested bytes, must be >= 12.
Receive TLS/IA data. This function has the similar semantics with
recv(). The only difference is that is accepts a GNUTLS session, and uses different error codes.If the server attempt to finish an application phase, this function will return
GNUTLS_E_WARNING_IA_IPHF_RECEIVEDorGNUTLS_E_WARNING_IA_FPHF_RECEIVED. The caller should then invokegnutls_ia_verify_endphase(), and if it runs the client side, also send an endphase message of its own using gnutls_ia_endphase_send.If EINTR is returned by the internal push function (the default is
code{recv()}) then GNUTLS_E_INTERRUPTED will be returned. If GNUTLS_E_INTERRUPTED or GNUTLS_E_AGAIN is returned, you must call this function again, with the same parameters; alternatively you could provide a NULL pointer for data, and 0 for size.Returns the number of bytes received. A negative error code is returned in case of an error. The
GNUTLS_E_WARNING_IA_IPHF_RECEIVEDandGNUTLS_E_WARNING_IA_FPHF_RECEIVEDerrors are returned when an application phase finished message has been sent by the server.
session: is a
gnutls_session_tstructure.data: contains the data to send
sizeofdata: is the length of the data
Send TLS/IA application payload data. This function has the similar semantics with
send(). The only difference is that is accepts a GNUTLS session, and uses different error codes.The TLS/IA protocol is synchronous, so you cannot send more than one packet at a time. The client always send the first packet.
To finish an application phase in the server, use
gnutls_ia_endphase_send(). The client cannot end an application phase unilaterally; rather, a client is required to respond with an endphase of its own if gnutls_ia_recv indicates that the server has sent one.If the EINTR is returned by the internal push function (the default is
send()} thenGNUTLS_E_INTERRUPTEDwill be returned. IfGNUTLS_E_INTERRUPTEDorGNUTLS_E_AGAINis returned, you must call this function again, with the same parameters; alternatively you could provide aNULLpointer for data, and 0 for size.Returns the number of bytes sent, or a negative error code.
cred: is a
gnutls_ia_client_credentials_tstructure.avp_func: is the callback function
Set the TLS/IA AVP callback handler used for the session.
The AVP callback is called to process AVPs received from the server, and to get a new AVP to send to the server.
The callback's function form is: int (*avp_func) (gnutls_session_t session, void *ptr, const char *last, size_t lastlen, char **next, size_t *nextlen);
The
sessionparameter is thegnutls_session_tstructure corresponding to the current session. Theptrparameter is the application hook pointer, set throughgnutls_ia_set_client_avp_ptr(). The AVP received from the server is present inlastoflastlensize, which will beNULLon the first invocation. The newly allocated output AVP to send to the server should be placed in *nextof *nextlensize.The callback may invoke
gnutls_ia_permute_inner_secret()to mix any generated session keys with the TLS/IA inner secret.Return 0 (
GNUTLS_IA_APPLICATION_PAYLOAD) on success, or a negative error code to abort the TLS/IA handshake.Note that the callback must use allocate the
nextparameter usinggnutls_malloc(), because it is released viagnutls_free()by the TLS/IA handshake function.
cred: is a
gnutls_ia_client_credentials_tstructure.ptr: is the pointer
Sets the pointer that will be provided to the TLS/IA callback function as the first argument.
cred: is a
gnutls_ia_server_credentials_tstructure.Set the TLS/IA AVP callback handler used for the session.
The callback's function form is: int (*avp_func) (gnutls_session_t session, void *ptr, const char *last, size_t lastlen, char **next, size_t *nextlen);
The
sessionparameter is thegnutls_session_tstructure corresponding to the current session. Theptrparameter is the application hook pointer, set throughgnutls_ia_set_server_avp_ptr(). The AVP received from the client is present inlastoflastlensize. The newly allocated output AVP to send to the client should be placed in *nextof *nextlensize.The AVP callback is called to process incoming AVPs from the client, and to get a new AVP to send to the client. It can also be used to instruct the TLS/IA handshake to do go into the Intermediate or Final phases. It return a negative error code, or an
gnutls_ia_apptype_tmessage type.The callback may invoke
gnutls_ia_permute_inner_secret()to mix any generated session keys with the TLS/IA inner secret.Specifically, return
GNUTLS_IA_APPLICATION_PAYLOAD(0) to send another AVP to the client, returnGNUTLS_IA_INTERMEDIATE_PHASE_FINISHED(1) to indicate that an IntermediatePhaseFinished message should be sent, and returnGNUTLS_IA_FINAL_PHASE_FINISHED(2) to indicate that an FinalPhaseFinished message should be sent. In the last two cases, the contents of thenextandnextlenparameter is not used.Note that the callback must use allocate the
nextparameter usinggnutls_malloc(), because it is released viagnutls_free()by the TLS/IA handshake function.
cred: is a
gnutls_ia_client_credentials_tstructure.ptr: is the pointer
Sets the pointer that will be provided to the TLS/IA callback function as the first argument.
session: is a
gnutls_session_tstructure.checksum: 12-byte checksum data, received from
gnutls_ia_recv().Verify TLS/IA end phase checksum data. If verification fails, the
GNUTLS_A_INNER_APPLICATION_VERIFICATIONalert is sent to the other sie.This function is called when
gnutls_ia_recv()returnGNUTLS_E_WARNING_IA_IPHF_RECEIVEDorGNUTLS_E_WARNING_IA_FPHF_RECEIVED.Return value: Return 0 on successful verification, or an error code. If the checksum verification of the end phase message fails,
GNUTLS_E_IA_VERIFY_FAILEDis returned.
GnuTLS can use the PKCS#11 provider Scute
(http://www.scute.org/) to load trusted CA certificates from,
e.g., smartcards. You'd typically use this functionality together
with gnutls_certificate_set_x509_trust as follows:
#include <gnutls/pkcs11.h>
...
gnutls_x509_crt_t * ca_list;
unsigned int ncas;
int ret;
...
ret = gnutls_pkcs11_get_ca_certificates (&ca_list, &ncas);
if (ret < 0)
// Error handling...
ret = gnutls_certificate_set_x509_trust (xcred, ca_list, ncas);
if (ret < 0)
// Error handling...
In the future, this functionality may be extended to allow off-loading the signing operation to the PKCS#11 provider too, and to support other PKCS#11 providers too.
cert_list: pointer to output variable containing newly allocated array of certificates.
ncerts: pointer to output variable indicating size of array.
Get a list of X.509 certificates from the PKCS
11provider which are marked as CKA_TRUSTED. Each certificate must be deallocated, by the caller, usinggnutls_x509_crt_deinit(), and the array itself must be deallocated usinggnutls_free().Returns: Returns
GNUTLS_E_SUCCESSon success, or an error code.
The error codes used throughout the library are described below. The
return code GNUTLS_E_SUCCESS indicate successful operation, and
is guaranteed to have the value 0, so you can use it in logical
expressions.
GNUTLS_E_AGAIN:GNUTLS_E_ASN1_DER_ERROR:GNUTLS_E_ASN1_DER_OVERFLOW:GNUTLS_E_ASN1_ELEMENT_NOT_FOUND:GNUTLS_E_ASN1_GENERIC_ERROR:GNUTLS_E_ASN1_IDENTIFIER_NOT_FOUND:GNUTLS_E_ASN1_SYNTAX_ERROR:GNUTLS_E_ASN1_TAG_ERROR:GNUTLS_E_ASN1_TAG_IMPLICIT:GNUTLS_E_ASN1_TYPE_ANY_ERROR:GNUTLS_E_ASN1_VALUE_NOT_FOUND:GNUTLS_E_ASN1_VALUE_NOT_VALID:GNUTLS_E_BASE64_DECODING_ERROR:GNUTLS_E_BASE64_ENCODING_ERROR:GNUTLS_E_CERTIFICATE_ERROR:GNUTLS_E_CERTIFICATE_KEY_MISMATCH:GNUTLS_E_COMPRESSION_FAILED:GNUTLS_E_CONSTRAINT_ERROR:GNUTLS_E_DB_ERROR:GNUTLS_E_DECOMPRESSION_FAILED:GNUTLS_E_DECRYPTION_FAILED:GNUTLS_E_DH_PRIME_UNACCEPTABLE:GNUTLS_E_ENCRYPTION_FAILED:GNUTLS_E_ERROR_IN_FINISHED_PACKET:GNUTLS_E_EXPIRED:GNUTLS_E_FATAL_ALERT_RECEIVED:GNUTLS_E_FILE_ERROR:GNUTLS_E_GOT_APPLICATION_DATA:GNUTLS_E_HASH_FAILED:GNUTLS_E_IA_VERIFY_FAILED:GNUTLS_E_ILLEGAL_SRP_USERNAME:GNUTLS_E_INCOMPATIBLE_GCRYPT_LIBRARY:GNUTLS_E_INCOMPATIBLE_LIBTASN1_LIBRARY:GNUTLS_E_INIT_LIBEXTRA:GNUTLS_E_INSUFFICIENT_CREDENTIALS:GNUTLS_E_INTERNAL_ERROR:GNUTLS_E_INTERRUPTED:GNUTLS_E_INVALID_PASSWORD:GNUTLS_E_INVALID_REQUEST:GNUTLS_E_INVALID_SESSION:GNUTLS_E_KEY_USAGE_VIOLATION:GNUTLS_E_LARGE_PACKET:GNUTLS_E_LIBRARY_VERSION_MISMATCH:GNUTLS_E_LZO_INIT_FAILED:GNUTLS_E_MAC_VERIFY_FAILED:GNUTLS_E_MEMORY_ERROR:GNUTLS_E_MPI_PRINT_FAILED:GNUTLS_E_MPI_SCAN_FAILED:GNUTLS_E_NO_CERTIFICATE_FOUND:GNUTLS_E_NO_CIPHER_SUITES:GNUTLS_E_NO_COMPRESSION_ALGORITHMS:GNUTLS_E_NO_TEMPORARY_DH_PARAMS:GNUTLS_E_NO_TEMPORARY_RSA_PARAMS:GNUTLS_E_OPENPGP_FINGERPRINT_UNSUPPORTED:GNUTLS_E_OPENPGP_GETKEY_FAILED:GNUTLS_E_OPENPGP_KEYRING_ERROR:GNUTLS_E_OPENPGP_TRUSTDB_VERSION_UNSUPPORTED:GNUTLS_E_PKCS1_WRONG_PAD:GNUTLS_E_PK_DECRYPTION_FAILED:GNUTLS_E_PK_ENCRYPTION_FAILED:GNUTLS_E_PK_SIGN_FAILED:GNUTLS_E_PK_SIG_VERIFY_FAILED:GNUTLS_E_PULL_ERROR:GNUTLS_E_PUSH_ERROR:GNUTLS_E_RANDOM_FAILED:GNUTLS_E_RECEIVED_ILLEGAL_EXTENSION:GNUTLS_E_RECEIVED_ILLEGAL_PARAMETER:GNUTLS_E_RECORD_LIMIT_REACHED:GNUTLS_E_REHANDSHAKE:GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE:GNUTLS_E_SHORT_MEMORY_BUFFER:GNUTLS_E_SRP_PWD_ERROR:GNUTLS_E_SRP_PWD_PARSING_ERROR:GNUTLS_E_SUCCESS:GNUTLS_E_TOO_MANY_EMPTY_PACKETS:GNUTLS_E_UNEXPECTED_HANDSHAKE_PACKET:GNUTLS_E_UNEXPECTED_PACKET:GNUTLS_E_UNEXPECTED_PACKET_LENGTH:GNUTLS_E_UNKNOWN_CIPHER_SUITE:GNUTLS_E_UNKNOWN_CIPHER_TYPE:GNUTLS_E_UNKNOWN_COMPRESSION_ALGORITHM:GNUTLS_E_UNKNOWN_HASH_ALGORITHM:GNUTLS_E_UNKNOWN_PKCS_BAG_TYPE:GNUTLS_E_UNKNOWN_PKCS_CONTENT_TYPE:GNUTLS_E_UNKNOWN_PK_ALGORITHM:GNUTLS_E_UNSUPPORTED_CERTIFICATE_TYPE:GNUTLS_E_UNSUPPORTED_VERSION_PACKET:GNUTLS_E_UNWANTED_ALGORITHM:GNUTLS_E_WARNING_ALERT_RECEIVED:GNUTLS_E_WARNING_IA_FPHF_RECEIVED:GNUTLS_E_WARNING_IA_IPHF_RECEIVED:GNUTLS_E_X509_UNKNOWN_SAN:GNUTLS_E_X509_UNSUPPORTED_ATTRIBUTE:GNUTLS_E_X509_UNSUPPORTED_CRITICAL_EXTENSION:GNUTLS_E_X509_UNSUPPORTED_OID:This appendix contains some example output of the XML convertion functions:
<?xml version="1.0" encoding="UTF-8"?>
<gnutls:x509:certificate version="1.1">
<certificate type="SEQUENCE">
<tbsCertificate type="SEQUENCE">
<version type="INTEGER" encoding="HEX">02</version>
<serialNumber type="INTEGER" encoding="HEX">01</serialNumber>
<signature type="SEQUENCE">
<algorithm type="OBJECT ID">1.2.840.113549.1.1.4</algorithm>
<parameters type="ANY">
<md5WithRSAEncryption encoding="HEX">0500</md5WithRSAEncryption>
</parameters>
</signature>
<issuer type="CHOICE">
<rdnSequence type="SEQUENCE OF">
<unnamed1 type="SET OF">
<unnamed1 type="SEQUENCE">
<type type="OBJECT ID">2.5.4.6</type>
<value type="ANY">
<X520countryName>GR</X520countryName>
</value>
</unnamed1>
</unnamed1>
<unnamed2 type="SET OF">
<unnamed1 type="SEQUENCE">
<type type="OBJECT ID">2.5.4.8</type>
<value type="ANY">
<X520StateOrProvinceName>Attiki</X520StateOrProvinceName>
</value>
</unnamed1>
</unnamed2>
<unnamed3 type="SET OF">
<unnamed1 type="SEQUENCE">
<type type="OBJECT ID">2.5.4.7</type>
<value type="ANY">
<X520LocalityName>Athina</X520LocalityName>
</value>
</unnamed1>
</unnamed3>
<unnamed4 type="SET OF">
<unnamed1 type="SEQUENCE">
<type type="OBJECT ID">2.5.4.10</type>
<value type="ANY">
<X520OrganizationName>GNUTLS</X520OrganizationName>
</value>
</unnamed1>
</unnamed4>
<unnamed5 type="SET OF">
<unnamed1 type="SEQUENCE">
<type type="OBJECT ID">2.5.4.11</type>
<value type="ANY">
<X520OrganizationalUnitName>GNUTLS dev.</X520OrganizationalUnitName>
</value>
</unnamed1>
</unnamed5>
<unnamed6 type="SET OF">
<unnamed1 type="SEQUENCE">
<type type="OBJECT ID">2.5.4.3</type>
<value type="ANY">
<X520CommonName>GNUTLS TEST CA</X520CommonName>
</value>
</unnamed1>
</unnamed6>
<unnamed7 type="SET OF">
<unnamed1 type="SEQUENCE">
<type type="OBJECT ID">1.2.840.113549.1.9.1</type>
<value type="ANY">
<Pkcs9email>gnutls-dev@gnupg.org</Pkcs9email>
</value>
</unnamed1>
</unnamed7>
</rdnSequence>
</issuer>
<validity type="SEQUENCE">
<notBefore type="CHOICE">
<utcTime type="TIME">010707101845Z</utcTime>
</notBefore>
<notAfter type="CHOICE">
<utcTime type="TIME">020707101845Z</utcTime>
</notAfter>
</validity>
<subject type="CHOICE">
<rdnSequence type="SEQUENCE OF">
<unnamed1 type="SET OF">
<unnamed1 type="SEQUENCE">
<type type="OBJECT ID">2.5.4.6</type>
<value type="ANY">
<X520countryName>GR</X520countryName>
</value>
</unnamed1>
</unnamed1>
<unnamed2 type="SET OF">
<unnamed1 type="SEQUENCE">
<type type="OBJECT ID">2.5.4.8</type>
<value type="ANY">
<X520StateOrProvinceName>Attiki</X520StateOrProvinceName>
</value>
</unnamed1>
</unnamed2>
<unnamed3 type="SET OF">
<unnamed1 type="SEQUENCE">
<type type="OBJECT ID">2.5.4.7</type>
<value type="ANY">
<X520LocalityName>Athina</X520LocalityName>
</value>
</unnamed1>
</unnamed3>
<unnamed4 type="SET OF">
<unnamed1 type="SEQUENCE">
<type type="OBJECT ID">2.5.4.10</type>
<value type="ANY">
<X520OrganizationName>GNUTLS</X520OrganizationName>
</value>
</unnamed1>
</unnamed4>
<unnamed5 type="SET OF">
<unnamed1 type="SEQUENCE">
<type type="OBJECT ID">2.5.4.11</type>
<value type="ANY">
<X520OrganizationalUnitName>GNUTLS dev.</X520OrganizationalUnitName>
</value>
</unnamed1>
</unnamed5>
<unnamed6 type="SET OF">
<unnamed1 type="SEQUENCE">
<type type="OBJECT ID">2.5.4.3</type>
<value type="ANY">
<X520CommonName>localhost</X520CommonName>
</value>
</unnamed1>
</unnamed6>
<unnamed7 type="SET OF">
<unnamed1 type="SEQUENCE">
<type type="OBJECT ID">1.2.840.113549.1.9.1</type>
<value type="ANY">
<Pkcs9email>root@localhost</Pkcs9email>
</value>
</unnamed1>
</unnamed7>
</rdnSequence>
</subject>
<subjectPublicKeyInfo type="SEQUENCE">
<algorithm type="SEQUENCE">
<algorithm type="OBJECT ID">1.2.840.113549.1.1.1</algorithm>
<parameters type="ANY">
<rsaEncryption encoding="HEX">0500</rsaEncryption>
</parameters>
</algorithm>
<subjectPublicKey type="BIT STRING" encoding="HEX" length="1120">
30818902818100D00B49EBB226D951F5CC57072199DDF287683D2DA1A0E
FCC96BFF73164777C78C3991E92EDA66584E7B97BAB4BE68D595D225557
E01E7E57B5C35C04B491948C5C427AD588D8C6989764996D6D44E17B65C
CFC86F3B4842DE559B730C1DE3AEF1CE1A328AFF8A357EBA911E1F7E8FC
1598E21E4BF721748C587F50CF46157D950203010001</subjectPublicKey>
</subjectPublicKeyInfo>
<extensions type="SEQUENCE OF">
<unnamed1 type="SEQUENCE">
<extnID type="OBJECT ID">2.5.29.35</extnID>
<critical type="BOOLEAN">FALSE</critical>
<extnValue type="SEQUENCE">
<keyIdentifier type="OCTET STRING" encoding="HEX">
EFEE94ABC8CA577F5313DB76DC1A950093BAF3C9</keyIdentifier>
</extnValue>
</unnamed1>
<unnamed2 type="SEQUENCE">
<extnID type="OBJECT ID">2.5.29.37</extnID>
<critical type="BOOLEAN">FALSE</critical>
<extnValue type="SEQUENCE OF">
<unnamed1 type="OBJECT ID">1.3.6.1.5.5.7.3.1</unnamed1>
<unnamed2 type="OBJECT ID">1.3.6.1.5.5.7.3.2</unnamed2>
<unnamed3 type="OBJECT ID">1.3.6.1.4.1.311.10.3.3</unnamed3>
<unnamed4 type="OBJECT ID">2.16.840.1.113730.4.1</unnamed4>
</extnValue>
</unnamed2>
<unnamed3 type="SEQUENCE">
<extnID type="OBJECT ID">2.5.29.19</extnID>
<critical type="BOOLEAN">TRUE</critical>
<extnValue type="SEQUENCE">
<cA type="BOOLEAN">FALSE</cA>
</extnValue>
</unnamed3>
</extensions>
</tbsCertificate>
<signatureAlgorithm type="SEQUENCE">
<algorithm type="OBJECT ID">1.2.840.113549.1.1.4</algorithm>
<parameters type="ANY">
<md5WithRSAEncryption encoding="HEX">0500</md5WithRSAEncryption>
</parameters>
</signatureAlgorithm>
<signature type="BIT STRING" encoding="HEX" length="1024">
B73945273AF2A395EC54BF5DC669D953885A9D811A3B92909D24792D36A44EC
27E1C463AF8738BEFD29B311CCE8C6D9661BEC30911DAABB39B8813382B32D2
E259581EBCD26C495C083984763966FF35D1DEFE432891E610C85072578DA74
23244A8F5997B41A1F44E61F4F22C94375775055A5E72F25D5E4557467A91BD
4251</signature>
</certificate>
</gnutls:x509:certificate>
<?xml version="1.0"?>
<gnutls:openpgp:key version="1.0">
<OPENPGPKEY>
<MAINKEY>
<KEYID>BD572CDCCCC07C3</KEYID>
<FINGERPRINT>BE615E88D6CFF27225B8A2E7BD572CDCCCC07C35</FINGERPRINT>
<PKALGO>DSA</PKALGO>
<KEYLEN>1024</KEYLEN>
<CREATED>1011533164</CREATED>
<REVOKED>0</REVOKED>
<KEY ENCODING="HEX"/>
<DSA-P>0400E72E76B62EEFA9A3BD594093292418050C02D7029D6CA2066E
FC34C86038627C643EB1A652A7AF1D37CF46FC505AC1E0C699B37895B4BCB
3E53541FFDA4766D6168C2B8AAFD6AB22466D06D18034D5DAC698E6993BA5
B350FF822E1CD8702A75114E8B73A6B09CB3B93CE44DBB516C9BB5F95BB66
6188602A0A1447236C0658F</DSA-P>
<DSA-Q>00A08F5B5E78D85F792CC2072F9474645726FB4D9373</DSA-Q>
<DSA-G>03FE3578D689D6606E9118E9F9A7042B963CF23F3D8F1377A273C0
F0974DBF44B3CABCBE14DD64412555863E39A9C627662D77AC36662AE4497
92C3262D3F12E9832A7565309D67BA0AE4DF25F5EDA0937056AD5BE89F406
9EBD7EC76CE432441DF5D52FFFD06D39E5F61E36947B698A77CB62AB81E4A
4122BF9050671D9946C865E</DSA-G>
<DSA-Y>0400D061437A964DDE318818C2B24DE008E60096B60DB8A684B85A
838D119FC930311889AD57A3B927F448F84EB253C623EDA73B42FF78BCE63
A6A531D75A64CE8540513808E9F5B10CE075D3417B801164918B131D3544C
8765A8ECB9971F61A09FC73D509806106B5977D211CB0E1D04D0ED96BCE89
BAE8F73D800B052139CBF8D</DSA-Y>
</MAINKEY>
<USERID>
<NAME>OpenCDK test key (Only intended for test purposes!)</NAME>
<EMAIL>opencdk@foo-bar.org</EMAIL>
<PRIMARY>0</PRIMARY>
<REVOKED>0</REVOKED>
</USERID>
<SIGNATURE>
<VERSION>4</VERSION>
<SIGCLASS>19</SIGCLASS>
<EXPIRED>0</EXPIRED>
<PKALGO>DSA</PKALGO>
<MDALGO>SHA1</MDALGO>
<CREATED>1011533164</CREATED>
<KEYID>BD572CDCCCC07C3</KEYID>
</SIGNATURE>
<SUBKEY>
<KEYID>FCB0CF3A5261E06</KEYID>
<FINGERPRINT>297B48ACC09C0FF683CA1ED1FCB0CF3A5261E067</FINGERPRINT>
<PKALGO>ELG</PKALGO>
<KEYLEN>1024</KEYLEN>
<CREATED>1011533167</CREATED>
<REVOKED>0</REVOKED>
<KEY ENCODING="HEX"/>
<ELG-P>0400E20156526069D067D24F4D71E6D38658E08BE3BF246C1ADCE0
8DB69CD8D459C1ED335738410798755AFDB79F1797CF022E70C7960F12CA6
896D27CFD24A11CD316DDE1FBCC1EA615C5C31FEC656E467078C875FC509B
1ECB99C8B56C2D875C50E2018B5B0FA378606EB6425A2533830F55FD21D64
9015615D49A1D09E9510F5F</ELG-P>
<ELG-G>000305</ELG-G>
<ELG-Y>0400D0BDADE40432758675C87D0730C360981467BAE1BEB6CC105A
3C1F366BFDBEA12E378456513238B8AD414E52A2A9661D1DF1DB6BB5F33F6
906166107556C813224330B30932DB7C8CC8225672D7AE24AF2469750E539
B661EA6475D2E03CD8D3838DC4A8AC4AFD213536FE3E96EC9D0AEA65164B5
76E01B37A8DCA89F2B257D0</ELG-Y>
</SUBKEY>
<SIGNATURE>
<VERSION>4</VERSION>
<SIGCLASS>24</SIGCLASS>
<EXPIRED>0</EXPIRED>
<PKALGO>DSA</PKALGO>
<MDALGO>SHA1</MDALGO>
<CREATED>1011533167</CREATED>
<KEYID>BD572CDCCCC07C3</KEYID>
</SIGNATURE>
</OPENPGPKEY>
</gnutls:openpgp:key>
TLS_RSA_NULL_MD5
| 0x00 0x01 | RFC 2246
|
TLS_ANON_DH_3DES_EDE_CBC_SHA
| 0x00 0x1B | RFC 2246
|
TLS_ANON_DH_ARCFOUR_MD5
| 0x00 0x18 | RFC 2246
|
TLS_ANON_DH_AES_128_CBC_SHA
| 0x00 0x34 | RFC 2246
|
TLS_ANON_DH_AES_256_CBC_SHA
| 0x00 0x3A | RFC 2246
|
TLS_RSA_ARCFOUR_SHA
| 0x00 0x05 | RFC 2246
|
TLS_RSA_ARCFOUR_MD5
| 0x00 0x04 | RFC 2246
|
TLS_RSA_3DES_EDE_CBC_SHA
| 0x00 0x0A | RFC 2246
|
TLS_RSA_EXPORT_ARCFOUR_40_MD5
| 0x00 0x03 | RFC 2246
|
TLS_DHE_DSS_3DES_EDE_CBC_SHA
| 0x00 0x13 | RFC 2246
|
TLS_DHE_RSA_3DES_EDE_CBC_SHA
| 0x00 0x16 | RFC 2246
|
TLS_RSA_AES_128_CBC_SHA
| 0x00 0x2F | RFC 3268
|
TLS_RSA_AES_256_CBC_SHA
| 0x00 0x35 | RFC 3268
|
TLS_DHE_DSS_AES_256_CBC_SHA
| 0x00 0x38 | RFC 3268
|
TLS_DHE_DSS_AES_128_CBC_SHA
| 0x00 0x32 | RFC 3268
|
TLS_DHE_RSA_AES_256_CBC_SHA
| 0x00 0x39 | RFC 3268
|
TLS_DHE_RSA_AES_128_CBC_SHA
| 0x00 0x33 | RFC 3268
|
TLS_SRP_SHA_3DES_EDE_CBC_SHA
| 0x00 0x50 | draft-ietf-tls-srp
|
TLS_SRP_SHA_AES_128_CBC_SHA
| 0x00 0x53 | draft-ietf-tls-srp
|
TLS_SRP_SHA_AES_256_CBC_SHA
| 0x00 0x56 | draft-ietf-tls-srp
|
TLS_SRP_SHA_RSA_3DES_EDE_CBC_SHA
| 0x00 0x51 | draft-ietf-tls-srp
|
TLS_SRP_SHA_DSS_3DES_EDE_CBC_SHA
| 0x00 0x52 | draft-ietf-tls-srp
|
TLS_SRP_SHA_RSA_AES_128_CBC_SHA
| 0x00 0x54 | draft-ietf-tls-srp
|
TLS_SRP_SHA_DSS_AES_128_CBC_SHA
| 0x00 0x55 | draft-ietf-tls-srp
|
TLS_SRP_SHA_RSA_AES_256_CBC_SHA
| 0x00 0x57 | draft-ietf-tls-srp
|
TLS_SRP_SHA_DSS_AES_256_CBC_SHA
| 0x00 0x58 | draft-ietf-tls-srp
|
TLS_DHE_DSS_ARCFOUR_SHA
| 0x00 0x66 | draft-ietf-tls-56-bit-ciphersuites
|
TLS_PSK_ARCFOUR_SHA
| 0x00 0x8A | draft-ietf-tls-psk
|
TLS_PSK_3DES_EDE_CBC_SHA
| 0x00 0x8B | draft-ietf-tls-psk
|
TLS_PSK_AES_128_CBC_SHA
| 0x00 0x8C | draft-ietf-tls-psk
|
TLS_PSK_AES_256_CBC_SHA
| 0x00 0x8D | draft-ietf-tls-psk
|
This chapter is to give a brief description of the way GnuTLS works. The focus is to give an idea to potential developers and those who want to know what happens inside the black box.
The main needs for the TLS protocol to be used are shown in the image below.
This is being accomplished by the following object diagram.
Note that since GnuTLS is being developed in C
object are just structures with attributes. The operations listed
are functions that require the first parameter to be that object.
The GnuTLS handshake protocol is implemented as a state machine that waits for input or returns immediately when the non-blocking transport layer functions are used. The main idea is shown in the following figure.
Also the way the input is processed varies per ciphersuite. Several
implementations of the internal handlers are available and
gnutls_handshake only multiplexes the input to the appropriate
handler. For example a PSK ciphersuite has a different
implementation of the process_client_key_exchange than a
certificate ciphersuite.
In GnuTLS authentication methods can be implemented quite easily. Since the required changes to add a new authentication method affect only the handshake protocol, a simple interface is used. An authentication method needs only to implement the functions as seen in the figure below.
The functions that need to be implemented are the ones responsible for interpreting
the handshake protocol messages. It is common for such functions to read data from
one or more credentials_t structures17 and write data, such as certificates, usernames etc. to auth_info_t structures.
Simple examples of existing authentication methods can be seen in auth_psk.c
for PSK ciphersuites and auth_srp.c for SRP ciphersuites. After implementing these functions
the structure holding its pointers has to be registered in gnutls_algorithms.c
in the _gnutls_kx_algorithms structure.
As with authentication methods, the TLS extensions handlers can be implemented using the following interface.
Here there are two functions, one for receiving the extension data and one for sending. These functions have to check internally whether they operate in client or server side.
A simple example of an extension handler can be seen in ext_srp.c
After implementing these functions, together with the extension number they
handle, they have to be registered in gnutls_extensions.c in the
_gnutls_extensions structure.
What is provided by the certificate handling functions is summarized in the following diagram.
Copyright © 2000,2001,2002 Free Software Foundation, Inc.
51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
The purpose of this License is to make a manual, textbook, or other functional and useful document free in the sense of freedom: to assure everyone the effective freedom to copy and redistribute it, with or without modifying it, either commercially or noncommercially. Secondarily, this License preserves for the author and publisher a way to get credit for their work, while not being considered responsible for modifications made by others.
This License is a kind of “copyleft”, which means that derivative works of the document must themselves be free in the same sense. It complements the GNU General Public License, which is a copyleft license designed for free software.
We have designed this License in order to use it for manuals for free software, because free software needs free documentation: a free program should come with manuals providing the same freedoms that the software does. But this License is not limited to software manuals; it can be used for any textual work, regardless of subject matter or whether it is published as a printed book. We recommend this License principally for works whose purpose is instruction or reference.
This License applies to any manual or other work, in any medium, that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License. Such a notice grants a world-wide, royalty-free license, unlimited in duration, to use that work under the conditions stated herein. The “Document”, below, refers to any such manual or work. Any member of the public is a licensee, and is addressed as “you”. You accept the license if you copy, modify or distribute the work in a way requiring permission under copyright law.
A “Modified Version” of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications and/or translated into another language.
A “Secondary Section” is a named appendix or a front-matter section of the Document that deals exclusively with the relationship of the publishers or authors of the Document to the Document's overall subject (or to related matters) and contains nothing that could fall directly within that overall subject. (Thus, if the Document is in part a textbook of mathematics, a Secondary Section may not explain any mathematics.) The relationship could be a matter of historical connection with the subject or with related matters, or of legal, commercial, philosophical, ethical or political position regarding them.
The “Invariant Sections” are certain Secondary Sections whose titles are designated, as being those of Invariant Sections, in the notice that says that the Document is released under this License. If a section does not fit the above definition of Secondary then it is not allowed to be designated as Invariant. The Document may contain zero Invariant Sections. If the Document does not identify any Invariant Sections then there are none.
The “Cover Texts” are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says that the Document is released under this License. A Front-Cover Text may be at most 5 words, and a Back-Cover Text may be at most 25 words.
A “Transparent” copy of the Document means a machine-readable copy, represented in a format whose specification is available to the general public, that is suitable for revising the document straightforwardly with generic text editors or (for images composed of pixels) generic paint programs or (for drawings) some widely available drawing editor, and that is suitable for input to text formatters or for automatic translation to a variety of formats suitable for input to text formatters. A copy made in an otherwise Transparent file format whose markup, or absence of markup, has been arranged to thwart or discourage subsequent modification by readers is not Transparent. An image format is not Transparent if used for any substantial amount of text. A copy that is not “Transparent” is called “Opaque”.
Examples of suitable formats for Transparent copies include plain ascii without markup, Texinfo input format, LaTeX input format, SGML or XML using a publicly available DTD, and standard-conforming simple HTML, PostScript or PDF designed for human modification. Examples of transparent image formats include PNG, XCF and JPG. Opaque formats include proprietary formats that can be read and edited only by proprietary word processors, SGML or XML for which the DTD and/or processing tools are not generally available, and the machine-generated HTML, PostScript or PDF produced by some word processors for output purposes only.
The “Title Page” means, for a printed book, the title page itself, plus such following pages as are needed to hold, legibly, the material this License requires to appear in the title page. For works in formats which do not have any title page as such, “Title Page” means the text near the most prominent appearance of the work's title, preceding the beginning of the body of the text.
A section “Entitled XYZ” means a named subunit of the Document whose title either is precisely XYZ or contains XYZ in parentheses following text that translates XYZ in another language. (Here XYZ stands for a specific section name mentioned below, such as “Acknowledgements”, “Dedications”, “Endorsements”, or “History”.) To “Preserve the Title” of such a section when you modify the Document means that it remains a section “Entitled XYZ” according to this definition.
The Document may include Warranty Disclaimers next to the notice which states that this License applies to the Document. These Warranty Disclaimers are considered to be included by reference in this License, but only as regards disclaiming warranties: any other implication that these Warranty Disclaimers may have is void and has no effect on the meaning of this License.
You may copy and distribute the Document in any medium, either commercially or noncommercially, provided that this License, the copyright notices, and the license notice saying this License applies to the Document are reproduced in all copies, and that you add no other conditions whatsoever to those of this License. You may not use technical measures to obstruct or control the reading or further copying of the copies you make or distribute. However, you may accept compensation in exchange for copies. If you distribute a large enough number of copies you must also follow the conditions in section 3.
You may also lend copies, under the same conditions stated above, and you may publicly display copies.
If you publish printed copies (or copies in media that commonly have printed covers) of the Document, numbering more than 100, and the Document's license notice requires Cover Texts, you must enclose the copies in covers that carry, clearly and legibly, all these Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on the back cover. Both covers must also clearly and legibly identify you as the publisher of these copies. The front cover must present the full title with all words of the title equally prominent and visible. You may add other material on the covers in addition. Copying with changes limited to the covers, as long as they preserve the title of the Document and satisfy these conditions, can be treated as verbatim copying in other respects.
If the required texts for either cover are too voluminous to fit legibly, you should put the first ones listed (as many as fit reasonably) on the actual cover, and continue the rest onto adjacent pages.
If you publish or distribute Opaque copies of the Document numbering more than 100, you must either include a machine-readable Transparent copy along with each Opaque copy, or state in or with each Opaque copy a computer-network location from which the general network-using public has access to download using public-standard network protocols a complete Transparent copy of the Document, free of added material. If you use the latter option, you must take reasonably prudent steps, when you begin distribution of Opaque copies in quantity, to ensure that this Transparent copy will remain thus accessible at the stated location until at least one year after the last time you distribute an Opaque copy (directly or through your agents or retailers) of that edition to the public.
It is requested, but not required, that you contact the authors of the Document well before redistributing any large number of copies, to give them a chance to provide you with an updated version of the Document.
You may copy and distribute a Modified Version of the Document under the conditions of sections 2 and 3 above, provided that you release the Modified Version under precisely this License, with the Modified Version filling the role of the Document, thus licensing distribution and modification of the Modified Version to whoever possesses a copy of it. In addition, you must do these things in the Modified Version:
If the Modified Version includes new front-matter sections or appendices that qualify as Secondary Sections and contain no material copied from the Document, you may at your option designate some or all of these sections as invariant. To do this, add their titles to the list of Invariant Sections in the Modified Version's license notice. These titles must be distinct from any other section titles.
You may add a section Entitled “Endorsements”, provided it contains nothing but endorsements of your Modified Version by various parties—for example, statements of peer review or that the text has been approved by an organization as the authoritative definition of a standard.
You may add a passage of up to five words as a Front-Cover Text, and a passage of up to 25 words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified Version. Only one passage of Front-Cover Text and one of Back-Cover Text may be added by (or through arrangements made by) any one entity. If the Document already includes a cover text for the same cover, previously added by you or by arrangement made by the same entity you are acting on behalf of, you may not add another; but you may replace the old one, on explicit permission from the previous publisher that added the old one.
The author(s) and publisher(s) of the Document do not by this License give permission to use their names for publicity for or to assert or imply endorsement of any Modified Version.
You may combine the Document with other documents released under this License, under the terms defined in section 4 above for modified versions, provided that you include in the combination all of the Invariant Sections of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in its license notice, and that you preserve all their Warranty Disclaimers.
The combined work need only contain one copy of this License, and multiple identical Invariant Sections may be replaced with a single copy. If there are multiple Invariant Sections with the same name but different contents, make the title of each such section unique by adding at the end of it, in parentheses, the name of the original author or publisher of that section if known, or else a unique number. Make the same adjustment to the section titles in the list of Invariant Sections in the license notice of the combined work.
In the combination, you must combine any sections Entitled “History” in the various original documents, forming one section Entitled “History”; likewise combine any sections Entitled “Acknowledgements”, and any sections Entitled “Dedications”. You must delete all sections Entitled “Endorsements.”
You may make a collection consisting of the Document and other documents released under this License, and replace the individual copies of this License in the various documents with a single copy that is included in the collection, provided that you follow the rules of this License for verbatim copying of each of the documents in all other respects.
You may extract a single document from such a collection, and distribute it individually under this License, provided you insert a copy of this License into the extracted document, and follow this License in all other respects regarding verbatim copying of that document.
A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a storage or distribution medium, is called an “aggregate” if the copyright resulting from the compilation is not used to limit the legal rights of the compilation's users beyond what the individual works permit. When the Document is included in an aggregate, this License does not apply to the other works in the aggregate which are not themselves derivative works of the Document.
If the Cover Text requirement of section 3 is applicable to these copies of the Document, then if the Document is less than one half of the entire aggregate, the Document's Cover Texts may be placed on covers that bracket the Document within the aggregate, or the electronic equivalent of covers if the Document is in electronic form. Otherwise they must appear on printed covers that bracket the whole aggregate.
Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. Replacing Invariant Sections with translations requires special permission from their copyright holders, but you may include translations of some or all Invariant Sections in addition to the original versions of these Invariant Sections. You may include a translation of this License, and all the license notices in the Document, and any Warranty Disclaimers, provided that you also include the original English version of this License and the original versions of those notices and disclaimers. In case of a disagreement between the translation and the original version of this License or a notice or disclaimer, the original version will prevail.
If a section in the Document is Entitled “Acknowledgements”, “Dedications”, or “History”, the requirement (section 4) to Preserve its Title (section 1) will typically require changing the actual title.
You may not copy, modify, sublicense, or distribute the Document except as expressly provided for under this License. Any other attempt to copy, modify, sublicense or distribute the Document is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance.
The Free Software Foundation may publish new, revised versions of the GNU Free Documentation License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. See http://www.gnu.org/copyleft/.
Each version of the License is given a distinguishing version number. If the Document specifies that a particular numbered version of this License “or any later version” applies to it, you have the option of following the terms and conditions either of that specified version or of any later version that has been published (not as a draft) by the Free Software Foundation. If the Document does not specify a version number of this License, you may choose any version ever published (not as a draft) by the Free Software Foundation.
To use this License in a document you have written, include a copy of the License in the document and put the following copyright and license notices just after the title page:
Copyright (C) year your name.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.2
or any later version published by the Free Software Foundation;
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
Texts. A copy of the license is included in the section entitled ``GNU
Free Documentation License''.
If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, replace the “with...Texts.” line with this:
with the Invariant Sections being list their titles, with
the Front-Cover Texts being list, and with the Back-Cover Texts
being list.
If you have Invariant Sections without Cover Texts, or some other combination of the three, merge those two alternatives to suit the situation.
If your document contains nontrivial examples of program code, we recommend releasing these examples in parallel under your choice of free software license, such as the GNU General Public License, to permit their use in free software.
Copyright © 1991, 1999 Free Software Foundation, Inc.
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
[This is the first released version of the Lesser GPL. It also counts
as the successor of the GNU Library Public License, version 2, hence the
version number 2.1.]
The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public Licenses are intended to guarantee your freedom to share and change free software—to make sure the software is free for all its users.
This license, the Lesser General Public License, applies to some specially designated software—typically libraries—of the Free Software Foundation and other authors who decide to use it. You can use it too, but we suggest you first think carefully about whether this license or the ordinary General Public License is the better strategy to use in any particular case, based on the explanations below.
When we speak of free software, we are referring to freedom of use, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish); that you receive source code or can get it if you want it; that you can change the software and use pieces of it in new free programs; and that you are informed that you can do these things.
To protect your rights, we need to make restrictions that forbid distributors to deny you these rights or to ask you to surrender these rights. These restrictions translate to certain responsibilities for you if you distribute copies of the library or if you modify it.
For example, if you distribute copies of the library, whether gratis or for a fee, you must give the recipients all the rights that we gave you. You must make sure that they, too, receive or can get the source code. If you link other code with the library, you must provide complete object files to the recipients, so that they can relink them with the library after making changes to the library and recompiling it. And you must show them these terms so they know their rights.
We protect your rights with a two-step method: (1) we copyright the library, and (2) we offer you this license, which gives you legal permission to copy, distribute and/or modify the library.
To protect each distributor, we want to make it very clear that there is no warranty for the free library. Also, if the library is modified by someone else and passed on, the recipients should know that what they have is not the original version, so that the original author's reputation will not be affected by problems that might be introduced by others.
Finally, software patents pose a constant threat to the existence of any free program. We wish to make sure that a company cannot effectively restrict the users of a free program by obtaining a restrictive license from a patent holder. Therefore, we insist that any patent license obtained for a version of the library must be consistent with the full freedom of use specified in this license.
Most GNU software, including some libraries, is covered by the ordinary GNU General Public License. This license, the GNU Lesser General Public License, applies to certain designated libraries, and is quite different from the ordinary General Public License. We use this license for certain libraries in order to permit linking those libraries into non-free programs.
When a program is linked with a library, whether statically or using a shared library, the combination of the two is legally speaking a combined work, a derivative of the original library. The ordinary General Public License therefore permits such linking only if the entire combination fits its criteria of freedom. The Lesser General Public License permits more lax criteria for linking other code with the library.
We call this license the Lesser General Public License because it does Less to protect the user's freedom than the ordinary General Public License. It also provides other free software developers Less of an advantage over competing non-free programs. These disadvantages are the reason we use the ordinary General Public License for many libraries. However, the Lesser license provides advantages in certain special circumstances.
For example, on rare occasions, there may be a special need to encourage the widest possible use of a certain library, so that it becomes a de-facto standard. To achieve this, non-free programs must be allowed to use the library. A more frequent case is that a free library does the same job as widely used non-free libraries. In this case, there is little to gain by limiting the free library to free software only, so we use the Lesser General Public License.
In other cases, permission to use a particular library in non-free programs enables a greater number of people to use a large body of free software. For example, permission to use the GNU C Library in non-free programs enables many more people to use the whole GNU operating system, as well as its variant, the GNU/Linux operating system.
Although the Lesser General Public License is Less protective of the users' freedom, it does ensure that the user of a program that is linked with the Library has the freedom and the wherewithal to run that program using a modified version of the Library.
The precise terms and conditions for copying, distribution and modification follow. Pay close attention to the difference between a “work based on the library” and a “work that uses the library”. The former contains code derived from the library, whereas the latter must be combined with the library in order to run.
A “library” means a collection of software functions and/or data prepared so as to be conveniently linked with application programs (which use some of those functions and data) to form executables.
The “Library”, below, refers to any such software library or work which has been distributed under these terms. A “work based on the Library” means either the Library or any derivative work under copyright law: that is to say, a work containing the Library or a portion of it, either verbatim or with modifications and/or translated straightforwardly into another language. (Hereinafter, translation is included without limitation in the term “modification”.)
“Source code” for a work means the preferred form of the work for making modifications to it. For a library, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the library.
Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running a program using the Library is not restricted, and output from such a program is covered only if its contents constitute a work based on the Library (independent of the use of the Library in a tool for writing it). Whether that is true depends on what the Library does and what the program that uses the Library does.
You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee.
(For example, a function in a library to compute square roots has a purpose that is entirely well-defined independent of the application. Therefore, Subsection 2d requires that any application-supplied function or table used by this function must be optional: if the application does not supply it, the square root function must still compute square roots.)
These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Library, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Library, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Library.
In addition, mere aggregation of another work not based on the Library with the Library (or with a work based on the Library) on a volume of a storage or distribution medium does not bring the other work under the scope of this License.
Once this change is made in a given copy, it is irreversible for that copy, so the ordinary GNU General Public License applies to all subsequent copies and derivative works made from that copy.
This option is useful when you wish to copy part of the code of the Library into a program that is not a library.
If distribution of object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place satisfies the requirement to distribute the source code, even though third parties are not compelled to copy the source along with the object code.
However, linking a “work that uses the Library” with the Library creates an executable that is a derivative of the Library (because it contains portions of the Library), rather than a “work that uses the library”. The executable is therefore covered by this License. Section 6 states terms for distribution of such executables.
When a “work that uses the Library” uses material from a header file that is part of the Library, the object code for the work may be a derivative work of the Library even though the source code is not. Whether this is true is especially significant if the work can be linked without the Library, or if the work is itself a library. The threshold for this to be true is not precisely defined by law.
If such an object file uses only numerical parameters, data structure layouts and accessors, and small macros and small inline functions (ten lines or less in length), then the use of the object file is unrestricted, regardless of whether it is legally a derivative work. (Executables containing this object code plus portions of the Library will still fall under Section 6.)
Otherwise, if the work is a derivative of the Library, you may distribute the object code for the work under the terms of Section 6. Any executables containing that work also fall under Section 6, whether or not they are linked directly with the Library itself.
You must give prominent notice with each copy of the work that the Library is used in it and that the Library and its use are covered by this License. You must supply a copy of this License. If the work during execution displays copyright notices, you must include the copyright notice for the Library among them, as well as a reference directing the user to the copy of this License. Also, you must do one of these things:
For an executable, the required form of the “work that uses the Library” must include any data and utility programs needed for reproducing the executable from it. However, as a special exception, the materials to be distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable.
It may happen that this requirement contradicts the license restrictions of other proprietary libraries that do not normally accompany the operating system. Such a contradiction means you cannot use both them and the Library together in an executable that you distribute.
If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply, and the section as a whole is intended to apply in other circumstances.
It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice.
This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License.
Each version is given a distinguishing version number. If the Library specifies a version number of this License which applies to it and “any later version”, you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Library does not specify a license version number, you may choose any version ever published by the Free Software Foundation.
If you develop a new library, and you want it to be of the greatest possible use to the public, we recommend making it free software that everyone can redistribute and change. You can do so by permitting redistribution under these terms (or, alternatively, under the terms of the ordinary General Public License).
To apply these terms, attach the following notices to the library. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the “copyright” line and a pointer to where the full notice is found.
one line to give the library's name and an idea of what it does.
Copyright (C) year name of author
This library is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or (at
your option) any later version.
This library is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
USA.
Also add information on how to contact you by electronic and paper mail.
You should also get your employer (if you work as a programmer) or your school, if any, to sign a “copyright disclaimer” for the library, if necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the library
`Frob' (a library for tweaking knobs) written by James Random Hacker.
signature of Ty Coon, 1 April 1990
Ty Coon, President of Vice
That's all there is to it!
Copyright © 1989, 1991 Free Software Foundation, Inc.
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software—to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Lesser General Public License instead.) You can apply it to your programs, too.
When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things.
To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it.
For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights.
We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software.
Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations.
Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all.
The precise terms and conditions for copying, distribution and modification follow.
Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does.
You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee.
These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program.
In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License.
The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable.
If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code.
If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances.
It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice.
This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License.
Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and “any later version”, you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation.
If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the “copyright” line and a pointer to where the full notice is found.
one line to give the program's name and a brief idea of what it does.
Copyright (C) yyyy name of author
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
Also add information on how to contact you by electronic and paper mail.
If the program is interactive, make it output a short notice like this when it starts in an interactive mode:
Gnomovision version 69, Copyright (C) year name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items—whatever suits your program.
You should also get your employer (if you work as a programmer) or your school, if any, to sign a “copyright disclaimer” for the program, if necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
`Gnomovision' (which makes passes at compilers) written by James Hacker.
signature of Ty Coon, 1 April 1989
Ty Coon, President of Vice
This General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License.
gnutls_alert_get: Core functionsgnutls_alert_get_name: Core functionsgnutls_alert_send: Core functionsgnutls_alert_send_appropriate: Core functionsgnutls_anon_allocate_client_credentials: Core functionsgnutls_anon_allocate_server_credentials: Core functionsgnutls_anon_free_client_credentials: Core functionsgnutls_anon_free_server_credentials: Core functionsgnutls_anon_set_params_function: Core functionsgnutls_anon_set_server_dh_params: Core functionsgnutls_anon_set_server_params_function: Core functionsgnutls_auth_client_get_type: Core functionsgnutls_auth_get_type: Core functionsgnutls_auth_server_get_type: Core functionsgnutls_authz_enable: Core functionsgnutls_authz_send_saml_assertion: Core functionsgnutls_authz_send_saml_assertion_url: Core functionsgnutls_authz_send_x509_attr_cert: Core functionsgnutls_authz_send_x509_attr_cert_url: Core functionsgnutls_bye: Core functionsgnutls_certificate_activation_time_peers: Core functionsgnutls_certificate_allocate_credentials: Core functionsgnutls_certificate_client_get_request_status: Core functionsgnutls_certificate_client_set_retrieve_function: Core functionsgnutls_certificate_expiration_time_peers: Core functionsgnutls_certificate_free_ca_names: Core functionsgnutls_certificate_free_cas: Core functionsgnutls_certificate_free_credentials: Core functionsgnutls_certificate_free_crls: Core functionsgnutls_certificate_free_keys: Core functionsgnutls_certificate_get_ours: Core functionsgnutls_certificate_get_peers: Core functionsgnutls_certificate_send_x509_rdn_sequence: Core functionsgnutls_certificate_server_set_request: Core functionsgnutls_certificate_server_set_retrieve_function: Core functionsgnutls_certificate_set_dh_params: Core functionsgnutls_certificate_set_openpgp_key: OpenPGP functionsgnutls_certificate_set_openpgp_key_file: OpenPGP functionsgnutls_certificate_set_openpgp_key_mem: OpenPGP functionsgnutls_certificate_set_openpgp_keyring_file: OpenPGP functionsgnutls_certificate_set_openpgp_keyring_mem: OpenPGP functionsgnutls_certificate_set_openpgp_keyserver: OpenPGP functionsgnutls_certificate_set_openpgp_trustdb: OpenPGP functionsgnutls_certificate_set_params_function: Core functionsgnutls_certificate_set_rsa_export_params: Core functionsgnutls_certificate_set_verify_flags: Core functionsgnutls_certificate_set_verify_limits: Core functionsgnutls_certificate_set_x509_crl: Core functionsgnutls_certificate_set_x509_crl_file: Core functionsgnutls_certificate_set_x509_crl_mem: Core functionsgnutls_certificate_set_x509_key: Core functionsgnutls_certificate_set_x509_key_file: Core functionsgnutls_certificate_set_x509_key_mem: Core functionsgnutls_certificate_set_x509_simple_pkcs12_file: Core functionsgnutls_certificate_set_x509_trust: Core functionsgnutls_certificate_set_x509_trust_file: Core functionsgnutls_certificate_set_x509_trust_mem: Core functionsgnutls_certificate_type_get: Core functionsgnutls_certificate_type_get_name: Core functionsgnutls_certificate_type_list: Core functionsgnutls_certificate_type_set_priority: Core functionsgnutls_certificate_verify_flags: Verifying X.509 certificate pathsgnutls_certificate_verify_peers: Core functionsgnutls_certificate_verify_peers2: Core functionsgnutls_check_version: Core functionsgnutls_cipher_get: Core functionsgnutls_cipher_get_key_size: Core functionsgnutls_cipher_get_name: Core functionsgnutls_cipher_list: Core functionsgnutls_cipher_set_priority: Core functionsgnutls_cipher_suite_get_name: Core functionsgnutls_cipher_suite_info: Core functionsgnutls_compression_get: Core functionsgnutls_compression_get_name: Core functionsgnutls_compression_list: Core functionsgnutls_compression_set_priority: Core functionsgnutls_credentials_clear: Core functionsgnutls_credentials_set: Core functionsgnutls_db_check_entry: Core functionsgnutls_db_get_ptr: Core functionsgnutls_db_remove_session: Core functionsgnutls_db_set_cache_expiration: Core functionsgnutls_db_set_ptr: Core functionsgnutls_db_set_remove_function: Core functionsgnutls_db_set_retrieve_function: Core functionsgnutls_db_set_store_function: Core functionsgnutls_deinit: Core functionsgnutls_dh_get_group: Core functionsgnutls_dh_get_peers_public_bits: Core functionsgnutls_dh_get_prime_bits: Core functionsgnutls_dh_get_pubkey: Core functionsgnutls_dh_get_secret_bits: Core functionsgnutls_dh_params_cpy: Core functionsgnutls_dh_params_deinit: Core functionsgnutls_dh_params_export_pkcs3: Core functionsgnutls_dh_params_export_raw: Core functionsgnutls_dh_params_generate2: Core functionsgnutls_dh_params_import_pkcs3: Core functionsgnutls_dh_params_import_raw: Core functionsgnutls_dh_params_init: Core functionsgnutls_dh_set_prime_bits: Core functionsgnutls_error_is_fatal: Core functionsgnutls_error_to_alert: Core functionsgnutls_extra_check_version: GnuTLS-extra functionsgnutls_fingerprint: Core functionsgnutls_free: Core functionsgnutls_global_deinit: Core functionsgnutls_global_init: Core functionsgnutls_global_init_extra: GnuTLS-extra functionsgnutls_global_set_log_function: Core functionsgnutls_global_set_log_level: Core functionsgnutls_global_set_mem_functions: Core functionsgnutls_handshake: Core functionsgnutls_handshake_get_last_in: Core functionsgnutls_handshake_get_last_out: Core functionsgnutls_handshake_set_max_packet_length: Core functionsgnutls_handshake_set_private_extensions: Core functionsgnutls_hex_decode: Core functionsgnutls_hex_encode: Core functionsgnutls_ia_allocate_client_credentials: TLS Inner Application (TLS/IA) functionsgnutls_ia_allocate_server_credentials: TLS Inner Application (TLS/IA) functionsgnutls_ia_enable: TLS Inner Application (TLS/IA) functionsgnutls_ia_endphase_send: TLS Inner Application (TLS/IA) functionsgnutls_ia_extract_inner_secret: TLS Inner Application (TLS/IA) functionsgnutls_ia_free_client_credentials: TLS Inner Application (TLS/IA) functionsgnutls_ia_free_server_credentials: TLS Inner Application (TLS/IA) functionsgnutls_ia_generate_challenge: TLS Inner Application (TLS/IA) functionsgnutls_ia_get_client_avp_ptr: TLS Inner Application (TLS/IA) functionsgnutls_ia_get_server_avp_ptr: TLS Inner Application (TLS/IA) functionsgnutls_ia_handshake: TLS Inner Application (TLS/IA) functionsgnutls_ia_handshake_p: TLS Inner Application (TLS/IA) functionsgnutls_ia_permute_inner_secret: TLS Inner Application (TLS/IA) functionsgnutls_ia_recv: TLS Inner Application (TLS/IA) functionsgnutls_ia_send: TLS Inner Application (TLS/IA) functionsgnutls_ia_set_client_avp_function: TLS Inner Application (TLS/IA) functionsgnutls_ia_set_client_avp_ptr: TLS Inner Application (TLS/IA) functionsgnutls_ia_set_server_avp_function: TLS Inner Application (TLS/IA) functionsgnutls_ia_set_server_avp_ptr: TLS Inner Application (TLS/IA) functionsgnutls_ia_verify_endphase: TLS Inner Application (TLS/IA) functionsgnutls_init: Core functionsgnutls_kx_get: Core functionsgnutls_kx_get_name: Core functionsgnutls_kx_list: Core functionsgnutls_kx_set_priority: Core functionsgnutls_mac_get: Core functionsgnutls_mac_get_name: Core functionsgnutls_mac_list: Core functionsgnutls_mac_set_priority: Core functionsgnutls_malloc: Core functionsgnutls_openpgp_key_check_hostname: OpenPGP functionsgnutls_openpgp_key_deinit: OpenPGP functionsgnutls_openpgp_key_export: OpenPGP functionsgnutls_openpgp_key_get_creation_time: OpenPGP functionsgnutls_openpgp_key_get_expiration_time: OpenPGP functionsgnutls_openpgp_key_get_fingerprint: OpenPGP functionsgnutls_openpgp_key_get_id: OpenPGP functionsgnutls_openpgp_key_get_key_usage: OpenPGP functionsgnutls_openpgp_key_get_name: OpenPGP functionsgnutls_openpgp_key_get_pk_algorithm: OpenPGP functionsgnutls_openpgp_key_get_version: OpenPGP functionsgnutls_openpgp_key_import: OpenPGP functionsgnutls_openpgp_key_init: OpenPGP functionsgnutls_openpgp_key_to_xml: OpenPGP functionsgnutls_openpgp_key_verify_ring: OpenPGP functionsgnutls_openpgp_key_verify_self: OpenPGP functionsgnutls_openpgp_key_verify_trustdb: OpenPGP functionsgnutls_openpgp_keyring_check_id: OpenPGP functionsgnutls_openpgp_keyring_deinit: OpenPGP functionsgnutls_openpgp_keyring_import: OpenPGP functionsgnutls_openpgp_keyring_init: OpenPGP functionsgnutls_openpgp_privkey_deinit: OpenPGP functionsgnutls_openpgp_privkey_get_pk_algorithm: OpenPGP functionsgnutls_openpgp_privkey_import: OpenPGP functionsgnutls_openpgp_privkey_init: OpenPGP functionsgnutls_openpgp_send_key: Core functionsgnutls_openpgp_set_recv_key_function: OpenPGP functionsgnutls_openpgp_trustdb_deinit: OpenPGP functionsgnutls_openpgp_trustdb_import_file: OpenPGP functionsgnutls_openpgp_trustdb_init: OpenPGP functionsgnutls_pem_base64_decode: Core functionsgnutls_pem_base64_decode_alloc: Core functionsgnutls_pem_base64_encode: Core functionsgnutls_pem_base64_encode_alloc: Core functionsgnutls_perror: Core functionsgnutls_pk_algorithm_get_name: Core functionsgnutls_pkcs11_get_ca_certificates: Crypto provider (PKCS#11) functionsgnutls_pkcs12_bag_decrypt: X.509 certificate functionsgnutls_pkcs12_bag_deinit: X.509 certificate functionsgnutls_pkcs12_bag_encrypt: X.509 certificate functionsgnutls_pkcs12_bag_get_count: X.509 certificate functionsgnutls_pkcs12_bag_get_data: X.509 certificate functionsgnutls_pkcs12_bag_get_friendly_name: X.509 certificate functionsgnutls_pkcs12_bag_get_key_id: X.509 certificate functionsgnutls_pkcs12_bag_get_type: X.509 certificate functionsgnutls_pkcs12_bag_init: X.509 certificate functionsgnutls_pkcs12_bag_set_crl: X.509 certificate functionsgnutls_pkcs12_bag_set_crt: X.509 certificate functionsgnutls_pkcs12_bag_set_data: X.509 certificate functionsgnutls_pkcs12_bag_set_friendly_name: X.509 certificate functionsgnutls_pkcs12_bag_set_key_id: X.509 certificate functionsgnutls_pkcs12_deinit: X.509 certificate functionsgnutls_pkcs12_export: X.509 certificate functionsgnutls_pkcs12_generate_mac: X.509 certificate functionsgnutls_pkcs12_get_bag: X.509 certificate functionsgnutls_pkcs12_import: X.509 certificate functionsgnutls_pkcs12_init: X.509 certificate functionsgnutls_pkcs12_set_bag: X.509 certificate functionsgnutls_pkcs12_verify_mac: X.509 certificate functionsgnutls_pkcs7_deinit: X.509 certificate functionsgnutls_pkcs7_delete_crl: X.509 certificate functionsgnutls_pkcs7_delete_crt: X.509 certificate functionsgnutls_pkcs7_export: X.509 certificate functionsgnutls_pkcs7_get_crl_count: X.509 certificate functionsgnutls_pkcs7_get_crl_raw: X.509 certificate functionsgnutls_pkcs7_get_crt_count: X.509 certificate functionsgnutls_pkcs7_get_crt_raw: X.509 certificate functionsgnutls_pkcs7_import: X.509 certificate functionsgnutls_pkcs7_init: X.509 certificate functionsgnutls_pkcs7_set_crl: X.509 certificate functionsgnutls_pkcs7_set_crl_raw: X.509 certificate functionsgnutls_pkcs7_set_crt: X.509 certificate functionsgnutls_pkcs7_set_crt_raw: X.509 certificate functionsgnutls_prf: Core functionsgnutls_prf_raw: Core functionsgnutls_protocol_get_name: Core functionsgnutls_protocol_get_version: Core functionsgnutls_protocol_list: Core functionsgnutls_protocol_set_priority: Core functionsgnutls_psk_allocate_client_credentials: Core functionsgnutls_psk_allocate_server_credentials: Core functionsgnutls_psk_free_client_credentials: Core functionsgnutls_psk_free_server_credentials: Core functionsgnutls_psk_server_get_username: Core functionsgnutls_psk_set_client_credentials: Core functionsgnutls_psk_set_client_credentials_function: Core functionsgnutls_psk_set_params_function: Core functionsgnutls_psk_set_server_credentials_file: Core functionsgnutls_psk_set_server_credentials_function: Core functionsgnutls_psk_set_server_dh_params: Core functionsgnutls_psk_set_server_params_function: Core functionsgnutls_record_check_pending: Core functionsgnutls_record_get_direction: Core functionsgnutls_record_get_max_size: Core functionsgnutls_record_recv: Core functionsgnutls_record_send: Core functionsgnutls_record_set_max_size: Core functionsgnutls_rehandshake: Core functionsgnutls_rsa_export_get_modulus_bits: Core functionsgnutls_rsa_export_get_pubkey: Core functionsgnutls_rsa_params_cpy: Core functionsgnutls_rsa_params_deinit: Core functionsgnutls_rsa_params_export_pkcs1: Core functionsgnutls_rsa_params_export_raw: Core functionsgnutls_rsa_params_generate2: Core functionsgnutls_rsa_params_import_pkcs1: Core functionsgnutls_rsa_params_import_raw: Core functionsgnutls_rsa_params_init: Core functionsgnutls_server_name_get: Core functionsgnutls_server_name_set: Core functionsgnutls_session_get_client_random: Core functionsgnutls_session_get_data: Core functionsgnutls_session_get_data2: Core functionsgnutls_session_get_id: Core functionsgnutls_session_get_master_secret: Core functionsgnutls_session_get_ptr: Core functionsgnutls_session_get_server_random: Core functionsgnutls_session_is_resumed: Core functionsgnutls_session_set_data: Core functionsgnutls_session_set_ptr: Core functionsgnutls_set_default_export_priority: Core functionsgnutls_set_default_priority: Core functionsgnutls_sign_algorithm_get_name: Core functionsgnutls_srp_allocate_client_credentials: Core functionsgnutls_srp_allocate_server_credentials: Core functionsgnutls_srp_base64_decode: Core functionsgnutls_srp_base64_decode_alloc: Core functionsgnutls_srp_base64_encode: Core functionsgnutls_srp_base64_encode_alloc: Core functionsgnutls_srp_free_client_credentials: Core functionsgnutls_srp_free_server_credentials: Core functionsgnutls_srp_server_get_username: Core functionsgnutls_srp_set_client_credentials: Core functionsgnutls_srp_set_client_credentials_function: Core functionsgnutls_srp_set_server_credentials_file: Core functionsgnutls_srp_set_server_credentials_function: Core functionsgnutls_srp_verifier: Core functionsgnutls_strerror: Core functionsgnutls_transport_get_ptr: Core functionsgnutls_transport_get_ptr2: Core functionsgnutls_transport_set_errno: Core functionsgnutls_transport_set_global_errno: Core functionsgnutls_transport_set_lowat: Core functionsgnutls_transport_set_ptr: Core functionsgnutls_transport_set_ptr2: Core functionsgnutls_transport_set_pull_function: Core functionsgnutls_transport_set_push_function: Core functionsgnutls_x509_crl_check_issuer: X.509 certificate functionsgnutls_x509_crl_deinit: X.509 certificate functionsgnutls_x509_crl_export: X.509 certificate functionsgnutls_x509_crl_get_crt_count: X.509 certificate functionsgnutls_x509_crl_get_crt_serial: X.509 certificate functionsgnutls_x509_crl_get_dn_oid: X.509 certificate functionsgnutls_x509_crl_get_issuer_dn: X.509 certificate functionsgnutls_x509_crl_get_issuer_dn_by_oid: X.509 certificate functionsgnutls_x509_crl_get_next_update: X.509 certificate functionsgnutls_x509_crl_get_signature: X.509 certificate functionsgnutls_x509_crl_get_signature_algorithm: X.509 certificate functionsgnutls_x509_crl_get_this_update: X.509 certificate functionsgnutls_x509_crl_get_version: X.509 certificate functionsgnutls_x509_crl_import: X.509 certificate functionsgnutls_x509_crl_init: X.509 certificate functionsgnutls_x509_crl_print: X.509 certificate functionsgnutls_x509_crl_set_crt: X.509 certificate functionsgnutls_x509_crl_set_crt_serial: X.509 certificate functionsgnutls_x509_crl_set_next_update: X.509 certificate functionsgnutls_x509_crl_set_this_update: X.509 certificate functionsgnutls_x509_crl_set_version: X.509 certificate functionsgnutls_x509_crl_sign: X.509 certificate functionsgnutls_x509_crl_sign2: X.509 certificate functionsgnutls_x509_crl_verify: X.509 certificate functionsgnutls_x509_crq_deinit: X.509 certificate functionsgnutls_x509_crq_export: X.509 certificate functionsgnutls_x509_crq_get_attribute_by_oid: X.509 certificate functionsgnutls_x509_crq_get_challenge_password: X.509 certificate functionsgnutls_x509_crq_get_dn: X.509 certificate functionsgnutls_x509_crq_get_dn_by_oid: X.509 certificate functionsgnutls_x509_crq_get_dn_oid: X.509 certificate functionsgnutls_x509_crq_get_pk_algorithm: X.509 certificate functionsgnutls_x509_crq_get_version: X.509 certificate functionsgnutls_x509_crq_import: X.509 certificate functionsgnutls_x509_crq_init: X.509 certificate functionsgnutls_x509_crq_set_attribute_by_oid: X.509 certificate functionsgnutls_x509_crq_set_challenge_password: X.509 certificate functionsgnutls_x509_crq_set_dn_by_oid: X.509 certificate functionsgnutls_x509_crq_set_key: X.509 certificate functionsgnutls_x509_crq_set_version: X.509 certificate functionsgnutls_x509_crq_sign: X.509 certificate functionsgnutls_x509_crq_sign2: X.509 certificate functionsgnutls_x509_crt_check_hostname: X.509 certificate functionsgnutls_x509_crt_check_issuer: X.509 certificate functionsgnutls_x509_crt_check_revocation: X.509 certificate functionsgnutls_x509_crt_cpy_crl_dist_points: X.509 certificate functionsgnutls_x509_crt_deinit: X.509 certificate functionsgnutls_x509_crt_export: X.509 certificate functionsgnutls_x509_crt_get_activation_time: X.509 certificate functionsgnutls_x509_crt_get_authority_key_id: X.509 certificate functionsgnutls_x509_crt_get_basic_constraints: X.509 certificate functionsgnutls_x509_crt_get_ca_status: X.509 certificate functionsgnutls_x509_crt_get_crl_dist_points: X.509 certificate functionsgnutls_x509_crt_get_dn: X.509 certificate functionsgnutls_x509_crt_get_dn_by_oid: X.509 certificate functionsgnutls_x509_crt_get_dn_oid: X.509 certificate functionsgnutls_x509_crt_get_expiration_time: X.509 certificate functionsgnutls_x509_crt_get_extension_by_oid: X.509 certificate functionsgnutls_x509_crt_get_extension_data: X.509 certificate functionsgnutls_x509_crt_get_extension_info: X.509 certificate functionsgnutls_x509_crt_get_extension_oid: X.509 certificate functionsgnutls_x509_crt_get_fingerprint: X.509 certificate functionsgnutls_x509_crt_get_issuer: X.509 certificate functionsgnutls_x509_crt_get_issuer_dn: X.509 certificate functionsgnutls_x509_crt_get_issuer_dn_by_oid: X.509 certificate functionsgnutls_x509_crt_get_issuer_dn_oid: X.509 certificate functionsgnutls_x509_crt_get_key_id: X.509 certificate functionsgnutls_x509_crt_get_key_purpose_oid: X.509 certificate functionsgnutls_x509_crt_get_key_usage: X.509 certificate functionsgnutls_x509_crt_get_pk_algorithm: X.509 certificate functionsgnutls_x509_crt_get_pk_dsa_raw: X.509 certificate functionsgnutls_x509_crt_get_pk_rsa_raw: X.509 certificate functionsgnutls_x509_crt_get_proxy: X.509 certificate functionsgnutls_x509_crt_get_serial: X.509 certificate functionsgnutls_x509_crt_get_signature: X.509 certificate functionsgnutls_x509_crt_get_signature_algorithm: X.509 certificate functionsgnutls_x509_crt_get_subject: X.509 certificate functionsgnutls_x509_crt_get_subject_alt_name: X.509 certificate functionsgnutls_x509_crt_get_subject_alt_othername_oid: X.509 certificate functionsgnutls_x509_crt_get_subject_key_id: X.509 certificate functionsgnutls_x509_crt_get_version: X.509 certificate functionsgnutls_x509_crt_import: X.509 certificate functionsgnutls_x509_crt_init: X.509 certificate functionsgnutls_x509_crt_list_import: X.509 certificate functionsgnutls_x509_crt_list_verify: X.509 certificate functionsgnutls_x509_crt_print: X.509 certificate functionsgnutls_x509_crt_set_activation_time: X.509 certificate functionsgnutls_x509_crt_set_authority_key_id: X.509 certificate functionsgnutls_x509_crt_set_basic_constraints: X.509 certificate functionsgnutls_x509_crt_set_ca_status: X.509 certificate functionsgnutls_x509_crt_set_crl_dist_points: X.509 certificate functionsgnutls_x509_crt_set_crq: X.509 certificate functionsgnutls_x509_crt_set_dn_by_oid: X.509 certificate functionsgnutls_x509_crt_set_expiration_time: X.509 certificate functionsgnutls_x509_crt_set_extension_by_oid: X.509 certificate functionsgnutls_x509_crt_set_issuer_dn_by_oid: X.509 certificate functionsgnutls_x509_crt_set_key: X.509 certificate functionsgnutls_x509_crt_set_key_purpose_oid: X.509 certificate functionsgnutls_x509_crt_set_key_usage: X.509 certificate functionsgnutls_x509_crt_set_proxy: X.509 certificate functionsgnutls_x509_crt_set_proxy_dn: X.509 certificate functionsgnutls_x509_crt_set_serial: X.509 certificate functionsgnutls_x509_crt_set_subject_alternative_name: X.509 certificate functionsgnutls_x509_crt_set_subject_key_id: X.509 certificate functionsgnutls_x509_crt_set_version: X.509 certificate functionsgnutls_x509_crt_sign: X.509 certificate functionsgnutls_x509_crt_sign2: X.509 certificate functionsgnutls_x509_crt_to_xml: X.509 certificate functionsgnutls_x509_crt_verify: X.509 certificate functionsgnutls_x509_crt_verify_data: X.509 certificate functionsgnutls_x509_dn_get_rdn_ava: X.509 certificate functionsgnutls_x509_dn_oid_known: X.509 certificate functionsgnutls_x509_privkey_cpy: X.509 certificate functionsgnutls_x509_privkey_deinit: X.509 certificate functionsgnutls_x509_privkey_export: X.509 certificate functionsgnutls_x509_privkey_export_dsa_raw: X.509 certificate functionsgnutls_x509_privkey_export_pkcs8: X.509 certificate functionsgnutls_x509_privkey_export_rsa_raw: X.509 certificate functionsgnutls_x509_privkey_fix: X.509 certificate functionsgnutls_x509_privkey_generate: X.509 certificate functionsgnutls_x509_privkey_get_key_id: X.509 certificate functionsgnutls_x509_privkey_get_pk_algorithm: X.509 certificate functionsgnutls_x509_privkey_import: X.509 certificate functionsgnutls_x509_privkey_import_dsa_raw: X.509 certificate functionsgnutls_x509_privkey_import_pkcs8: X.509 certificate functionsgnutls_x509_privkey_import_rsa_raw: X.509 certificate functionsgnutls_x509_privkey_init: X.509 certificate functionsgnutls_x509_privkey_sign_data: X.509 certificate functionsgnutls_x509_privkey_verify_data: X.509 certificate functionsgnutls_x509_rdn_get: X.509 certificate functionsgnutls_x509_rdn_get_by_oid: X.509 certificate functionsgnutls_x509_rdn_get_oid: X.509 certificate functions[1] A copy of the license is included in the distribution
[3] ftp://ftp.gnupg.org/gcrypt/alpha/gnutls/libtasn1/
[4] ftp://ftp.gnupg.org/gcrypt/alpha/gnutls/opencdk/
[5] ftp://ftp.gnupg.org/gcrypt/alpha/libgcrypt/
[6] The first message in a TLS handshake
[7] IETF, or Internet Engineering Task Force, is a large open international community of network designers, operators, vendors, and researchers concerned with the evolution of the Internet architecture and the smooth operation of the Internet. It is open to any interested individual.
[8] AES, or Advanced Encryption Standard, is actually the RIJNDAEL algorithm. This is the algorithm that replaced DES.
[9] ARCFOUR_128 is a compatible
algorithm with RSA's RC4 algorithm, which is considered to be a trade
secret.
[10] You should use gnutls_handshake_set_private_extensions to enable private extensions.
[11] MAC stands for Message Authentication Code. It can be described as a keyed hash algorithm. See RFC2104.
[12] It really depends on the group used. Primes with lesser bits are always faster, but also easier to break. Values less than 768 should not be used today
[13] SRP is described in [RFC2945] (see Bibliography)
[14] See also the Server Name Indication extension on serverind.
[15] See LDAP, IMAP etc.
[16] in SRP authentication
[17] such as the gnutls_certificate_credentials_t structures