PROV: Add the beginning of a DER writing library
[openssl.git] / doc / internal / man3 / DER_w_begin_sequence.pod
1 =pod
2
3 =head1 NAME
4
5 DER_w_begin_sequence, DER_w_end_sequence
6 - internal DER writers for DER constructed elements
7
8 =head1 SYNOPSIS
9
10  #include "internal/der.h"
11
12  int DER_w_begin_sequence(WPACKET *pkt, int tag);
13  int DER_w_end_sequence(WPACKET *pkt, int tag);
14
15 =head1 DESCRIPTION
16
17 All functions described here are wrappers for constructed structures,
18 i.e. the ASN.1 SEQUENCE, SET and CHOICE specifications.  They all come
19 in pairs, as noted by the function names containing the words C<begin>
20 and B<end>.
21
22 When using these, special care must be taken to ensure that the ASN.1 tag
23 value I<tag> is the same in the matching C<begin> and C<end> function calls.
24
25 DER_w_begin_sequence() and DER_w_end_sequence() begins and ends a
26 SEQUENCE.
27
28 =head1 RETURN VALUES
29
30 All the functions return 1 on success and 0 on failure.  Failure may
31 mean that the buffer held by the I<pkt> is too small, but may also
32 mean that the values given to the functions are invalid, such as the provided
33 I<tag> value being too large for the implementation.
34
35 =head1 SEE ALSO
36
37 L<DERlib(7)>
38
39 =head1 COPYRIGHT
40
41 Copyright 2020 The OpenSSL Project Authors. All Rights Reserved.
42
43 Licensed under the Apache License 2.0 (the "License").  You may not use
44 this file except in compliance with the License.  You can obtain a copy
45 in the file LICENSE in the source distribution or at
46 L<https://www.openssl.org/source/license.html>.
47
48 =cut