diff options
author | Nikos Mavrogiannopoulos <nmav@redhat.com> | 2017-10-16 11:41:36 +0200 |
---|---|---|
committer | Nikos Mavrogiannopoulos <nmav@redhat.com> | 2017-10-16 13:48:05 +0200 |
commit | 8cd407fcd94de9b4b36123c0cb8ea4ffd2f77748 (patch) | |
tree | 8f9259a4acc82011729cae93b9ae87d8dbeda538 | |
parent | f22d71174da738029b4e1ef0d0e1d0efb52876c7 (diff) | |
download | gnutls-8cd407fcd94de9b4b36123c0cb8ea4ffd2f77748.tar.gz |
doc update [ci skip]
Signed-off-by: Nikos Mavrogiannopoulos <nmav@redhat.com>
-rw-r--r-- | lib/cert.c | 4 | ||||
-rw-r--r-- | lib/ext/status_request.c | 20 |
2 files changed, 16 insertions, 8 deletions
diff --git a/lib/cert.c b/lib/cert.c index 8bd2183f5b..cd2d16d28d 100644 --- a/lib/cert.c +++ b/lib/cert.c @@ -390,7 +390,7 @@ gnutls_certificate_server_set_request(gnutls_session_t session, * by one of these CAs. These names, when available, are DER encoded. To get a more * meaningful value use the function gnutls_x509_rdn_get(). * - * @pk_algos contains a list with server's acceptable signature algorithms. + * @pk_algos contains a list with server's acceptable public key algorithms. * The certificate returned should support the server's given algorithms. * * @st should contain the certificates and private keys. @@ -436,7 +436,7 @@ void gnutls_certificate_set_retrieve_function * by one of these CAs. These names, when available, are DER encoded. To get a more * meaningful value use the function gnutls_x509_rdn_get(). * - * @pk_algos contains a list with server's acceptable signature algorithms. + * @pk_algos contains a list with server's acceptable public key algorithms. * The certificate returned should support the server's given algorithms. * * @pcert should contain a single certificate and public key or a list of them. diff --git a/lib/ext/status_request.c b/lib/ext/status_request.c index 699abb03f0..ef18bcde94 100644 --- a/lib/ext/status_request.c +++ b/lib/ext/status_request.c @@ -428,7 +428,7 @@ gnutls_status_request_ocsp_func ocsp_func, void *ptr) * @ptr: opaque pointer passed to callback function * * This function is to be used by server to register a callback to - * handle OCSP status requests that correspond to the indexed certificate + * provide OCSP status requests that correspond to the indexed certificate chain * from the client. The callback will be invoked if the client supplied a * status-request OCSP extension. * @@ -444,6 +444,12 @@ gnutls_status_request_ocsp_func ocsp_func, void *ptr) * OCSP response. The response must be a value allocated using gnutls_malloc(), * and will be deinitialized by the caller. * + * Note: the ability to set multiple OCSP responses per credential + * structure via the index @idx was added in version 3.5.6. To keep + * backwards compatibility, it requires using gnutls_certificate_set_flags() + * with the %GNUTLS_CERTIFICATE_API_V2 flag to make the set certificate + * functions return an index usable by this function. + * * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, * otherwise a negative error code is returned. * @@ -491,8 +497,10 @@ static int file_ocsp_func(gnutls_session_t session, void *ptr, * file accesses. * * Note: the ability to set multiple OCSP responses per credential - * structure via @idx was added in version 3.5.6 with the - * %GNUTLS_CERTIFICATE_API_V2 flag. + * structure via the index @idx was added in version 3.5.6. To keep + * backwards compatibility, it requires using gnutls_certificate_set_flags() + * with the %GNUTLS_CERTIFICATE_API_V2 flag to make the set certificate + * functions return an index usable by this function. * * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, * otherwise a negative error code is returned. @@ -500,9 +508,9 @@ static int file_ocsp_func(gnutls_session_t session, void *ptr, * Since: 3.1.3 **/ int -gnutls_certificate_set_ocsp_status_request_file -(gnutls_certificate_credentials_t sc, const char *response_file, - unsigned idx) +gnutls_certificate_set_ocsp_status_request_file(gnutls_certificate_credentials_t sc, + const char *response_file, + unsigned idx) { if (idx >= sc->ncerts) return gnutls_assert_val(GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE); |