1=pod
2
3=head1 NAME
4
5X509_NAME_hash_ex, X509_NAME_hash,
6X509_get_subject_name, X509_set_subject_name, X509_subject_name_hash,
7X509_get_issuer_name, X509_set_issuer_name, X509_issuer_name_hash,
8X509_REQ_get_subject_name, X509_REQ_set_subject_name,
9X509_CRL_get_issuer, X509_CRL_set_issuer_name -
10get X509_NAME hashes or get and set issuer or subject names
11
12=head1 SYNOPSIS
13
14 #include <openssl/x509.h>
15
16 unsigned long X509_NAME_hash_ex(const X509_NAME *x, OSSL_LIB_CTX *libctx,
17                                 const char *propq, int *ok);
18
19 X509_NAME *X509_get_subject_name(const X509 *x);
20 int X509_set_subject_name(X509 *x, const X509_NAME *name);
21 unsigned long X509_subject_name_hash(X509 *x);
22
23 X509_NAME *X509_get_issuer_name(const X509 *x);
24 int X509_set_issuer_name(X509 *x, const X509_NAME *name);
25 unsigned long X509_issuer_name_hash(X509 *x);
26
27 X509_NAME *X509_REQ_get_subject_name(const X509_REQ *req);
28 int X509_REQ_set_subject_name(X509_REQ *req, const X509_NAME *name);
29
30 X509_NAME *X509_CRL_get_issuer(const X509_CRL *crl);
31 int X509_CRL_set_issuer_name(X509_CRL *x, const X509_NAME *name);
32
33The following macro has been deprecated since OpenSSL 3.0, and can be
34hidden entirely by defining B<OPENSSL_API_COMPAT> with a suitable version value,
35see L<openssl_user_macros(7)>:
36
37 #define X509_NAME_hash(x) X509_NAME_hash_ex(x, NULL, NULL, NULL)
38
39=head1 DESCRIPTION
40
41X509_NAME_hash_ex() returns a hash value of name I<x> or 0 on failure,
42using any given library context I<libctx> and property query I<propq>.
43The I<ok> result argument may be NULL
44or else is used to return 1 for success and 0 for failure.
45Failure may happen on malloc error or if no SHA1 implementation is available.
46
47X509_NAME_hash() returns a hash value of name I<x> or 0 on failure,
48using the default library context and default property query.
49
50X509_get_subject_name() returns the subject name of certificate I<x>. The
51returned value is an internal pointer which B<MUST NOT> be freed.
52
53X509_set_subject_name() sets the issuer name of certificate I<x> to
54I<name>. The I<name> parameter is copied internally and should be freed
55up when it is no longer needed.
56
57X509_subject_name_hash() returns a hash value of the subject name of
58certificate I<x>.
59
60X509_get_issuer_name(), X509_set_issuer_name(), and X509_issuer_name_hash()
61are identical to
62X509_get_subject_name(), X509_set_subject_name(), and X509_subject_name_hash()
63except they relate to the issuer name of I<x>.
64
65Similarly X509_REQ_get_subject_name(), X509_REQ_set_subject_name(),
66X509_CRL_get_issuer() and X509_CRL_set_issuer_name() get or set the subject
67or issuer names of certificate requests of CRLs respectively.
68
69=head1 RETURN VALUES
70
71X509_get_subject_name(), X509_get_issuer_name(), X509_REQ_get_subject_name()
72and X509_CRL_get_issuer() return an B<X509_NAME> pointer.
73
74X509_NAME_hash_ex(), X509_NAME_hash(),
75X509_subject_name_hash() and X509_issuer_name_hash()
76return the first four bytes of the SHA1 hash value,
77converted to B<unsigned long> in little endian order,
78or 0 on failure.
79
80X509_set_subject_name(), X509_set_issuer_name(), X509_REQ_set_subject_name()
81and X509_CRL_set_issuer_name() return 1 for success and 0 for failure.
82
83=head1 BUGS
84
85In case X509_NAME_hash(), X509_subject_name_hash(), or X509_issuer_name_hash()
86returns 0 it remains unclear if this is the real hash value or due to failure.
87Better use X509_NAME_hash_ex() instead.
88
89=head1 SEE ALSO
90
91L<d2i_X509(3)>,
92L<ERR_get_error(3)>, L<d2i_X509(3)>
93L<X509_CRL_get0_by_serial(3)>,
94L<X509_get0_signature(3)>,
95L<X509_get_ext_d2i(3)>,
96L<X509_get_extension_flags(3)>,
97L<X509_get_pubkey(3)>,
98L<X509_NAME_add_entry_by_txt(3)>,
99L<X509_NAME_ENTRY_get_object(3)>,
100L<X509_NAME_get_index_by_NID(3)>,
101L<X509_NAME_print_ex(3)>,
102L<X509_new(3)>,
103L<X509_sign(3)>,
104L<X509V3_get_d2i(3)>,
105L<X509_verify_cert(3)>
106
107=head1 HISTORY
108
109X509_REQ_get_subject_name() is a function in OpenSSL 1.1.0 and a macro in
110earlier versions.
111
112X509_CRL_get_issuer() is a function in OpenSSL 1.1.0. It was previously
113added in OpenSSL 1.0.0 as a macro.
114
115X509_NAME_hash() was turned into a macro and deprecated in OpenSSL 3.0.
116
117=head1 COPYRIGHT
118
119Copyright 2015-2021 The OpenSSL Project Authors. All Rights Reserved.
120
121Licensed under the Apache License 2.0 (the "License").  You may not use
122this file except in compliance with the License.  You can obtain a copy
123in the file LICENSE in the source distribution or at
124L<https://www.openssl.org/source/license.html>.
125
126=cut
127