diff options
| author | Nikos Mavrogiannopoulos <nmav@gnutls.org> | 2019-04-14 16:15:23 +0200 |
|---|---|---|
| committer | Nikos Mavrogiannopoulos <nmav@gnutls.org> | 2019-04-14 16:16:23 +0200 |
| commit | 6e7b589068f9c5e3b73fa704ebf1eb6b91a5b074 (patch) | |
| tree | d7970eeabc3686107be679069436449df74ebed2 | |
| parent | ac4123e416d2a29eaec9e7ea8ac0d984f23dcf9c (diff) | |
| download | gnutls-6e7b589068f9c5e3b73fa704ebf1eb6b91a5b074.tar.gz | |
doc: mark TLS1.2 functions as such [ci skip]
gnutls_cipher_suite_get_name and gnutls_session_get_master_secret
are marked as TLS1.2 or earlier-only as they cannot be used with
TLS 1.3.
Signed-off-by: Nikos Mavrogiannopoulos <nmav@gnutls.org>
| -rw-r--r-- | lib/algorithms/ciphersuites.c | 11 | ||||
| -rw-r--r-- | lib/state.c | 2 |
2 files changed, 10 insertions, 3 deletions
diff --git a/lib/algorithms/ciphersuites.c b/lib/algorithms/ciphersuites.c index eaee253679..0c393af044 100644 --- a/lib/algorithms/ciphersuites.c +++ b/lib/algorithms/ciphersuites.c @@ -1297,8 +1297,12 @@ check_server_dh_params(gnutls_session_t session, * @cipher_algorithm: is a cipher algorithm * @mac_algorithm: is a MAC algorithm * - * Note that the full cipher suite name must be prepended by TLS or - * SSL depending of the protocol in use. + * This function returns the ciphersuite name under TLS1.2 or earlier + * versions when provided with individual algorithms. The full cipher suite + * name must be prepended by TLS or SSL depending of the protocol in use. + * + * To get a description of the current ciphersuite across versions, it + * is recommended to use gnutls_session_get_desc(). * * Returns: a string that contains the name of a TLS cipher suite, * specified by the given algorithms, or %NULL. @@ -1327,7 +1331,8 @@ const char *gnutls_cipher_suite_get_name(gnutls_kx_algorithm_t * @mac_algorithm: is a MAC algorithm * @suite: The id to be returned * - * It fills @suite with the ID of the ciphersuite of the provided parameters. + * This function returns the ciphersuite ID in @suite, under TLS1.2 or earlier + * versions when provided with individual algorithms. * * Returns: 0 on success or a negative error code otherwise. -*/ diff --git a/lib/state.c b/lib/state.c index db3262d52c..fe40bd980a 100644 --- a/lib/state.c +++ b/lib/state.c @@ -1314,6 +1314,8 @@ gnutls_session_get_random(gnutls_session_t session, * This function returns pointers to the master secret * used in the TLS session. The pointers are not to be modified or deallocated. * + * This function is only applicable under TLS 1.2 or earlier versions. + * * Since: 3.5.0 **/ void |