// CkCsr.h: interface for the CkCsr class. // ////////////////////////////////////////////////////////////////////// // This header is generated for Chilkat 9.5.0.75 #ifndef _CkCsr_H #define _CkCsr_H #include "chilkatDefs.h" #include "CkString.h" #include "CkMultiByteBase.h" class CkPrivateKey; class CkBinData; #if !defined(__sun__) && !defined(__sun) #pragma pack (push, 8) #endif // CLASS: CkCsr class CK_VISIBLE_PUBLIC CkCsr : public CkMultiByteBase { private: // Don't allow assignment or copying these objects. CkCsr(const CkCsr &); CkCsr &operator=(const CkCsr &); public: CkCsr(void); virtual ~CkCsr(void); static CkCsr *createNew(void); void CK_VISIBLE_PRIVATE inject(void *impl); // May be called when finished with the object to free/dispose of any // internal resources held by the object. void dispose(void); // BEGIN PUBLIC INTERFACE // ---------------------- // Properties // ---------------------- // The common name of the certificate to be generated. For SSL/TLS certificates, // this would be the domain name. For email certificates this would be the email // address. // // It is the value for "CN" in the certificate's Subject's distinguished name (DN). // (This is the value for OID "2.5.4.3") // // This property is required for a CSR. // void get_CommonName(CkString &str); // The common name of the certificate to be generated. For SSL/TLS certificates, // this would be the domain name. For email certificates this would be the email // address. // // It is the value for "CN" in the certificate's Subject's distinguished name (DN). // (This is the value for OID "2.5.4.3") // // This property is required for a CSR. // const char *commonName(void); // The common name of the certificate to be generated. For SSL/TLS certificates, // this would be the domain name. For email certificates this would be the email // address. // // It is the value for "CN" in the certificate's Subject's distinguished name (DN). // (This is the value for OID "2.5.4.3") // // This property is required for a CSR. // void put_CommonName(const char *newVal); // The company or organization name for the certificate to be generated. // // It is the value for "O" in the certificate's Subject's distinguished name (DN). // (This is the value for OID "2.5.4.10") // // This property is optional. It may left empty. // void get_Company(CkString &str); // The company or organization name for the certificate to be generated. // // It is the value for "O" in the certificate's Subject's distinguished name (DN). // (This is the value for OID "2.5.4.10") // // This property is optional. It may left empty. // const char *company(void); // The company or organization name for the certificate to be generated. // // It is the value for "O" in the certificate's Subject's distinguished name (DN). // (This is the value for OID "2.5.4.10") // // This property is optional. It may left empty. // void put_Company(const char *newVal); // The company division or organizational unit name for the certificate to be // generated. // // It is the value for "OU" in the certificate's Subject's distinguished name (DN). // (This is the value for OID "2.5.4.11") // // This property is optional. It may left empty. // void get_CompanyDivision(CkString &str); // The company division or organizational unit name for the certificate to be // generated. // // It is the value for "OU" in the certificate's Subject's distinguished name (DN). // (This is the value for OID "2.5.4.11") // // This property is optional. It may left empty. // const char *companyDivision(void); // The company division or organizational unit name for the certificate to be // generated. // // It is the value for "OU" in the certificate's Subject's distinguished name (DN). // (This is the value for OID "2.5.4.11") // // This property is optional. It may left empty. // void put_CompanyDivision(const char *newVal); // The two-letter uppercase country abbreviation, such as "US", for the certificate // to be generated. // // It is the value for "C" in the certificate's Subject's distinguished name (DN). // (This is the value for OID "2.5.4.6") // // This property is optional. It may left empty. // void get_Country(CkString &str); // The two-letter uppercase country abbreviation, such as "US", for the certificate // to be generated. // // It is the value for "C" in the certificate's Subject's distinguished name (DN). // (This is the value for OID "2.5.4.6") // // This property is optional. It may left empty. // const char *country(void); // The two-letter uppercase country abbreviation, such as "US", for the certificate // to be generated. // // It is the value for "C" in the certificate's Subject's distinguished name (DN). // (This is the value for OID "2.5.4.6") // // This property is optional. It may left empty. // void put_Country(const char *newVal); // The email address for the certificate to be generated. // // It is the value for "E" in the certificate's Subject's distinguished name (DN). // (This is the value for OID "1.2.840.113549.1.9.1") // // This property is optional. It may left empty. // void get_EmailAddress(CkString &str); // The email address for the certificate to be generated. // // It is the value for "E" in the certificate's Subject's distinguished name (DN). // (This is the value for OID "1.2.840.113549.1.9.1") // // This property is optional. It may left empty. // const char *emailAddress(void); // The email address for the certificate to be generated. // // It is the value for "E" in the certificate's Subject's distinguished name (DN). // (This is the value for OID "1.2.840.113549.1.9.1") // // This property is optional. It may left empty. // void put_EmailAddress(const char *newVal); // The locality (city or town) name for the certificate to be generated. // // It is the value for "L" in the certificate's Subject's distinguished name (DN). // (This is the value for OID "2.5.4.7") // // This property is optional. It may left empty. // void get_Locality(CkString &str); // The locality (city or town) name for the certificate to be generated. // // It is the value for "L" in the certificate's Subject's distinguished name (DN). // (This is the value for OID "2.5.4.7") // // This property is optional. It may left empty. // const char *locality(void); // The locality (city or town) name for the certificate to be generated. // // It is the value for "L" in the certificate's Subject's distinguished name (DN). // (This is the value for OID "2.5.4.7") // // This property is optional. It may left empty. // void put_Locality(const char *newVal); // The state or province for the certificate to be generated. // // It is the value for "S" (or "ST") in the certificate's Subject's distinguished // name (DN). (This is the value for OID "2.5.4.8") // // This property is optional. It may left empty. // void get_State(CkString &str); // The state or province for the certificate to be generated. // // It is the value for "S" (or "ST") in the certificate's Subject's distinguished // name (DN). (This is the value for OID "2.5.4.8") // // This property is optional. It may left empty. // const char *state(void); // The state or province for the certificate to be generated. // // It is the value for "S" (or "ST") in the certificate's Subject's distinguished // name (DN). (This is the value for OID "2.5.4.8") // // This property is optional. It may left empty. // void put_State(const char *newVal); // ---------------------- // Methods // ---------------------- // Generate a CSR and return the binary DER in csrData. bool GenCsrBd(CkPrivateKey &privKey, CkBinData &csrData); // Generate a CSR and return it as a PEM string. bool GenCsrPem(CkPrivateKey &privKey, CkString &outStr); // Generate a CSR and return it as a PEM string. const char *genCsrPem(CkPrivateKey &privKey); // Gets a subject field by OID, such as "2.5.4.9". See // http://www.alvestrand.no/objectid/2.5.4.html for OID values and meanings. bool GetSubjectField(const char *oid, CkString &outStr); // Gets a subject field by OID, such as "2.5.4.9". See // http://www.alvestrand.no/objectid/2.5.4.html for OID values and meanings. const char *getSubjectField(const char *oid); // Gets a subject field by OID, such as "2.5.4.9". See // http://www.alvestrand.no/objectid/2.5.4.html for OID values and meanings. const char *subjectField(const char *oid); // Loads this CSR object with a CSR PEM. All properties are set to the values found // within the CSR. bool LoadCsrPem(const char *csrPemStr); // Sets a subject field by OID, such as "2.5.4.9". See // http://www.alvestrand.no/objectid/2.5.4.html for OID values and meanings. // // The asnType can be "UTF8String", "IA5String", or "PrintableString". If you have no // specific requirement, or don't know, choose "UTF8String". // bool SetSubjectField(const char *oid, const char *value, const char *asnType); // END PUBLIC INTERFACE }; #if !defined(__sun__) && !defined(__sun) #pragma pack (pop) #endif #endif