Add documents for SM2 cert verification
[openssl.git] / doc / man3 / X509_get0_sm2_id.pod
1 =pod
2
3 =head1 NAME
4
5 X509_get0_sm2_id, X509_set_sm2_id - get or set SM2 ID for certificate operations
6
7 =head1 SYNOPSIS
8
9  #include <openssl/x509.h>
10
11  ASN1_OCTET_STRING *X509_get0_sm2_id(X509 *x);
12  void X509_set_sm2_id(X509 *x, ASN1_OCTET_STRING *sm2_id);
13
14 =head1 DESCRIPTION
15
16 X509_get0_sm2_id() gets the ID value of an SM2 certificate B<x> by returning an
17 B<ASN1_OCTET_STRING> object which should not be freed by the caller.
18 X509_set_sm2_id() sets the B<sm2_id> value to an SM2 certificate B<x>.
19
20 =head1 NOTES
21
22 SM2 signature algorithm requires an ID value when generating and verifying a
23 signature. The functions described in this manual provide the user with the
24 ability to set and retrieve the SM2 ID value.
25
26 =head1 RETURN VALUES
27
28 X509_set_sm2_id() does not return a value.
29
30 =head1 SEE ALSO
31
32 L<X509_verify(3)>, L<SM2(7)>
33
34 =head1 COPYRIGHT
35
36 Copyright 2019 The OpenSSL Project Authors. All Rights Reserved.
37
38 Licensed under the Apache License 2.0 (the "License").  You may not use
39 this file except in compliance with the License.  You can obtain a copy
40 in the file LICENSE in the source distribution or at
41 L<https://www.openssl.org/source/license.html>.
42
43 =cut