Debian Codegraph @

upstream/debian-unstable/man3/X509_get0_distinguishing_id.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "X509_GET0_DISTINGUISHING_ID 3SSL"
58 .TH X509_GET0_DISTINGUISHING_ID 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 X509_get0_distinguishing_id, X509_set0_distinguishing_id,
65 X509_REQ_get0_distinguishing_id, X509_REQ_set0_distinguishing_id
66 \&\- get or set the Distinguishing ID for certificate operations
67 .SH SYNOPSIS
68 .IX Header "SYNOPSIS"
69 .Vb 1
70 \& #include <openssl/x509.h>
71 \&
72 \& ASN1_OCTET_STRING *X509_get0_distinguishing_id(X509 *x);
73 \& void X509_set0_distinguishing_id(X509 *x, ASN1_OCTET_STRING *distid);
74 \& ASN1_OCTET_STRING *X509_REQ_get0_distinguishing_id(X509_REQ *x);
75 \& void X509_REQ_set0_distinguishing_id(X509_REQ *x, ASN1_OCTET_STRING *distid);
76 .Ve
77 .SH DESCRIPTION
78 .IX Header "DESCRIPTION"
79 The Distinguishing ID is defined in FIPS 196 as follows:
80 .IP "\fIDistinguishing identifier\fR" 4
81 .IX Item "Distinguishing identifier"
82 Information which unambiguously distinguishes
83 an entity in the authentication process.
84 .PP
85 The SM2 signature algorithm requires a Distinguishing ID value when generating
86 and verifying a signature, but the Ddistinguishing ID may also find other uses.
87 In the context of SM2, the Distinguishing ID is often referred to as the "SM2
88 ID".
89 .PP
90 For the purpose off verifying a certificate or a certification request, a
91 Distinguishing ID may be attached to it, so functions like \fBX509_verify\fR\|(3)
92 or \fBX509_REQ_verify\fR\|(3) have easy access to that identity for signature
93 verification.
94 .PP
95 \&\fBX509_get0_distinguishing_id()\fR gets the Distinguishing ID value of a certificate
96 \&\fBx\fR by returning an \fBASN1_OCTET_STRING\fR object which should not be freed by
97 the caller.
98 .PP
99 \&\fBX509_set0_distinguishing_id()\fR assigns \fBdistid\fR to the certificate \fBx\fR.
100 Calling this function transfers the memory management of the value to the X509
101 object, and therefore the value that has been passed in should not be freed by
102 the caller after this function has been called.
103 .PP
104 \&\fBX509_REQ_get0_distinguishing_id()\fR and \fBX509_REQ_set0_distinguishing_id()\fR
105 have the same functionality as \fBX509_get0_distinguishing_id()\fR and
106 \&\fBX509_set0_distinguishing_id()\fR except that they deal with \fBX509_REQ\fR
107 objects instead of \fBX509\fR.
108 .SH "RETURN VALUES"
109 .IX Header "RETURN VALUES"
110 \&\fBX509_set0_distinguishing_id()\fR and \fBX509_REQ_set0_distinguishing_id()\fR do not
111 return a value.
112 .SH "SEE ALSO"
113 .IX Header "SEE ALSO"
114 \&\fBX509_verify\fR\|(3), \fBSM2\fR\|(7)
115 .SH COPYRIGHT
116 .IX Header "COPYRIGHT"
117 Copyright 2019\-2020 The OpenSSL Project Authors. All Rights Reserved.
118 .PP
119 Licensed under the Apache License 2.0 (the "License"). You may not use
120 this file except in compliance with the License. You can obtain a copy
121 in the file LICENSE in the source distribution or at
122 <https://www.openssl.org/source/license.html>.