SFBX509Chain

Wrapper Class for the IX509Chain interface.

#include <SFBX509Chain.h.hpp>

class SFBX509Chain : public SFBWebOpts;

SFMTYPEDEFWRAPPER(SFBX509Chain)

Inheritance diagram

Version

BREW 2.0	BREW 2.1	BREW 3.1	BREW 4.0
O	O	O	O

Reference

BREW API IX509Chain

Member

Public Functions
`SFCError`	AddCert( `SInt32` webOpt , `UInt08ConstPtr` certificate , `SInt32` certificateLength ) Add the list of WebOpts to the current web option set. An alternate to SFBX509Chain::AddOpt () to add certs.
`SFCError`	GetBasic( `SInt32` webOpt , `SInt32` index , `X509BasicCert*` basic ) Get basic and small fields in a certificate.
`SFCError`	GetField( `SInt32` webOpt , `SInt32` certIndex , `SInt32` which , `UInt08ConstHandle` field , `UInt32Ptr` fieldLength ) Get a field out of an X.509 certificate.
`SFCError`	GetFieldPart( `X509PartRequest const &` request , `X509CertPart*` response ) Get individual extensions or parts out of the subject or issuer.
`SFCError`	GetRSAKey( `SInt32` webOpt , `SInt32` index , `SFBRSASmpPtr` irsa ) Get an the RSA key as an IRSA object ready for use.
`SFBRSASmp`	GetRSAKey( `SInt32` webOpt , `SInt32` index ) Get an the RSA key as an IRSA object ready for use.
static `SFBX509ChainSmp`	NewInstance( `SFCErrorPtr` exception = null ) Create a new SFBX509Chain instance.
static `SFBX509ChainSmp`	NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) Create a new SFBX509Chain instance.
`Void`	Verify( `X509TrustResult*` trustResult , `SFXCallbackPtr` callback , `...` ) Complete and verify the certificate chain.
`Void`	VerifyV( `X509TrustResult*` trustResult , `SFXCallbackPtr` callback , `WebOpt const &` opts ) Complete and verify the certificate chain.
`SFCError`	AddOpt( `WebOptPtr` opts ) (inherits from SFBWebOpts) Add the list of WebOpts to the current web option set.
`SFCError`	GetOpt( `SInt32` id , `SInt32` index , `WebOptPtr` opt ) (inherits from SFBWebOpts) Get a WebOpt in the list of WebOpts in SFBWebOpts instance matching OptId in.
`SFCError`	QueryInterface( `AEECLSID` clsid , `VoidHandle` handle ) (inherits from SFBQuery) Ask an object for another API contract from the object in question.
`SFCError`	QueryInterface( `AEECLSID` clsid , `SFBBaseSmpPtr` handle ) (inherits from SFBQuery) Ask an object for another API contract from the object in question.
`SFBBaseSmp`	QueryInterface( `AEECLSID` clsid ) (inherits from SFBQuery) Ask an object for another API contract from the object in question.
`SFCError`	RemoveOpt( `SInt32` id , `SInt32` index ) (inherits from SFBWebOpts) Remove the nIndex'th WebOpt matching OptId.
`Void`	Self( `AEECLSID` clsidReq , `SFBQuerySmpPtr` clone , `AEECLSID` clsidImp ) (inherits from SFBQuery) Helper macro for those implementing an object with a single interface.
`SFBQuerySmp`	Self( `AEECLSID` clsidReq , `AEECLSID` clsidImp ) (inherits from SFBQuery) Helper macro for those implementing an object with a single interface.

Protected Functions
static `SFBBaseSmp`	FactoryByCreate( `AEECLSID` id , `SFCErrorPtr` exception = null ) (inherits from SFBBase) Create the instance for the specified ClassID's interface.
static `SFBBaseSmp`	FactoryByQuery( `SFBQuerySmpConstRef` query , `AEECLSID` id , `SFCErrorPtr` exception = null ) (inherits from SFBBase) Create the instance for the specified ClassID's interface using the SFBQuery instance.

SFBX509Chain::AddCert

Add the list of WebOpts to the current web option set. An alternate to SFBX509Chain::AddOpt () to add certs.

[ public ]
SFCError AddCert(
    SInt32 webOpt                // WEBOPT_X509_ROOT_CERT, .._LEAF_CERT or ... _BRANCH_CERT 
    UInt08ConstPtr certificate   // pointer to DER encoded certificate in buffer
    SInt32 certificateLength     // length of certificate
);

Reference

BREW API IX509Chain_AddCert

SFBX509Chain::GetBasic

Get basic and small fields in a certificate.

[ public ]
SFCError GetBasic(
    SInt32 webOpt          // which WebOpt ID to get them from- WEBOPT_X509_ROOT_CERT, _LEAF_CERT or ... _BRANCH_CERT or .._CHAIN_CERT
    SInt32 index           // the index of certificate of the given WebOpt ID / type 
    X509BasicCert* basic   // place to put fields retrieved. Caller supplies the storage
);

Reference

BREW API IX509CHAIN_GetBasic

SFBX509Chain::GetField

Get a field out of an X.509 certificate.

[ public ]
SFCError GetField(
    SInt32 webOpt             // which WebOpt ID set to get them from WEBOPT_X509_ROOT_CERT, _LEAF_CERT or ... _BRANCH_CERT 
    SInt32 certIndex          // the index of certificate of the given WebOpt ID / type 
    SInt32 which              // which field in the certificate to get. One of X509CHAIN_FIELD_* 
    UInt08ConstHandle field   // place to put pointer to field 
    UInt32Ptr fieldLength     // place to length of field
);

Reference

BREW API IX509CHAIN_GetField

SFBX509Chain::GetFieldPart

Get individual extensions or parts out of the subject or issuer.

[ public ]
SFCError GetFieldPart(
    X509PartRequest const & request   // the description of the request 
    X509CertPart* response            // filled in with the response
);

Reference

BREW API IX509CHAIN_GetFieldPart

SFBX509Chain::GetRSAKey

Get an the RSA key as an IRSA object ready for use.

[ public ]
SFCError GetRSAKey(
    SInt32 webOpt       // which WebOpt set to get them from WEBOPT_X509_ROOT_CERT, _LEAF_CERT or ... _BRANCH_CERT 
    SInt32 index        // the index of certificate of the given option type to get
    SFBRSASmpPtr irsa   // place to put pointer to newly created IRSA interface
);

[ public ]
SFBRSASmp GetRSAKey(
    SInt32 webOpt   // which WebOpt set to get them from WEBOPT_X509_ROOT_CERT, _LEAF_CERT or ... _BRANCH_CERT s
    SInt32 index    // the index of certificate of the given option type to get
);

Reference

BREW API IX509CHAIN_GetRSAKey

SFBX509Chain::NewInstance

Create a new SFBX509Chain instance.

[ public, static ]
SFBX509ChainSmp NewInstance(
    SFCErrorPtr exception = null   // Error
);

[ public, static ]
SFBX509ChainSmp NewInstance(
    AEECLSID id                    // Class ID
    SFCErrorPtr exception = null   // Error
);

SFBX509Chain::Verify

Complete and verify the certificate chain.

[ public ]
Void Verify(
    X509TrustResult* trustResult   // place to put trust result
    SFXCallbackPtr callback        // called back when verification is complete
    ...                            // a set of web opts to use while doing Verify
);

Reference

BREW API IX509CHAIN_Verify

SFBX509Chain::VerifyV

Complete and verify the certificate chain.

[ public ]
Void VerifyV(
    X509TrustResult* trustResult   // place to put trust result
    SFXCallbackPtr callback        // called back when verification is complete
    WebOpt const & opts            // set of web opts to use while doing Verify
);

Reference

BREW API IX509CHAIN_VerifyV