diff options
Diffstat (limited to 'doc/doxyout/hx509/man/man3/hx509_ca.3')
| -rw-r--r-- | doc/doxyout/hx509/man/man3/hx509_ca.3 | 106 |
1 files changed, 53 insertions, 53 deletions
diff --git a/doc/doxyout/hx509/man/man3/hx509_ca.3 b/doc/doxyout/hx509/man/man3/hx509_ca.3 index 826807307a1f..326dc075a51c 100644 --- a/doc/doxyout/hx509/man/man3/hx509_ca.3 +++ b/doc/doxyout/hx509/man/man3/hx509_ca.3 @@ -1,8 +1,8 @@ -.TH "hx509_ca" 3 "Fri Jun 7 2019" "Version 7.7.0" "Heimdalx509library" \" -*- nroff -*- +.TH "hx509_ca" 3 "Tue Nov 15 2022" "Version 7.8.0" "Heimdal x509 library" \" -*- nroff -*- .ad l .nh .SH NAME -hx509_ca +hx509_ca \- hx509 CA functions .SH SYNOPSIS .br .PP @@ -109,7 +109,7 @@ When done the to-be-signed certificate object should be freed with \fBhx509_ca_t .PP When creating self-signed certificate use \fBhx509_ca_sign_self()\fP instead\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP A hx509 context\&. .br @@ -120,7 +120,7 @@ When creating self-signed certificate use \fBhx509_ca_sign_self()\fP instead\&. \fIcertificate\fP return cerificate, free with \fBhx509_cert_free()\fP\&. .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 An hx509 error code, see \fBhx509_get_error_string()\fP\&. .RE @@ -129,7 +129,7 @@ An hx509 error code, see \fBhx509_get_error_string()\fP\&. .SS "int hx509_ca_sign_self (hx509_context context, hx509_ca_tbs tbs, hx509_private_key signer, hx509_cert * certificate)" Work just like \fBhx509_ca_sign()\fP but signs it-self\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP A hx509 context\&. .br @@ -140,7 +140,7 @@ Work just like \fBhx509_ca_sign()\fP but signs it-self\&. \fIcertificate\fP return cerificate, free with \fBhx509_cert_free()\fP\&. .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 An hx509 error code, see \fBhx509_get_error_string()\fP\&. .RE @@ -149,7 +149,7 @@ An hx509 error code, see \fBhx509_get_error_string()\fP\&. .SS "int hx509_ca_tbs_add_crl_dp_uri (hx509_context context, hx509_ca_tbs tbs, const char * uri, hx509_name issuername)" Add CRL distribution point URI to the to-be-signed certificate object\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP A hx509 context\&. .br @@ -160,7 +160,7 @@ Add CRL distribution point URI to the to-be-signed certificate object\&. \fIissuername\fP name of the issuer\&. .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 An hx509 error code, see \fBhx509_get_error_string()\fP\&. .RE @@ -169,7 +169,7 @@ issuername not supported .SS "int hx509_ca_tbs_add_eku (hx509_context context, hx509_ca_tbs tbs, const heim_oid * oid)" An an extended key usage to the to-be-signed certificate object\&. Duplicates will detected and not added\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP A hx509 context\&. .br @@ -178,7 +178,7 @@ An an extended key usage to the to-be-signed certificate object\&. Duplicates wi \fIoid\fP extended key usage to add\&. .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 An hx509 error code, see \fBhx509_get_error_string()\fP\&. .RE @@ -189,7 +189,7 @@ Add a Subject Alternative Name hostname to to-be-signed certificate object\&. A .PP Example of a an domain match: \&.domain\&.se matches the hostname host\&.domain\&.se\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP A hx509 context\&. .br @@ -198,7 +198,7 @@ Example of a an domain match: \&.domain\&.se matches the hostname host\&.domain\ \fIdnsname\fP a hostame\&. .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 An hx509 error code, see \fBhx509_get_error_string()\fP\&. .RE @@ -207,7 +207,7 @@ An hx509 error code, see \fBhx509_get_error_string()\fP\&. .SS "int hx509_ca_tbs_add_san_jid (hx509_context context, hx509_ca_tbs tbs, const char * jid)" Add a Jabber/XMPP jid Subject Alternative Name to the to-be-signed certificate object\&. The jid is an UTF8 string\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP A hx509 context\&. .br @@ -216,7 +216,7 @@ Add a Jabber/XMPP jid Subject Alternative Name to the to-be-signed certificate o \fIjid\fP string of an a jabber id in UTF8\&. .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 An hx509 error code, see \fBhx509_get_error_string()\fP\&. .RE @@ -225,7 +225,7 @@ An hx509 error code, see \fBhx509_get_error_string()\fP\&. .SS "int hx509_ca_tbs_add_san_ms_upn (hx509_context context, hx509_ca_tbs tbs, const char * principal)" Add Microsoft UPN Subject Alternative Name to the to-be-signed certificate object\&. The principal string is a UTF8 string\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP A hx509 context\&. .br @@ -234,7 +234,7 @@ Add Microsoft UPN Subject Alternative Name to the to-be-signed certificate objec \fIprincipal\fP Microsoft UPN string\&. .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 An hx509 error code, see \fBhx509_get_error_string()\fP\&. .RE @@ -243,7 +243,7 @@ An hx509 error code, see \fBhx509_get_error_string()\fP\&. .SS "int hx509_ca_tbs_add_san_otherName (hx509_context context, hx509_ca_tbs tbs, const heim_oid * oid, const heim_octet_string * os)" Add Subject Alternative Name otherName to the to-be-signed certificate object\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP A hx509 context\&. .br @@ -254,7 +254,7 @@ Add Subject Alternative Name otherName to the to-be-signed certificate object\&. \fIos\fP data in the other name\&. .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 An hx509 error code, see \fBhx509_get_error_string()\fP\&. .RE @@ -263,7 +263,7 @@ An hx509 error code, see \fBhx509_get_error_string()\fP\&. .SS "int hx509_ca_tbs_add_san_pkinit (hx509_context context, hx509_ca_tbs tbs, const char * principal)" Add Kerberos Subject Alternative Name to the to-be-signed certificate object\&. The principal string is a UTF8 string\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP A hx509 context\&. .br @@ -272,7 +272,7 @@ Add Kerberos Subject Alternative Name to the to-be-signed certificate object\&. \fIprincipal\fP Kerberos principal to add to the certificate\&. .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 An hx509 error code, see \fBhx509_get_error_string()\fP\&. .RE @@ -281,7 +281,7 @@ An hx509 error code, see \fBhx509_get_error_string()\fP\&. .SS "int hx509_ca_tbs_add_san_rfc822name (hx509_context context, hx509_ca_tbs tbs, const char * rfc822Name)" Add a Subject Alternative Name rfc822 (email address) to to-be-signed certificate object\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP A hx509 context\&. .br @@ -290,7 +290,7 @@ Add a Subject Alternative Name rfc822 (email address) to to-be-signed certificat \fIrfc822Name\fP a string to a email address\&. .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 An hx509 error code, see \fBhx509_get_error_string()\fP\&. .RE @@ -299,7 +299,7 @@ An hx509 error code, see \fBhx509_get_error_string()\fP\&. .SS "void hx509_ca_tbs_free (hx509_ca_tbs * tbs)" Free an To Be Signed object\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fItbs\fP object to free\&. .RE @@ -308,14 +308,14 @@ Free an To Be Signed object\&. .SS "int hx509_ca_tbs_init (hx509_context context, hx509_ca_tbs * tbs)" Allocate an to-be-signed certificate object that will be converted into an certificate\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP A hx509 context\&. .br \fItbs\fP returned to-be-signed certicate object, free with \fBhx509_ca_tbs_free()\fP\&. .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 An hx509 error code, see \fBhx509_get_error_string()\fP\&. .RE @@ -324,7 +324,7 @@ An hx509 error code, see \fBhx509_get_error_string()\fP\&. .SS "int hx509_ca_tbs_set_ca (hx509_context context, hx509_ca_tbs tbs, int pathLenConstraint)" Make the to-be-signed certificate object a CA certificate\&. If the pathLenConstraint is negative path length constraint is used\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP A hx509 context\&. .br @@ -333,7 +333,7 @@ Make the to-be-signed certificate object a CA certificate\&. If the pathLenConst \fIpathLenConstraint\fP path length constraint, negative, no constraint\&. .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 An hx509 error code, see \fBhx509_get_error_string()\fP\&. .RE @@ -342,14 +342,14 @@ An hx509 error code, see \fBhx509_get_error_string()\fP\&. .SS "int hx509_ca_tbs_set_domaincontroller (hx509_context context, hx509_ca_tbs tbs)" Make the to-be-signed certificate object a windows domain controller certificate\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP A hx509 context\&. .br \fItbs\fP object to be signed\&. .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 An hx509 error code, see \fBhx509_get_error_string()\fP\&. .RE @@ -358,7 +358,7 @@ An hx509 error code, see \fBhx509_get_error_string()\fP\&. .SS "int hx509_ca_tbs_set_notAfter (hx509_context context, hx509_ca_tbs tbs, time_t t)" Set the absolute time when the certificate is valid to\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP A hx509 context\&. .br @@ -367,7 +367,7 @@ Set the absolute time when the certificate is valid to\&. \fIt\fP time when the certificate will expire .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 An hx509 error code, see \fBhx509_get_error_string()\fP\&. .RE @@ -376,7 +376,7 @@ An hx509 error code, see \fBhx509_get_error_string()\fP\&. .SS "int hx509_ca_tbs_set_notAfter_lifetime (hx509_context context, hx509_ca_tbs tbs, time_t delta)" Set the relative time when the certificiate is going to expire\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP A hx509 context\&. .br @@ -385,7 +385,7 @@ Set the relative time when the certificiate is going to expire\&. \fIdelta\fP seconds to the certificate is going to expire\&. .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 An hx509 error code, see \fBhx509_get_error_string()\fP\&. .RE @@ -394,7 +394,7 @@ An hx509 error code, see \fBhx509_get_error_string()\fP\&. .SS "int hx509_ca_tbs_set_notBefore (hx509_context context, hx509_ca_tbs tbs, time_t t)" Set the absolute time when the certificate is valid from\&. If not set the current time will be used\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP A hx509 context\&. .br @@ -403,7 +403,7 @@ Set the absolute time when the certificate is valid from\&. If not set the curre \fIt\fP time the certificated will start to be valid .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 An hx509 error code, see \fBhx509_get_error_string()\fP\&. .RE @@ -412,7 +412,7 @@ An hx509 error code, see \fBhx509_get_error_string()\fP\&. .SS "int hx509_ca_tbs_set_proxy (hx509_context context, hx509_ca_tbs tbs, int pathLenConstraint)" Make the to-be-signed certificate object a proxy certificate\&. If the pathLenConstraint is negative path length constraint is used\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP A hx509 context\&. .br @@ -421,7 +421,7 @@ Make the to-be-signed certificate object a proxy certificate\&. If the pathLenCo \fIpathLenConstraint\fP path length constraint, negative, no constraint\&. .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 An hx509 error code, see \fBhx509_get_error_string()\fP\&. .RE @@ -430,7 +430,7 @@ An hx509 error code, see \fBhx509_get_error_string()\fP\&. .SS "int hx509_ca_tbs_set_serialnumber (hx509_context context, hx509_ca_tbs tbs, const heim_integer * serialNumber)" Set the serial number to use for to-be-signed certificate object\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP A hx509 context\&. .br @@ -439,7 +439,7 @@ Set the serial number to use for to-be-signed certificate object\&. \fIserialNumber\fP serial number to use for the to-be-signed certificate object\&. .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 An hx509 error code, see \fBhx509_get_error_string()\fP\&. .RE @@ -448,7 +448,7 @@ An hx509 error code, see \fBhx509_get_error_string()\fP\&. .SS "int hx509_ca_tbs_set_signature_algorithm (hx509_context context, hx509_ca_tbs tbs, const AlgorithmIdentifier * sigalg)" Set signature algorithm on the to be signed certificate .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP A hx509 context\&. .br @@ -457,7 +457,7 @@ Set signature algorithm on the to be signed certificate \fIsigalg\fP signature algorithm to use .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 An hx509 error code, see \fBhx509_get_error_string()\fP\&. .RE @@ -466,7 +466,7 @@ An hx509 error code, see \fBhx509_get_error_string()\fP\&. .SS "int hx509_ca_tbs_set_spki (hx509_context context, hx509_ca_tbs tbs, const SubjectPublicKeyInfo * spki)" Set the subject public key info (SPKI) in the to-be-signed certificate object\&. SPKI is the public key and key related parameters in the certificate\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP A hx509 context\&. .br @@ -475,7 +475,7 @@ Set the subject public key info (SPKI) in the to-be-signed certificate object\&. \fIspki\fP subject public key info to use for the to-be-signed certificate object\&. .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 An hx509 error code, see \fBhx509_get_error_string()\fP\&. .RE @@ -484,7 +484,7 @@ An hx509 error code, see \fBhx509_get_error_string()\fP\&. .SS "int hx509_ca_tbs_set_subject (hx509_context context, hx509_ca_tbs tbs, hx509_name subject)" Set the subject name of a to-be-signed certificate object\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP A hx509 context\&. .br @@ -493,7 +493,7 @@ Set the subject name of a to-be-signed certificate object\&. \fIsubject\fP the name to set a subject\&. .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 An hx509 error code, see \fBhx509_get_error_string()\fP\&. .RE @@ -502,7 +502,7 @@ An hx509 error code, see \fBhx509_get_error_string()\fP\&. .SS "int hx509_ca_tbs_set_template (hx509_context context, hx509_ca_tbs tbs, int flags, hx509_cert cert)" Initialize the to-be-signed certificate object from a template certifiate\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP A hx509 context\&. .br @@ -513,7 +513,7 @@ Initialize the to-be-signed certificate object from a template certifiate\&. \fIcert\fP template certificate\&. .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 An hx509 error code, see \fBhx509_get_error_string()\fP\&. .RE @@ -524,7 +524,7 @@ Set the issuerUniqueID and subjectUniqueID .PP These are only supposed to be used considered with version 2 certificates, replaced by the two extensions SubjectKeyIdentifier and IssuerKeyIdentifier\&. This function is to allow application using legacy protocol to issue them\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP A hx509 context\&. .br @@ -535,7 +535,7 @@ These are only supposed to be used considered with version 2 certificates, repla \fIsubjectUniqueID\fP to be set .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 An hx509 error code, see \fBhx509_get_error_string()\fP\&. .RE @@ -544,7 +544,7 @@ An hx509 error code, see \fBhx509_get_error_string()\fP\&. .SS "int hx509_ca_tbs_subject_expand (hx509_context context, hx509_ca_tbs tbs, hx509_env env)" Expand the the subject name in the to-be-signed certificate object using \fBhx509_name_expand()\fP\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP A hx509 context\&. .br @@ -553,7 +553,7 @@ Expand the the subject name in the to-be-signed certificate object using \fBhx50 \fIenv\fP environment variable to expand variables in the subject name, see hx509_env_init()\&. .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 An hx509 error code, see \fBhx509_get_error_string()\fP\&. .RE @@ -562,7 +562,7 @@ An hx509 error code, see \fBhx509_get_error_string()\fP\&. .SS "const struct units* hx509_ca_tbs_template_units (void)" Make of template units, use to build flags argument to \fBhx509_ca_tbs_set_template()\fP with parse_units()\&. .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 an units structure\&. .RE @@ -570,4 +570,4 @@ an units structure\&. .SH "Author" .PP -Generated automatically by Doxygen for Heimdalx509library from the source code\&. +Generated automatically by Doxygen for Heimdal x509 library from the source code\&. |