diff options
Diffstat (limited to 'secure/lib/libcrypto/man/man3/X509_get_subject_name.3')
| -rw-r--r-- | secure/lib/libcrypto/man/man3/X509_get_subject_name.3 | 194 |
1 files changed, 88 insertions, 106 deletions
diff --git a/secure/lib/libcrypto/man/man3/X509_get_subject_name.3 b/secure/lib/libcrypto/man/man3/X509_get_subject_name.3 index db23aec658ec..cd3f99cfc118 100644 --- a/secure/lib/libcrypto/man/man3/X509_get_subject_name.3 +++ b/secure/lib/libcrypto/man/man3/X509_get_subject_name.3 @@ -1,4 +1,5 @@ -.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) .\" .\" Standard preamble: .\" ======================================================================== @@ -15,29 +16,12 @@ .ft R .fi .. -.\" Set up some character translations and predefined strings. \*(-- will -.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left -.\" double quote, and \*(R" will give a right double quote. \*(C+ will -.\" give a nicer C++. Capital omega is used to do unbreakable dashes and -.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, -.\" nothing in troff, for use with C<>. -.tr \(*W- -.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ -. ds -- \(*W- -. ds PI pi -. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch -. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch -. ds L" "" -. ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ -. ds -- \|\(em\| -. ds PI \(*p -. ds L" `` -. ds R" '' . ds C` . ds C' 'br\} @@ -68,118 +52,111 @@ . \} .\} .rr rF -.\" -.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). -.\" Fear. Run. Save yourself. No user-serviceable parts. -. \" fudge factors for nroff and troff -.if n \{\ -. ds #H 0 -. ds #V .8m -. ds #F .3m -. ds #[ \f1 -. ds #] \fP -.\} -.if t \{\ -. ds #H ((1u-(\\\\n(.fu%2u))*.13m) -. ds #V .6m -. ds #F 0 -. ds #[ \& -. ds #] \& -.\} -. \" simple accents for nroff and troff -.if n \{\ -. ds ' \& -. ds ` \& -. ds ^ \& -. ds , \& -. ds ~ ~ -. ds / -.\} -.if t \{\ -. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" -. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' -. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' -. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' -. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' -. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' -.\} -. \" troff and (daisy-wheel) nroff accents -.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' -.ds 8 \h'\*(#H'\(*b\h'-\*(#H' -.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] -.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' -.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' -.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] -.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] -.ds ae a\h'-(\w'a'u*4/10)'e -.ds Ae A\h'-(\w'A'u*4/10)'E -. \" corrections for vroff -.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' -.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' -. \" for low resolution devices (crt and lpr) -.if \n(.H>23 .if \n(.V>19 \ -\{\ -. ds : e -. ds 8 ss -. ds o a -. ds d- d\h'-1'\(ga -. ds D- D\h'-1'\(hy -. ds th \o'bp' -. ds Th \o'LP' -. ds ae ae -. ds Ae AE -.\} -.rm #[ #] #H #V #F C .\" ======================================================================== .\" -.IX Title "X509_GET_SUBJECT_NAME 3" -.TH X509_GET_SUBJECT_NAME 3 "2022-05-03" "1.1.1o" "OpenSSL" +.IX Title "X509_GET_SUBJECT_NAME 3ossl" +.TH X509_GET_SUBJECT_NAME 3ossl 2025-09-30 3.5.4 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh -.SH "NAME" -X509_get_subject_name, X509_set_subject_name, X509_get_issuer_name, X509_set_issuer_name, X509_REQ_get_subject_name, X509_REQ_set_subject_name, X509_CRL_get_issuer, X509_CRL_set_issuer_name \- get and set issuer or subject names -.SH "SYNOPSIS" +.SH NAME +X509_NAME_hash_ex, X509_NAME_hash, +X509_get_subject_name, X509_set_subject_name, X509_subject_name_hash, +X509_get_issuer_name, X509_set_issuer_name, X509_issuer_name_hash, +X509_REQ_get_subject_name, X509_REQ_set_subject_name, +X509_ACERT_get0_issuerName, X509_ACERT_set1_issuerName, +X509_CRL_get_issuer, X509_CRL_set_issuer_name \- +get X509_NAME hashes or get and set issuer or subject names +.SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 1 \& #include <openssl/x509.h> \& +\& unsigned long X509_NAME_hash_ex(const X509_NAME *x, OSSL_LIB_CTX *libctx, +\& const char *propq, int *ok); +\& \& X509_NAME *X509_get_subject_name(const X509 *x); -\& int X509_set_subject_name(X509 *x, X509_NAME *name); +\& int X509_set_subject_name(X509 *x, const X509_NAME *name); +\& unsigned long X509_subject_name_hash(X509 *x); \& \& X509_NAME *X509_get_issuer_name(const X509 *x); -\& int X509_set_issuer_name(X509 *x, X509_NAME *name); +\& int X509_set_issuer_name(X509 *x, const X509_NAME *name); +\& unsigned long X509_issuer_name_hash(X509 *x); \& \& X509_NAME *X509_REQ_get_subject_name(const X509_REQ *req); -\& int X509_REQ_set_subject_name(X509_REQ *req, X509_NAME *name); +\& int X509_REQ_set_subject_name(X509_REQ *req, const X509_NAME *name); \& \& X509_NAME *X509_CRL_get_issuer(const X509_CRL *crl); -\& int X509_CRL_set_issuer_name(X509_CRL *x, X509_NAME *name); +\& int X509_CRL_set_issuer_name(X509_CRL *x, const X509_NAME *name); +\& +\& #include <openssl/x509_acert.h> +\& +\& X509_NAME *X509_ACERT_get0_issuerName(const X509_ACERT *x); +\& int X509_ACERT_set1_issuerName(X509_ACERT *x, const X509_NAME *name); +.Ve +.PP +The following macro has been deprecated since OpenSSL 3.0, and can be +hidden entirely by defining \fBOPENSSL_API_COMPAT\fR with a suitable version value, +see \fBopenssl_user_macros\fR\|(7): +.PP +.Vb 1 +\& #define X509_NAME_hash(x) X509_NAME_hash_ex(x, NULL, NULL, NULL) .Ve -.SH "DESCRIPTION" +.SH DESCRIPTION .IX Header "DESCRIPTION" -\&\fBX509_get_subject_name()\fR returns the subject name of certificate \fBx\fR. The -returned value is an internal pointer which \fB\s-1MUST NOT\s0\fR be freed. +\&\fBX509_NAME_hash_ex()\fR returns a hash value of name \fIx\fR or 0 on failure, +using any given library context \fIlibctx\fR and property query \fIpropq\fR. +The \fIok\fR result argument may be NULL +or else is used to return 1 for success and 0 for failure. +Failure may happen on malloc error or if no SHA1 implementation is available. +.PP +\&\fBX509_NAME_hash()\fR returns a hash value of name \fIx\fR or 0 on failure, +using the default library context and default property query. +.PP +\&\fBX509_get_subject_name()\fR returns the subject name of certificate \fIx\fR. The +returned value is an internal pointer which \fBMUST NOT\fR be freed. \fIx\fR \fBMUST NOT\fR be NULL. .PP -\&\fBX509_set_subject_name()\fR sets the issuer name of certificate \fBx\fR to -\&\fBname\fR. The \fBname\fR parameter is copied internally and should be freed +\&\fBX509_set_subject_name()\fR sets the issuer name of certificate \fIx\fR to +\&\fIname\fR. The \fIname\fR parameter is copied internally and should be freed up when it is no longer needed. .PP -\&\fBX509_get_issuer_name()\fR and \fBX509_set_issuer_name()\fR are identical to -\&\fBX509_get_subject_name()\fR and \fBX509_set_subject_name()\fR except the get and -set the issuer name of \fBx\fR. +\&\fBX509_subject_name_hash()\fR returns a hash value of the subject name of +certificate \fIx\fR. +.PP +\&\fBX509_get_issuer_name()\fR, \fBX509_set_issuer_name()\fR, and \fBX509_issuer_name_hash()\fR +are identical to +\&\fBX509_get_subject_name()\fR, \fBX509_set_subject_name()\fR, and \fBX509_subject_name_hash()\fR +except they relate to the issuer name of \fIx\fR. .PP Similarly \fBX509_REQ_get_subject_name()\fR, \fBX509_REQ_set_subject_name()\fR, +\&\fBX509_ACERT_get0_issuerName()\fR, \fBX509_ACERT_set1_issuerName()\fR, \&\fBX509_CRL_get_issuer()\fR and \fBX509_CRL_set_issuer_name()\fR get or set the subject or issuer names of certificate requests of CRLs respectively. +.PP +Since attribute certificates do not have a subject name, only the issuer name +can be set. For details on setting X509_ACERT holder identities, see +\&\fBX509_ACERT_set0_holder_entityName\fR\|(3). .SH "RETURN VALUES" .IX Header "RETURN VALUES" \&\fBX509_get_subject_name()\fR, \fBX509_get_issuer_name()\fR, \fBX509_REQ_get_subject_name()\fR -and \fBX509_CRL_get_issuer()\fR return an \fBX509_NAME\fR pointer. +\&\fBX509_ACERT_get0_issuerName()\fR and \fBX509_CRL_get_issuer()\fR return +an \fBX509_NAME\fR pointer. +.PP +\&\fBX509_NAME_hash_ex()\fR, \fBX509_NAME_hash()\fR, +\&\fBX509_subject_name_hash()\fR and \fBX509_issuer_name_hash()\fR +return the first four bytes of the SHA1 hash value, +converted to \fBunsigned long\fR in little endian order, +or 0 on failure. .PP -\&\fBX509_set_subject_name()\fR, \fBX509_set_issuer_name()\fR, \fBX509_REQ_set_subject_name()\fR -and \fBX509_CRL_set_issuer_name()\fR return 1 for success and 0 for failure. +\&\fBX509_set_subject_name()\fR, \fBX509_set_issuer_name()\fR, \fBX509_REQ_set_subject_name()\fR, +\&\fBX509_ACERT_get0_issuerName()\fR and \fBX509_CRL_set_issuer_name()\fR return 1 for +success and 0 for failure. +.SH BUGS +.IX Header "BUGS" +In case \fBX509_NAME_hash()\fR, \fBX509_subject_name_hash()\fR, or \fBX509_issuer_name_hash()\fR +returns 0 it remains unclear if this is the real hash value or due to failure. +Better use \fBX509_NAME_hash_ex()\fR instead. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBd2i_X509\fR\|(3), @@ -197,18 +174,23 @@ and \fBX509_CRL_set_issuer_name()\fR return 1 for success and 0 for failure. \&\fBX509_sign\fR\|(3), \&\fBX509V3_get_d2i\fR\|(3), \&\fBX509_verify_cert\fR\|(3) -.SH "HISTORY" +.SH HISTORY .IX Header "HISTORY" \&\fBX509_REQ_get_subject_name()\fR is a function in OpenSSL 1.1.0 and a macro in earlier versions. .PP \&\fBX509_CRL_get_issuer()\fR is a function in OpenSSL 1.1.0. It was previously added in OpenSSL 1.0.0 as a macro. -.SH "COPYRIGHT" +.PP +\&\fBX509_NAME_hash()\fR was turned into a macro and deprecated in OpenSSL 3.0. +.PP +\&\fBX509_ACERT_get0_issuerName()\fR, \fBX509_ACERT_set1_issuerName()\fR +were added in OpenSSL 3.4. +.SH COPYRIGHT .IX Header "COPYRIGHT" -Copyright 2015\-2019 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2015\-2024 The OpenSSL Project Authors. All Rights Reserved. .PP -Licensed under the OpenSSL license (the \*(L"License\*(R"). You may not use +Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy -in the file \s-1LICENSE\s0 in the source distribution or at +in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>. |