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