Botan::CMS_Decoder Class Reference

#include <cms_dec.h>

Public Types
enum	Content_Type {   DATA , UNKNOWN , COMPRESSED , ENVELOPED ,   SIGNED , AUTHENTICATED , DIGESTED }
enum	Status { GOOD , BAD , NO_KEY , FAILURE }

Public Member Functions
void	add_key (Private_Key *)
	CMS_Decoder (DataSource &, const X509_Store &, Private_Key *=0)
std::vector< X509_Certificate >	get_certs () const
std::vector< X509_CRL >	get_crls () const
std::string	get_data () const
std::string	layer_algo () const
std::string	layer_info () const
Status	layer_status () const
Content_Type	layer_type () const
void	next_layer ()

Detailed Description

CMS Decoding Operation

Definition at line 21 of file cms_dec.h.

Member Enumeration Documentation

Content_Type

enum Botan::CMS_Decoder::Content_Type

Enumerator
DATA
UNKNOWN
COMPRESSED
ENVELOPED
SIGNED
AUTHENTICATED
DIGESTED

Definition at line 26 of file cms_dec.h.

                        { DATA, UNKNOWN, COMPRESSED, ENVELOPED, SIGNED,
                          AUTHENTICATED, DIGESTED };

Status

enum Botan::CMS_Decoder::Status

Enumerator
GOOD
BAD
NO_KEY
FAILURE

Definition at line 24 of file cms_dec.h.

{ GOOD, BAD, NO_KEY, FAILURE };

Constructor & Destructor Documentation

CMS_Decoder()

Botan::CMS_Decoder::CMS_Decoder	(	DataSource &	in,
		const X509_Store &	x509store,
		Private_Key *	key = 0 )

Definition at line 19 of file cms_dec.cpp.

                                           :
   store(x509store)
   {
   status = GOOD;
 
   add_key(key);
 
   if(ASN1::maybe_BER(in) && !PEM_Code::matches(in))
      initial_read(in);
   else
      {
      DataSource_Memory ber(PEM_Code::decode_check_label(in, "PKCS7"));
      initial_read(ber);
      }
   }

References add_key(), Botan::PEM_Code::decode_check_label(), GOOD, Botan::PEM_Code::matches(), and Botan::ASN1::maybe_BER().

Member Function Documentation

add_key()

void Botan::CMS_Decoder::add_key

(

Private_Key *

key

)

Definition at line 60 of file cms_dec.cpp.

   {
   if(!key)
      return;
 
#if 0
   for(u32bit j = 0; j != keys.size(); j++)
      if(keys[j]->key_id() == key->key_id())
         return;
#endif
 
   keys.push_back(key);
   }

Referenced by CMS_Decoder().

get_certs()

std::vector< X509_Certificate > Botan::CMS_Decoder::get_certs

(

)

const

get_crls()

std::vector< X509_CRL > Botan::CMS_Decoder::get_crls

(

)

const

get_data()

std::string Botan::CMS_Decoder::get_data

(

)

const

Definition at line 85 of file cms_dec.cpp.

   {
   if(layer_type() != DATA)
      throw Invalid_State("CMS: Cannot retrieve data from non-DATA layer");
 
   return std::string(reinterpret_cast<const char*>(&data[0]),
                      data.size());
   }

References DATA, Botan::Invalid_State::Invalid_State(), and layer_type().

Referenced by layer_algo().

layer_algo()

std::string Botan::CMS_Decoder::layer_algo

(

)

const

References get_data().

layer_info()

std::string Botan::CMS_Decoder::layer_info

(

)

const

Definition at line 111 of file cms_dec.cpp.

   {
   return info;
   }

layer_status()

CMS_Decoder::Status Botan::CMS_Decoder::layer_status

(

)

const

Definition at line 77 of file cms_dec.cpp.

   {
   return status;
   }

layer_type()

CMS_Decoder::Content_Type Botan::CMS_Decoder::layer_type

(

)

const

Definition at line 97 of file cms_dec.cpp.

   {
   if(type == OIDS::lookup("CMS.DataContent"))       return DATA;
   if(type == OIDS::lookup("CMS.EnvelopedData"))     return ENVELOPED;
   if(type == OIDS::lookup("CMS.CompressedData"))    return COMPRESSED;
   if(type == OIDS::lookup("CMS.SignedData"))        return SIGNED;
   if(type == OIDS::lookup("CMS.AuthenticatedData")) return AUTHENTICATED;
   if(type == OIDS::lookup("CMS.DigestedData"))      return DIGESTED;
   return UNKNOWN;
   }

References AUTHENTICATED, COMPRESSED, DATA, DIGESTED, ENVELOPED, Botan::OIDS::lookup(), SIGNED, and UNKNOWN.

Referenced by get_data().

next_layer()

void Botan::CMS_Decoder::next_layer ( )

inline

Definition at line 37 of file cms_dec.h.

{ decode_layer(); }

---

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

• src/cms/cms_dec.h
• src/cms/cms_comp.cpp
• src/cms/cms_dalg.cpp
• src/cms/cms_dec.cpp