CODEX_ASN1::OctetString Class Reference

Serializable representation of a byte string. More...

#include <OctetString.h>

Inheritance diagram for CODEX_ASN1::OctetString:

[legend]Collaboration diagram for CODEX_ASN1::OctetString:

[legend]List of all members.

Public Member Functions
	OctetString ()
	Default constructor, for creating an object to be unmarshalled.
	OctetString (const ustring &value)
	Create an OctetString for a given character string.
	OctetString (const ASN1_OCTET_STRING *asn1)
	Create an OctetString based on a given ASN.1 specification.
	OctetString (const OctetString &aOS)
	Create an OctetString from another OctetString.
virtual	~OctetString ()
	Destructor -- frees the stored ASN1_OCTET_STRING.
void	operator= (const OctetString &aOS)
	Assignment operator.
ustring	value () const
	String representation of the OctetString.
const ASN1_OCTET_STRING *	asn1 () const
	ASN.1 representation of the OctetString.
int	marshal (unsigned char **pp) const
	This function creates a serialized representation of the object, which is returned through the argument pp.
void *	unmarshal (void *bogus, unsigned char **pp, long length)
	This function takes a serialized representation of the object and recreates the object representation.
bool	initialized () const
Protected Attributes
bool	m_initialized
	Has this object been initialized yet, or is it still blank?

---

Detailed Description

Serializable representation of a byte string.

Constructors other than the default will initialize both the string value and the ASN.1 representation.

Definition at line 33 of file OctetString.h.

---

Member Function Documentation

bool CODEX_ASN1::Base::initialized (   )  const [inline, inherited]

Returns: Has this object been initialized? Definition at line 175 of file Base.h. References CODEX_ASN1::Base::m_initialized. Referenced by CODEX_APSS::SecretManagement::addComputeMsg(), CODEX_APSS::SecretManagement::addEstablishMsg(), CODEX_APSS::SecretManagement::addEstablishResponse(), CODEX_APSS::SecretManagement::addInitMsg(), CODEX_APSS::SecretManagement::addSharing(), CODEX_APSS::SecretManagement::addSubsharing(), CODEX_VSS::Combinatoric< NumT, ThreshT >::apply(), CODEX_Server::ServerState::caKey(), CODEX_KeyService::ClientCreateCallback::ClientCreateCallback(), CODEX_VSS::Combinatoric< NumT, ThreshT >::count(), CODEX_Server::QuorumBuilderAct::handler(), CODEX_APSS::MessageVerifier::handler(), CODEX_KeyService::DelegateResponseVerifier::handler(), CODEX_KeyService::DelegateRequestDistributor::handler(), CODEX_KeyService::ClientMessageVerifier::handler(), CODEX_KeyService::ClientMessageSigner::handler(), CODEX_VSS::SubshareLabel< LabelType >::marshal(), CODEX_KeyService::KeyInfo::marshal(), CODEX_VSS::LabeledShare< ShareType, OneWay >::marshal(), CODEX_VSS::ShareLabel< _ShareType, _OneWay >::marshal(), CODEX_VSS::ModExpFunctionalArgs::marshal(), CODEX_VSS::Combinatoric< NumT, ThreshT >::marshal(), CODEX_KeyService::SignWriteCallback::operator()(), CODEX_KeyService::SignReadCallback::operator()(), CODEX_KeyService::SignCreateCallback::operator()(), CODEX_VSS::ModExpFunctional::operator()(), CODEX_KeyService::ClientReadCallback::operator()(), CODEX_KeyService::ClientCreateCallback::operator()(), CODEX_VSS::Combinatoric< NumT, ThreshT >::operator+=(), CODEX_Server::ServerState::readElGamalShares(), CODEX_VSS::Combinatoric< NumT, ThreshT >::recover(), CODEX_APSS::SecretManagement::sendFinished(), CODEX_Server::ServerState::serviceKey(), CODEX_Server::ServerState::setEGShareCallback(), and CODEX_Server::ServerState::setRSAShareCallback().

int OctetString::marshal (  unsigned char **  pp  )  const [virtual]

This function creates a serialized representation of the object, which is returned through the argument pp. This must be overridden by the concrete derived class. Parameters: pp  Serialized form of the object Returns: Length of the marshalled data Implements CODEX_ASN1::Base. Definition at line 80 of file OctetString.cc. Referenced by CODEX_Client::WriteKeyMsg::marshal(), CODEX_Client::ReadKeyMsg::marshal(), CODEX_Client::KeyStoredMsg::marshal(), CODEX_Client::CreateKeyMsg::marshal(), CODEX_Client::BoundNameMsg::marshal(), and CODEX_Client::BlindKeyMsg::marshal().

void * OctetString::unmarshal (  void *  bogus, unsigned char **  pp, long  length )  [virtual]

This function takes a serialized representation of the object and recreates the object representation. This must be overridden by the concrete derived class. Parameters: bogus  Included for compatibility with OpenSSL ASN.1 macros pp  Serialized form of the data length  Number of bytes of pp to unmarshal Returns: success or failure of the unmarshalling Implements CODEX_ASN1::Base. Definition at line 86 of file OctetString.cc. Referenced by CODEX_Client::WriteKeyMsg::unmarshal(), CODEX_Client::ReadKeyMsg::unmarshal(), CODEX_Client::KeyStoredMsg::unmarshal(), CODEX_Client::CreateKeyMsg::unmarshal(), CODEX_Client::BoundNameMsg::unmarshal(), and CODEX_Client::BlindKeyMsg::unmarshal().

---

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

• OctetString.h
• OctetString.cc

---