1X509_GET_SUBJECT_NAME(3ossl) OpenSSL X509_GET_SUBJECT_NAME(3ossl)
2
3
4
6 X509_NAME_hash_ex, X509_NAME_hash, X509_get_subject_name,
7 X509_set_subject_name, X509_subject_name_hash, X509_get_issuer_name,
8 X509_set_issuer_name, X509_issuer_name_hash, X509_REQ_get_subject_name,
9 X509_REQ_set_subject_name, X509_CRL_get_issuer,
10 X509_CRL_set_issuer_name - get X509_NAME hashes or get and set issuer
11 or subject names
12
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
33 The following macro has been deprecated since OpenSSL 3.0, and can be
34 hidden entirely by defining OPENSSL_API_COMPAT with a suitable version
35 value, see openssl_user_macros(7):
36
37 #define X509_NAME_hash(x) X509_NAME_hash_ex(x, NULL, NULL, NULL)
38
40 X509_NAME_hash_ex() returns a hash value of name x or 0 on failure,
41 using any given library context libctx and property query propq. The
42 ok result argument may be NULL or else is used to return 1 for success
43 and 0 for failure. Failure may happen on malloc error or if no SHA1
44 implementation is available.
45
46 X509_NAME_hash() returns a hash value of name x or 0 on failure, using
47 the default library context and default property query.
48
49 X509_get_subject_name() returns the subject name of certificate x. The
50 returned value is an internal pointer which MUST NOT be freed.
51
52 X509_set_subject_name() sets the issuer name of certificate x to name.
53 The name parameter is copied internally and should be freed up when it
54 is no longer needed.
55
56 X509_subject_name_hash() returns a hash value of the subject name of
57 certificate x.
58
59 X509_get_issuer_name(), X509_set_issuer_name(), and
60 X509_issuer_name_hash() are identical to X509_get_subject_name(),
61 X509_set_subject_name(), and X509_subject_name_hash() except they
62 relate to the issuer name of x.
63
64 Similarly X509_REQ_get_subject_name(), X509_REQ_set_subject_name(),
65 X509_CRL_get_issuer() and X509_CRL_set_issuer_name() get or set the
66 subject or issuer names of certificate requests of CRLs respectively.
67
69 X509_get_subject_name(), X509_get_issuer_name(),
70 X509_REQ_get_subject_name() and X509_CRL_get_issuer() return an
71 X509_NAME pointer.
72
73 X509_NAME_hash_ex(), X509_NAME_hash(), X509_subject_name_hash() and
74 X509_issuer_name_hash() return the first four bytes of the SHA1 hash
75 value, converted to unsigned long in little endian order, or 0 on
76 failure.
77
78 X509_set_subject_name(), X509_set_issuer_name(),
79 X509_REQ_set_subject_name() and X509_CRL_set_issuer_name() return 1 for
80 success and 0 for failure.
81
83 In case X509_NAME_hash(), X509_subject_name_hash(), or
84 X509_issuer_name_hash() returns 0 it remains unclear if this is the
85 real hash value or due to failure. Better use X509_NAME_hash_ex()
86 instead.
87
89 d2i_X509(3), ERR_get_error(3), d2i_X509(3) X509_CRL_get0_by_serial(3),
90 X509_get0_signature(3), X509_get_ext_d2i(3),
91 X509_get_extension_flags(3), X509_get_pubkey(3),
92 X509_NAME_add_entry_by_txt(3), X509_NAME_ENTRY_get_object(3),
93 X509_NAME_get_index_by_NID(3), X509_NAME_print_ex(3), X509_new(3),
94 X509_sign(3), X509V3_get_d2i(3), X509_verify_cert(3)
95
97 X509_REQ_get_subject_name() is a function in OpenSSL 1.1.0 and a macro
98 in earlier versions.
99
100 X509_CRL_get_issuer() is a function in OpenSSL 1.1.0. It was previously
101 added in OpenSSL 1.0.0 as a macro.
102
103 X509_NAME_hash() was turned into a macro and deprecated in OpenSSL 3.0.
104
106 Copyright 2015-2021 The OpenSSL Project Authors. All Rights Reserved.
107
108 Licensed under the Apache License 2.0 (the "License"). You may not use
109 this file except in compliance with the License. You can obtain a copy
110 in the file LICENSE in the source distribution or at
111 <https://www.openssl.org/source/license.html>.
112
113
114
1153.0.5 2022-07-05 X509_GET_SUBJECT_NAME(3ossl)