1X509_GET0_DISTINGUISHING_ID(3ossl)  OpenSSL X509_GET0_DISTINGUISHING_ID(3ossl)
2
3
4

NAME

6       X509_get0_distinguishing_id, X509_set0_distinguishing_id,
7       X509_REQ_get0_distinguishing_id, X509_REQ_set0_distinguishing_id - get
8       or set the Distinguishing ID for certificate operations
9

SYNOPSIS

11        #include <openssl/x509.h>
12
13        ASN1_OCTET_STRING *X509_get0_distinguishing_id(X509 *x);
14        void X509_set0_distinguishing_id(X509 *x, ASN1_OCTET_STRING *distid);
15        ASN1_OCTET_STRING *X509_REQ_get0_distinguishing_id(X509_REQ *x);
16        void X509_REQ_set0_distinguishing_id(X509_REQ *x, ASN1_OCTET_STRING *distid);
17

DESCRIPTION

19       The Distinguishing ID is defined in FIPS 196 as follows:
20
21       Distinguishing  identifier
22           Information which unambiguously distinguishes an entity in the
23           authentication process.
24
25       The SM2 signature algorithm requires a Distinguishing ID value when
26       generating and verifying a signature, but the Ddistinguishing ID may
27       also find other uses.  In the context of SM2, the Distinguishing ID is
28       often referred to as the "SM2 ID".
29
30       For the purpose off verifying a certificate or a certification request,
31       a Distinguishing ID may be attached to it, so functions like
32       X509_verify(3) or X509_REQ_verify(3) have easy access to that identity
33       for signature verification.
34
35       X509_get0_distinguishing_id() gets the Distinguishing ID value of a
36       certificate x by returning an ASN1_OCTET_STRING object which should not
37       be freed by the caller.
38
39       X509_set0_distinguishing_id() assigns distid to the certificate x.
40       Calling this function transfers the memory management of the value to
41       the X509 object, and therefore the value that has been passed in should
42       not be freed by the caller after this function has been called.
43
44       X509_REQ_get0_distinguishing_id() and X509_REQ_set0_distinguishing_id()
45       have the same functionality as X509_get0_distinguishing_id() and
46       X509_set0_distinguishing_id() except that they deal with  X509_REQ
47       objects instead of X509.
48

RETURN VALUES

50       X509_set0_distinguishing_id() and X509_REQ_set0_distinguishing_id() do
51       not return a value.
52

SEE ALSO

54       X509_verify(3), SM2(7)
55

57       Copyright 2019-2020 The OpenSSL Project Authors. All Rights Reserved.
58
59       Licensed under the Apache License 2.0 (the "License").  You may not use
60       this file except in compliance with the License.  You can obtain a copy
61       in the file LICENSE in the source distribution or at
62       <https://www.openssl.org/source/license.html>.
63
64
65
663.1.1                             2023-08-31X509_GET0_DISTINGUISHING_ID(3ossl)
Impressum