Botan::ASN1_Pretty_Printer Class Reference

#include <asn1_print.h>

Inheritance diagram for Botan::ASN1_Pretty_Printer:

Public Member Functions
	ASN1_Pretty_Printer (size_t print_limit=4096, size_t print_binary_limit=2048, bool print_context_specific=true, size_t initial_level=0, size_t value_column=60, size_t max_depth=64, bool require_der=false)
template<typename Alloc>
std::string	print (const std::vector< uint8_t, Alloc > &vec) const
std::string	print (const uint8_t in[], size_t len) const
void	print_to_stream (std::ostream &out, const uint8_t in[], size_t len) const

Detailed Description

Format ASN.1 data into human readable output. The exact form of the output for any particular input is not guaranteed and may change from release to release.

Definition at line 100 of file asn1_print.h.

Constructor & Destructor Documentation

ASN1_Pretty_Printer()

Botan::ASN1_Pretty_Printer::ASN1_Pretty_Printer ( size_t print_limit = 4096, size_t print_binary_limit = 2048, bool print_context_specific = true, size_t initial_level = 0, size_t value_column = 60, size_t max_depth = 64, bool require_der = false )

inlineexplicit

Create a pretty printer with the given settings

Parameters

print_limit	strings larger than this are not printed
print_binary_limit	binary strings larger than this are not printed
print_context_specific	if true, try to parse nested context specific data.
initial_level	the initial depth (0 or 1 are the only reasonable values)
value_column	ASN.1 values are lined up at this column in output
max_depth	do not recurse more than this many times. If zero, recursion is unbounded.
require_der	if true then non-canonical BER data is rejected

Definition at line 114 of file asn1_print.h.

                                                           :
            ASN1_Formatter(print_context_specific, max_depth, require_der),
            m_print_limit(print_limit),
            m_print_binary_limit(print_binary_limit),
            m_initial_level(initial_level),
            m_value_column(value_column) {}

References Botan::ASN1_Formatter::ASN1_Formatter().

Member Function Documentation

print() [1/2]

template<typename Alloc>

std::string Botan::ASN1_Formatter::print ( const std::vector< uint8_t, Alloc > & vec ) const

inlineinherited

Return the given ASN.1 data in formatted form

Parameters

vec	the DER or BER encoded data

Definition at line 61 of file asn1_print.h.

                                                                  {
         return print(vec.data(), vec.size());
      }

References print().

print() [2/2]

std::string Botan::ASN1_Formatter::print ( const uint8_t in[], size_t len ) const

inherited

Return the given ASN.1 data in formatted form

Parameters

in	the DER or BER encoded data
len	the length of in in bytes

Definition at line 61 of file asn1_print.cpp.

                                                                    {
   std::ostringstream output;
   print_to_stream(output, in, len);
   return output.str();
}

References print_to_stream().

Referenced by print().

print_to_stream()

void Botan::ASN1_Formatter::print_to_stream ( std::ostream & out, const uint8_t in[], size_t len ) const

inherited

Format the given ASN.1 data, writing the result to a stream

Parameters

out	the stream to write the formatted output to
in	the DER or BER encoded data
len	the length of in in bytes

Definition at line 67 of file asn1_print.cpp.

                                                                                             {
   // The pretty printer is a best-effort diagnostic tool, so in BER mode it
   // tolerates standalone EOC markers emitted by some BER producers.
   const auto decoder_limits =
      m_require_der ? BER_Decoder::Limits::DER() : BER_Decoder::Limits::BER().with_standalone_eoc_allowed();
   BER_Decoder dec(std::span<const uint8_t>{in, len}, decoder_limits);
   decode(output, dec, 0);
}

References Botan::BER_Decoder::Limits::BER(), Botan::BER_Decoder::Limits::DER(), and Botan::BER_Decoder::Limits::with_standalone_eoc_allowed().

Referenced by print().

---

The documentation for this class was generated from the following files:

• src/lib/asn1/asn1_print.h
• src/lib/asn1/asn1_print.cpp