System::Security::Cryptography::Pkcs::CmsSigner Class Referencefinal
Provides API to sign objects using CMS. Doesn't sign objects by itself, use SignedCMS class to do so. Not implemented. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument. More...
Inherits System::Object.
Public Member Functions | |
| CmsSigner (const SharedPtr< X509Certificates::X509Certificate2 > &certificate) | |
| Initializes signer with X509 certificate. More... | |
| X509Certificates::X509IncludeOption | get_IncludeOption () const |
| Checks which certificates from the chain will be included into the signature. More... | |
| void | set_IncludeOption (X509Certificates::X509IncludeOption value) |
| Specifies which certificates from the chain will be included into the signature. More... | |
| SharedPtr< Oid > | get_DigestAlgorithm () const |
| Gets hash algorithm using with signature. More... | |
| void | set_DigestAlgorithm (const SharedPtr< Oid > &value) |
| Sets hash algorithm using with signature. More... | |
 Public Member Functions inherited from System::Object | |
| Object () | |
| Creates object. Initializes all internal data structures. More... | |
| virtual | ~Object () |
| Destroys object. Frees all internal data structures. More... | |
| Object (Object const &x) | |
| Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More... | |
| Object & | operator= (Object const &x) |
| Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More... | |
| Object * | SharedRefAdded () |
| Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More... | |
| int | SharedRefRemovedSafe () |
| Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More... | |
| int | RemovedSharedRefs (int count) |
| Decreases shared reference count by specified value. More... | |
| Detail::SmartPtrCounter * | WeakRefAdded () |
| Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More... | |
| void | WeakRefRemoved () |
| Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More... | |
| Detail::SmartPtrCounter * | GetCounter () |
| Gets reference counter data structure associated with the object. More... | |
| int | SharedCount () const |
| Gets current value of shared reference counter. More... | |
| void | Lock () |
| Implements C# lock() statement locking. Call directly or use LockContext sentry object. More... | |
| void | Unlock () |
| Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More... | |
| virtual bool | Equals (ptr obj) |
| Compares objects using C# Object.Equals semantics. More... | |
| virtual int32_t | GetHashCode () const |
| Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More... | |
| virtual String | ToString () const |
| Analog of C# Object.ToString() method. Enables converting custom objects to string. More... | |
| virtual ptr | MemberwiseClone () const |
| Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More... | |
| virtual const TypeInfo & | GetType () const |
| Gets actual type of object. Analog of C# System.Object.GetType() call. More... | |
| virtual bool | Is (const TypeInfo &targetType) const |
| Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More... | |
| virtual void | SetTemplateWeakPtr (uint32_t argument) |
| Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More... | |
| virtual bool | FastCast (const Details::FastRttiBase &helper, void **out_ptr) const |
| For internal purposes only. More... | |
| template<> | |
| bool | ReferenceEquals (String const &str, std::nullptr_t) |
| Specialization of Object::ReferenceEquals for case of string and nullptr. More... | |
| template<> | |
| bool | ReferenceEquals (String const &str1, String const &str2) |
| Specialization of Object::ReferenceEquals for case of strings. More... | |
Additional Inherited Members | |
| Public Types inherited from System::Object | |
| typedef SmartPtr< Object > | ptr |
| Alias for smart pointer type. More... | |
| Static Public Member Functions inherited from System::Object | |
| static bool | ReferenceEquals (ptr const &objA, ptr const &objB) |
| Compares objects by reference. More... | |
| template<typename T > | |
| static std::enable_if<!IsSmartPtr< T >::value, bool >::type | ReferenceEquals (T const &objA, T const &objB) |
| Compares objects by reference. More... | |
| template<typename T > | |
| static std::enable_if<!IsSmartPtr< T >::value, bool >::type | ReferenceEquals (T const &objA, std::nullptr_t) |
| Reference-compares value type object with nullptr. More... | |
| template<typename T1 , typename T2 > | |
| static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type | Equals (T1 const &objA, T2 const &objB) |
| Compares reference type objects in C# style. More... | |
| template<typename T1 , typename T2 > | |
| static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type | Equals (T1 const &objA, T2 const &objB) |
| Compares value type objects in C# style. More... | |
| static const TypeInfo & | Type () |
| Implements C# typeof(System.Object) construct. More... | |
| template<> | |
| bool | Equals (float const &objA, float const &objB) |
| Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More... | |
| template<> | |
| bool | Equals (double const &objA, double const &objB) |
| Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More... | |
Detailed Description
Provides API to sign objects using CMS. Doesn't sign objects by itself, use SignedCMS class to do so. Not implemented. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument.
Constructor & Destructor Documentation
◆ CmsSigner()
| System::Security::Cryptography::Pkcs::CmsSigner::CmsSigner | ( | const SharedPtr< X509Certificates::X509Certificate2 > & | certificate | ) |
Initializes signer with X509 certificate.
- Parameters
-
certificate Certificate to use for signing.
Member Function Documentation
◆ get_DigestAlgorithm()
Gets hash algorithm using with signature.
- Returns
- Oid algorithm pointer.
◆ get_IncludeOption()
| X509Certificates::X509IncludeOption System::Security::Cryptography::Pkcs::CmsSigner::get_IncludeOption | ( | ) | const |
Checks which certificates from the chain will be included into the signature.
- Returns
- Enumeration value indicating which certificates to include.
◆ set_DigestAlgorithm()
| void System::Security::Cryptography::Pkcs::CmsSigner::set_DigestAlgorithm | ( | const SharedPtr< Oid > & | value | ) |
Sets hash algorithm using with signature.
- Parameters
-
value Oid algorithm pointer.
◆ set_IncludeOption()
| void System::Security::Cryptography::Pkcs::CmsSigner::set_IncludeOption | ( | X509Certificates::X509IncludeOption | value | ) |
Specifies which certificates from the chain will be included into the signature.
- Parameters
-
value Enumeration value indicating which certificates to include.