ossl_DER_w_begin_sequence.pod 1.4 KB

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