Botan::CMS_Encoder Class Reference

#include <cms_enc.h>

Public Member Functions
void	authenticate (const std::string &, const std::string &="")
void	authenticate (const SymmetricKey &, const std::string &="")
void	authenticate (const X509_Certificate &, const std::string &="")
	CMS_Encoder (const byte buf[], size_t length)
	CMS_Encoder (const std::string &str)
void	compress (const std::string &)
void	digest (const std::string &="")
void	encrypt (RandomNumberGenerator &, const X509_Certificate &, const std::string="")
void	encrypt (RandomNumberGenerator &rng, const std::string &, const std::string &="")
void	encrypt (RandomNumberGenerator &rng, const SymmetricKey &, const std::string &="")
SecureVector< byte >	get_contents ()
std::string	PEM_contents ()
void	set_data (const byte[], size_t)
void	set_data (const std::string &)
void	sign (const X509_Certificate &cert, const Private_Key &key, RandomNumberGenerator &rng, const std::vector< X509_Certificate > &cert_chain, const std::string &hash, const std::string &padding)

Static Public Member Functions
static bool	can_compress_with (const std::string &)

Detailed Description

CMS Encoding Operation

Definition at line 21 of file cms_enc.h.

Constructor & Destructor Documentation

CMS_Encoder() [1/2]

Botan::CMS_Encoder::CMS_Encoder ( const std::string & str )

inline

Definition at line 56 of file cms_enc.h.

{ set_data(str); }

References set_data().

CMS_Encoder() [2/2]

Botan::CMS_Encoder::CMS_Encoder ( const byte buf[], size_t length )

inline

Definition at line 57 of file cms_enc.h.

{ set_data(buf, length); }

References set_data().

Member Function Documentation

authenticate() [1/3]

void Botan::CMS_Encoder::authenticate	(	const std::string &	,
		const std::string &	mac_algo = "" )

Definition at line 387 of file cms_ealg.cpp.

   {
   const std::string mac = choose_algo(mac_algo, "HMAC(SHA-1)");
   throw Internal_Error("FIXME: unimplemented");
   }

References Botan::Internal_Error::Internal_Error().

authenticate() [2/3]

void Botan::CMS_Encoder::authenticate	(	const SymmetricKey &	,
		const std::string &	mac_algo = "" )

Definition at line 377 of file cms_ealg.cpp.

   {
   const std::string mac = choose_algo(mac_algo, "HMAC(SHA-1)");
   throw Internal_Error("FIXME: unimplemented");
   }

References Botan::Internal_Error::Internal_Error().

authenticate() [3/3]

void Botan::CMS_Encoder::authenticate	(	const X509_Certificate &	,
		const std::string &	mac_algo = "" )

Definition at line 367 of file cms_ealg.cpp.

   {
   const std::string mac = choose_algo(mac_algo, "HMAC(SHA-1)");
   throw Internal_Error("FIXME: unimplemented");
   }

References Botan::Internal_Error::Internal_Error().

can_compress_with()

bool Botan::CMS_Encoder::can_compress_with ( const std::string & algo )

static

Definition at line 56 of file cms_comp.cpp.

   {
   if(algo == "")
      throw Invalid_Algorithm_Name("Empty string to can_compress_with");
 
#if defined(BOTAN_HAS_COMPRESSOR_ZLIB)
   if(algo == "Zlib")
      return true;
#endif
 
   return false;
   }

References Botan::Invalid_Algorithm_Name::Invalid_Algorithm_Name().

Referenced by compress().

compress()

void Botan::CMS_Encoder::compress

(

const std::string &

algo

)

Definition at line 24 of file cms_comp.cpp.

   {
   if(!CMS_Encoder::can_compress_with(algo))
      throw Invalid_Argument("CMS_Encoder: Cannot compress with " + algo);
 
   Filter* compressor = 0;
 
#if defined(BOTAN_HAS_COMPRESSOR_ZLIB)
   if(algo == "Zlib") compressor = new Zlib_Compression;
#endif
 
   if(compressor == 0)
      throw Internal_Error("CMS: Couldn't get ahold of a compressor");
 
   Pipe pipe(compressor);
   pipe.process_msg(data);
   SecureVector<byte> compressed = pipe.read_all();
 
   DER_Encoder encoder;
   encoder.start_cons(SEQUENCE).
      encode(static_cast<size_t>(0)).
      encode(AlgorithmIdentifier("Compression." + algo,
                                 MemoryVector<byte>())).
      raw_bytes(make_econtent(compressed, type)).
   end_cons();
 
   add_layer("CMS.CompressedData", encoder);
   }

References Botan::AlgorithmIdentifier::AlgorithmIdentifier(), can_compress_with(), Botan::Internal_Error::Internal_Error(), Botan::Pipe::process_msg(), Botan::Pipe::read_all(), Botan::SEQUENCE, and Botan::DER_Encoder::start_cons().

digest()

void Botan::CMS_Encoder::digest

(

const std::string &

user_hash = ""

)

Definition at line 344 of file cms_ealg.cpp.

   {
   const std::string hash = choose_algo(user_hash, "SHA-1");
   if(!OIDS::have_oid(hash))
      throw Encoding_Error("CMS: No OID assigned for " + hash);
 
   const size_t VERSION = (type != "CMS.DataContent") ? 2 : 0;
 
   DER_Encoder encoder;
   encoder.start_cons(SEQUENCE)
      .encode(VERSION)
      .encode(AlgorithmIdentifier(OIDS::lookup(hash),
                                  AlgorithmIdentifier::USE_NULL_PARAM))
      .raw_bytes(make_econtent(data, type))
      .encode(hash_of(data, hash), OCTET_STRING)
   .end_cons();
 
   add_layer("CMS.DigestedData", encoder);
   }

References Botan::AlgorithmIdentifier::AlgorithmIdentifier(), Botan::DER_Encoder::encode(), Botan::Encoding_Error::Encoding_Error(), Botan::DER_Encoder::end_cons(), Botan::OIDS::have_oid(), Botan::OIDS::lookup(), Botan::OCTET_STRING, Botan::DER_Encoder::raw_bytes(), Botan::SEQUENCE, Botan::DER_Encoder::start_cons(), and Botan::AlgorithmIdentifier::USE_NULL_PARAM.

encrypt() [1/3]

void Botan::CMS_Encoder::encrypt	(	RandomNumberGenerator &	rng,
		const X509_Certificate &	to,
		const std::string	user_cipher = "" )

Definition at line 93 of file cms_ealg.cpp.

   {
   const std::string cipher = choose_algo(user_cipher, "TripleDES");
 
   std::auto_ptr<Public_Key> key(to.subject_public_key());
   const std::string algo = key->algo_name();
 
   Key_Constraints constraints = to.constraints();
 
   if(algo == "RSA")
      {
      if(constraints != NO_CONSTRAINTS && !(constraints & KEY_ENCIPHERMENT))
         throw Invalid_Argument("CMS: Constraints not set for encryption");
 
      encrypt_ktri(rng, to, key.get(), cipher);
      }
   else if(algo == "DH")
      {
      if(constraints != NO_CONSTRAINTS && !(constraints & KEY_AGREEMENT))
         throw Invalid_Argument("CMS: Constraints not set for key agreement");
 
      encrypt_kari(rng, to, key.get(), cipher);
      }
   else
      throw Invalid_Argument("Unknown CMS PK encryption algorithm " + algo);
   }

References Botan::X509_Certificate::constraints(), Botan::KEY_AGREEMENT, Botan::KEY_ENCIPHERMENT, Botan::NO_CONSTRAINTS, and Botan::X509_Certificate::subject_public_key().

encrypt() [2/3]

void Botan::CMS_Encoder::encrypt	(	RandomNumberGenerator &	rng,
		const std::string &	,
		const std::string &	user_cipher = "" )

Definition at line 225 of file cms_ealg.cpp.

   {
   const std::string cipher = choose_algo(user_cipher, "TripleDES");
   throw Internal_Error("FIXME: unimplemented");
   /*
   SymmetricKey cek = setup_key(key);
 
   DER_Encoder encoder;
   encoder.start_cons(SEQUENCE);
     encoder.encode(0);
     encoder.raw_bytes(do_encrypt(rng, cek, cipher));
   encoder.end_cons();
 
   add_layer("CMS.EnvelopedData", encoder);
   */
   }

References Botan::Internal_Error::Internal_Error().

encrypt() [3/3]

void Botan::CMS_Encoder::encrypt	(	RandomNumberGenerator &	rng,
		const SymmetricKey &	kek,
		const std::string &	user_cipher = "" )

Definition at line 192 of file cms_ealg.cpp.

   {
   throw Internal_Error("FIXME: untested");
 
   const std::string cipher = choose_algo(user_cipher, "TripleDES");
   SymmetricKey cek = setup_key(rng, cipher);
 
   SecureVector<byte> kek_id; // FIXME: ?
 
   DER_Encoder encoder;
 
   encoder.start_cons(SEQUENCE)
      .encode(static_cast<size_t>(2))
      .start_explicit(ASN1_Tag(2))
      .encode(static_cast<size_t>(4))
         .start_cons(SEQUENCE)
            .encode(kek_id, OCTET_STRING)
         .end_cons()
         .encode(AlgorithmIdentifier(OIDS::lookup("KeyWrap." + cipher),
                                     AlgorithmIdentifier::USE_NULL_PARAM))
         .encode(wrap_key(rng, cipher, cek, kek), OCTET_STRING)
      .end_cons()
      .raw_bytes(do_encrypt(rng, cek, cipher))
   .end_cons();
 
   add_layer("CMS.EnvelopedData", encoder);
   }

References Botan::AlgorithmIdentifier::AlgorithmIdentifier(), Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), Botan::Internal_Error::Internal_Error(), Botan::OIDS::lookup(), Botan::OCTET_STRING, Botan::DER_Encoder::raw_bytes(), Botan::SEQUENCE, Botan::DER_Encoder::start_cons(), Botan::DER_Encoder::start_explicit(), and Botan::AlgorithmIdentifier::USE_NULL_PARAM.

get_contents()

SecureVector< byte > Botan::CMS_Encoder::get_contents

(

)

Definition at line 39 of file cms_enc.cpp.

   {
   DER_Encoder encoder;
 
   encoder.start_cons(SEQUENCE).
      encode(OIDS::lookup(type)).
      start_explicit(0).
         raw_bytes(data).
      end_explicit().
   end_cons();
 
   data.clear();
 
   return encoder.get_contents();
   }

References Botan::DER_Encoder::get_contents(), Botan::OIDS::lookup(), Botan::SEQUENCE, and Botan::DER_Encoder::start_cons().

Referenced by PEM_contents().

PEM_contents()

std::string Botan::CMS_Encoder::PEM_contents

(

)

Definition at line 67 of file cms_enc.cpp.

   {
   return PEM_Code::encode(get_contents(), "PKCS7");
   }

References Botan::PEM_Code::encode(), and get_contents().

set_data() [1/2]

void Botan::CMS_Encoder::set_data	(	const byte	buf[],
		size_t	length )

Definition at line 18 of file cms_enc.cpp.

   {
   if(!data.empty())
      throw Invalid_State("Cannot call CMS_Encoder::set_data here");
 
   data.resize(length);
   copy_mem(&data[0], buf, length);
   type = "CMS.DataContent";
   }

References Botan::copy_mem(), and Botan::Invalid_State::Invalid_State().

set_data() [2/2]

void Botan::CMS_Encoder::set_data

(

const std::string &

str

)

Definition at line 31 of file cms_enc.cpp.

   {
   set_data(reinterpret_cast<const byte*>(str.c_str()), str.length());
   }

References set_data().

Referenced by CMS_Encoder(), CMS_Encoder(), and set_data().

sign()

void Botan::CMS_Encoder::sign	(	const X509_Certificate &	cert,
		const Private_Key &	key,
		RandomNumberGenerator &	rng,
		const std::vector< X509_Certificate > &	cert_chain,
		const std::string &	hash,
		const std::string &	padding )

Definition at line 284 of file cms_ealg.cpp.

   {
   std::string padding = pad_algo + "(" + hash + ")";
 
   Signature_Format format = IEEE_1363;
 
   PK_Signer signer(key, padding, format);
 
   AlgorithmIdentifier sig_algo(OIDS::lookup(key.algo_name() + "/" + padding),
                                AlgorithmIdentifier::USE_NULL_PARAM);
 
   SecureVector<byte> signed_attr = encode_attr(data, type, hash);
   signer.update(signed_attr);
   SecureVector<byte> signature = signer.signature(rng);
   signed_attr[0] = 0xA0;
 
   const size_t SI_VERSION = cert.subject_key_id().size() ? 3 : 1;
   const size_t CMS_VERSION = (type != "CMS.DataContent") ? 3 : SI_VERSION;
 
   DER_Encoder encoder;
 
   encoder.start_cons(SEQUENCE)
      .encode(CMS_VERSION)
      .start_cons(SET)
         .encode(AlgorithmIdentifier(OIDS::lookup(hash),
                                     AlgorithmIdentifier::USE_NULL_PARAM))
      .end_cons()
   .raw_bytes(make_econtent(data, type));
 
   encoder.start_cons(ASN1_Tag(0), CONTEXT_SPECIFIC);
   for(size_t j = 0; j != chain.size(); j++)
      encoder.raw_bytes(chain[j].BER_encode());
   encoder.raw_bytes(cert.BER_encode()).end_cons();
 
   encoder.start_cons(SET)
      .start_cons(SEQUENCE)
      .encode(SI_VERSION);
      encode_si(encoder, cert, ((SI_VERSION == 3) ? true : false))
      .encode(
         AlgorithmIdentifier(OIDS::lookup(hash),
                             AlgorithmIdentifier::USE_NULL_PARAM)
         )
      .raw_bytes(signed_attr)
      .encode(sig_algo)
      .encode(signature, OCTET_STRING)
      .end_cons()
     .end_cons()
   .end_cons();
 
   add_layer("CMS.SignedData", encoder);
   }

References Botan::Public_Key::algo_name(), Botan::AlgorithmIdentifier::AlgorithmIdentifier(), Botan::X509_Object::BER_encode(), Botan::CONTEXT_SPECIFIC, Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), Botan::IEEE_1363, Botan::OIDS::lookup(), Botan::OCTET_STRING, Botan::DER_Encoder::raw_bytes(), Botan::SEQUENCE, Botan::SET, Botan::PK_Signer::signature(), Botan::MemoryRegion< T >::size(), Botan::DER_Encoder::start_cons(), Botan::X509_Certificate::subject_key_id(), Botan::PK_Signer::update(), and Botan::AlgorithmIdentifier::USE_NULL_PARAM.

---

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

• src/cms/cms_enc.h
• src/cms/cms_algo.cpp
• src/cms/cms_comp.cpp
• src/cms/cms_ealg.cpp
• src/cms/cms_enc.cpp