documented the way set_subject_alt_name() can set value.

diff --git a/lib/x509/x509_write.c b/lib/x509/x509_write.c
index f055560cf092bed932a2eb23533bf1a07d874429..e0c58be914386c55a53e03bbdb11b1d6b3be2c82 100644 (file)
--- a/lib/x509/x509_write.c
+++ b/lib/x509/x509_write.c
@@ -498,7 +498,17 @@ gnutls_x509_crt_set_subject_alternative_name (gnutls_x509_crt_t crt,
  * @flags: GNUTLS_FSAN_SET to clear previous data or GNUTLS_FSAN_APPEND to append. 
  *
  * This function will set the subject alternative name certificate
- * extension.
+ * extension. It can set the following types:
+ *
+ * &GNUTLS_SAN_DNSNAME: as a text string
+ *
+ * &GNUTLS_SAN_RFC822NAME: as a text string
+ *
+ * &GNUTLS_SAN_URI: as a text string
+ *
+ * &GNUTLS_SAN_IPADDRESS: as a binary IP address (4 or 16 bytes)
+ * 
+ * Other values can be set as binary values with the proper DER encoding.
  *
  * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
  *   negative error value.