summaryrefslogtreecommitdiff
path: root/lib/x509
diff options
context:
space:
mode:
authorNikos Mavrogiannopoulos <nmav@gnutls.org>2012-01-09 21:03:47 +0100
committerNikos Mavrogiannopoulos <nmav@gnutls.org>2012-01-09 21:03:47 +0100
commitf773453757b61bae4a1a76ff413e1525d0aff630 (patch)
tree8a4376c5ab929da35ff4a4eff4908165f00fdbd6 /lib/x509
parent204f8b3dbf658bdbc418227d14e400725d2646e5 (diff)
downloadgnutls-f773453757b61bae4a1a76ff413e1525d0aff630.tar.gz
updated descriptions
Diffstat (limited to 'lib/x509')
-rw-r--r--lib/x509/x509.c31
1 files changed, 22 insertions, 9 deletions
diff --git a/lib/x509/x509.c b/lib/x509/x509.c
index 37f5a8cc2d..9ed1764871 100644
--- a/lib/x509/x509.c
+++ b/lib/x509/x509.c
@@ -1,6 +1,5 @@
/*
- * Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011 Free
- * Software Foundation, Inc.
+ * Copyright (C) 2003-2012 Free Software Foundation, Inc.
* Author: Nikos Mavrogiannopoulos, Simon Josefsson, Howard Chu
*
* This file is part of GnuTLS.
@@ -334,7 +333,9 @@ gnutls_x509_crt_get_issuer_dn_by_oid (gnutls_x509_crt_t cert,
* This function will extract the OIDs of the name of the Certificate
* issuer specified by the given index.
*
- * If @oid is null then only the size will be filled.
+ * If @oid is null then only the size will be filled. The @oid
+ * returned will be null terminated, although @oid_size will not
+ * account for the trailing null.
*
* Returns: GNUTLS_E_SHORT_MEMORY_BUFFER if the provided buffer is not
* long enough, and in that case the @oid_size will be updated
@@ -441,7 +442,9 @@ gnutls_x509_crt_get_dn_by_oid (gnutls_x509_crt_t cert, const char *oid,
* This 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.
+ * If @oid is null then only the size will be filled. The @oid
+ * returned will be null terminated, although @oid_size will not
+ * account for the trailing null.
*
* Returns: %GNUTLS_E_SHORT_MEMORY_BUFFER if the provided buffer is
* not long enough, and in that case the @oid_size will be updated
@@ -1328,7 +1331,9 @@ gnutls_x509_crt_get_issuer_alt_name2 (gnutls_x509_crt_t cert,
* gnutls_x509_crt_get_subject_alt_name() returned
* %GNUTLS_SAN_OTHERNAME.
*
- * If @oid is null then only the size will be filled.
+ * If @oid is null then only the size will be filled. The @oid
+ * returned will be null terminated, although @oid_size will not
+ * account for the trailing null.
*
* Returns: the alternative subject name type on success, one of the
* enumerated gnutls_x509_subject_alt_name_t. For supported OIDs, it
@@ -1360,7 +1365,9 @@ gnutls_x509_crt_get_subject_alt_othername_oid (gnutls_x509_crt_t cert,
* Alternative Name, contained in the given certificate, and return
* the type as an enumerated element.
*
- * If @oid is null then only the size will be filled.
+ * If @oid is null then only the size will be filled. The @oid
+ * returned will be null terminated, although @oid_size will not
+ * account for the trailing null.
*
* This function is only useful if
* gnutls_x509_crt_get_issuer_alt_name() returned
@@ -1678,6 +1685,9 @@ gnutls_x509_crt_get_extension_by_oid (gnutls_x509_crt_t cert,
* This function will return the requested extension OID in the certificate.
* The extension OID will be stored as a string in the provided buffer.
*
+ * The @oid returned will be null terminated, although @oid_size will not
+ * account for the trailing null.
+ *
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned,
* otherwise a negative error code is returned. If you have reached the
* last extension available %GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE
@@ -1720,8 +1730,9 @@ gnutls_x509_crt_get_extension_oid (gnutls_x509_crt_t cert, int indx,
* gnutls_x509_crt_get_extension_data() to extract the data.
*
* If the buffer provided is not long enough to hold the output, then
- * *@oid_size is updated and %GNUTLS_E_SHORT_MEMORY_BUFFER will be
- * returned.
+ * @oid_size is updated and %GNUTLS_E_SHORT_MEMORY_BUFFER will be
+ * returned. The @oid returned will be null terminated, although
+ * @oid_size will not account for the trailing null.
*
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned,
* otherwise a negative error code is returned. If you have reached the
@@ -2707,7 +2718,9 @@ gnutls_x509_crt_get_crl_dist_points (gnutls_x509_crt_t cert,
* Usage extension (2.5.29.37) See the GNUTLS_KP_* definitions for
* human readable names.
*
- * If @oid is null then only the size will be filled.
+ * If @oid is null then only the size will be filled. The @oid
+ * returned will be null terminated, although @oid_size will not
+ * account for the trailing null.
*
* Returns: %GNUTLS_E_SHORT_MEMORY_BUFFER if the provided buffer is
* not long enough, and in that case the *oid_size will be updated