# OfficeSecurityProvider

Default OfficeIMO cryptographic provider backed by the dependencies carried by this package.

Class 

`OfficeIMO.Security`

**Namespace**

`OfficeIMO.Security`

**Assembly**

`OfficeIMO.Security`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[OfficeSecurityProvider.cs:20](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Security/OfficeSecurityProvider.cs#L20)

**Implements**

`IOfficeSecurityProvider` `IOfficePublicKeySignatureVerifier` `IOfficeOpenPgpProvider` `IOfficeRevocationValidator`

**Modifiers**

sealed

Default OfficeIMO cryptographic provider backed by the dependencies carried by this package.

## Inheritance

- object
- OfficeSecurityProvider

## Usage

Explore 1 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

### Returned or exposed by 1

- Property [OfficeSecurityProvider.Default](/api/security/officeimo-security-officesecurityprovider/#property-default)

Filter members 

Show inherited

## Constructors

`public OfficeSecurityProvider()` [#](#constructor-ctor)

## Methods

`public byte[] CanonicalizeXml(byte[] xml, string algorithm, string? inclusiveNamespacesPrefixList = null, long maxOutputBytes = 16777216)` [#](#method-canonicalizexml-byte-string-string-int64)

[OfficeSecurityProvider.cs:110](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Security/OfficeSecurityProvider.cs#L110)

Canonicalizes a bounded XML document using an explicitly supported XML DSig algorithm.

Parameters

**xml byte[] required**

**algorithm string required**

**inclusiveNamespacesPrefixList string? = null optional**

**maxOutputBytes long = 16777216 optional**

Returns

`byte[]`

`public ICmsVerificationSession CreateCmsVerificationSession(CmsVerificationOptions options)` [#](#method-createcmsverificationsession-officeimo-security-cmsverificationoptions)

[OfficeSecurityProvider.cs:54](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Security/OfficeSecurityProvider.cs#L54)

Creates a bounded CMS verification session whose aggregate timestamp limits are shared across every verification performed by that session.

Parameters

**options OfficeIMO.Security.CmsVerificationOptions required**

Returns

`ICmsVerificationSession`

`public byte[] CreateXmlSignature(XmlDigitalSignatureCreationRequest request)` [#](#method-createxmlsignature-officeimo-security-xmldigitalsignaturecreationrequest)

[OfficeSecurityProvider.cs:98](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Security/OfficeSecurityProvider.cs#L98)

Creates one bounded enveloping XML signature.

Parameters

**request OfficeIMO.Security.XmlDigitalSignatureCreationRequest required**

Returns

`byte[]`

`public CmsDecryptionResult DecryptCms(byte[] encodedCms, X509Certificate2 recipientCertificate, CmsEnvelopeOptions? options = null)` [#](#method-decryptcms-byte-security-cryptography-x509certificates-x509certificate2-officeimo-security-cmsenvelopeoptions)

[OfficeSecurityProvider.cs:72](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Security/OfficeSecurityProvider.cs#L72)

Decrypts CMS EnvelopedData for a matching recipient certificate.

Parameters

**encodedCms byte[] required**

**recipientCertificate System.Security.Cryptography.X509Certificates.X509Certificate2 required**

**options OfficeIMO.Security.CmsEnvelopeOptions? = null optional**

Returns

`CmsDecryptionResult`

`public byte[] EncryptCms(byte[] content, IEnumerable<X509Certificate2> recipients, CmsEnvelopeOptions? options = null)` [#](#method-encryptcms-byte-collections-generic-ienumerable-system-security-cryptography-x509certificates-x509certificate2-officeimo-security-cmsenvelopeoptions)

[OfficeSecurityProvider.cs:65](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Security/OfficeSecurityProvider.cs#L65)

Creates CMS EnvelopedData for the supplied recipients.

Parameters

**content byte[] required**

**recipients System.Collections.Generic.IEnumerable<System.Security.Cryptography.X509Certificates.X509Certificate2> required**

**options OfficeIMO.Security.CmsEnvelopeOptions? = null optional**

Returns

`byte[]`

`public byte[] NormalizeAsn1Object(byte[] encoded, bool allowTrailingZeroPadding, long maxEncodedBytes)` [#](#method-normalizeasn1object-byte-boolean-int64)

[OfficeSecurityProvider.cs:121](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Security/OfficeSecurityProvider.cs#L121)

Normalizes one bounded DER/BER object, optionally trimming PDF-style trailing zero padding.

Parameters

**encoded byte[] required**

**allowTrailingZeroPadding bool required**

**maxEncodedBytes long required**

Returns

`byte[]`

`public OfficeOpenPgpMessageResult OpenMessage(byte[] message, OfficeOpenPgpKeySet keys, OfficeOpenPgpOptions? options = null)` [#](#method-openmessage-byte-officeimo-security-officeopenpgpkeyset-officeimo-security-officeopenpgpoptions)

[OfficeSecurityProvider.cs:165](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Security/OfficeSecurityProvider.cs#L165)

Opens an OpenPGP message ("BEGIN PGP MESSAGE" or binary): decrypts it with a supplied secret key when it is encrypted, checks integrity, and verifies any signatures over the literal data.

Parameters

**message byte[] required**

**keys OfficeIMO.Security.OfficeOpenPgpKeySet required**

**options OfficeIMO.Security.OfficeOpenPgpOptions? = null optional**

Returns

`OfficeOpenPgpMessageResult`

`public byte[] SignCmsDetached(byte[] content, X509Certificate2 signingCertificate, CmsSigningOptions? options = null, IEnumerable<X509Certificate2>? certificateChain = null)` [#](#member-615d3c1bbc18fb63d44c5c67)

[OfficeSecurityProvider.cs:20](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Security/OfficeSecurityProvider.cs#L20)

Creates detached CMS SignedData over the exact supplied content.

Parameters

**content byte[] required**

**signingCertificate System.Security.Cryptography.X509Certificates.X509Certificate2 required**

**options OfficeIMO.Security.CmsSigningOptions? = null optional**

**certificateChain System.Collections.Generic.IEnumerable<System.Security.Cryptography.X509Certificates.X509Certificate2>? = null optional**

Returns

`byte[]`

`public byte[] SignCmsEncapsulated(byte[] content, X509Certificate2 signingCertificate, CmsSigningOptions? options = null, IEnumerable<X509Certificate2>? certificateChain = null)` [#](#member-9c54cbd9faf3eed08a0716aa)

[OfficeSecurityProvider.cs:28](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Security/OfficeSecurityProvider.cs#L28)

Creates encapsulated CMS SignedData containing the supplied content.

Parameters

**content byte[] required**

**signingCertificate System.Security.Cryptography.X509Certificates.X509Certificate2 required**

**options OfficeIMO.Security.CmsSigningOptions? = null optional**

**certificateChain System.Collections.Generic.IEnumerable<System.Security.Cryptography.X509Certificates.X509Certificate2>? = null optional**

Returns

`byte[]`

`public bool Supports(OfficePublicKeySignatureAlgorithm algorithm)` [#](#method-supports-officeimo-security-officepublickeysignaturealgorithm)

[OfficeSecurityProvider.cs:124](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Security/OfficeSecurityProvider.cs#L124)

Returns true when the verifier implements algorithm.

Parameters

**algorithm OfficeIMO.Security.OfficePublicKeySignatureAlgorithm required**

Returns

`bool`

`public CertificateTrustValidationResult ValidateCertificate(X509Certificate2 certificate, IEnumerable<X509Certificate2>? additionalCertificates = null, CertificateValidationOptions? options = null, CertificateValidationPurpose purpose = DocumentSigning)` [#](#member-b576393eb00cef9774e25685)

[OfficeSecurityProvider.cs:80](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Security/OfficeSecurityProvider.cs#L80)

Validates certificate trust, revocation, and intended usage under caller policy.

Parameters

**certificate System.Security.Cryptography.X509Certificates.X509Certificate2 required**

**additionalCertificates System.Collections.Generic.IEnumerable<System.Security.Cryptography.X509Certificates.X509Certificate2>? = null optional**

**options OfficeIMO.Security.CertificateValidationOptions? = null optional**

**purpose OfficeIMO.Security.CertificateValidationPurpose = DocumentSigning optional**

Returns

`CertificateTrustValidationResult`

`public OfficePublicKeySignatureCheck Verify(OfficePublicKeySignatureAlgorithm algorithm, byte[] publicKey, byte[] data, byte[] signature)` [#](#method-verify-officeimo-security-officepublickeysignaturealgorithm-byte-byte-byte)

[OfficeSecurityProvider.cs:132](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Security/OfficeSecurityProvider.cs#L132)

Verifies signature over data.

Parameters

**algorithm OfficeIMO.Security.OfficePublicKeySignatureAlgorithm required**

Signature scheme.

**publicKey byte[] required**

For RSA, a DER SubjectPublicKeyInfo or PKCS #1 RSAPublicKey. For Ed25519, the raw 32-byte public key.

**data byte[] required**

Exact signed bytes. RSA schemes hash them; Ed25519 signs them directly.

**signature byte[] required**

Signature value.

Returns

`OfficePublicKeySignatureCheck`

`public OfficeOpenPgpVerificationResult VerifyCleartext(byte[] armoredMessage, OfficeOpenPgpKeySet keys, OfficeOpenPgpOptions? options = null)` [#](#method-verifycleartext-byte-officeimo-security-officeopenpgpkeyset-officeimo-security-officeopenpgpoptions)

[OfficeSecurityProvider.cs:158](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Security/OfficeSecurityProvider.cs#L158)

Verifies an inline cleartext-signed message ("BEGIN PGP SIGNED MESSAGE").

Parameters

**armoredMessage byte[] required**

**keys OfficeIMO.Security.OfficeOpenPgpKeySet required**

**options OfficeIMO.Security.OfficeOpenPgpOptions? = null optional**

Returns

`OfficeOpenPgpVerificationResult`

`public CmsVerificationResult VerifyCms(byte[] encodedCms, CmsVerificationOptions? options = null, CertificateValidationPurpose signerCertificatePurpose = DocumentSigning)` [#](#method-verifycms-byte-officeimo-security-cmsverificationoptions-officeimo-security-certificatevalidationpurpose)

[OfficeSecurityProvider.cs:35](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Security/OfficeSecurityProvider.cs#L35)

Verifies encapsulated CMS SignedData.

Parameters

**encodedCms byte[] required**

**options OfficeIMO.Security.CmsVerificationOptions? = null optional**

**signerCertificatePurpose OfficeIMO.Security.CertificateValidationPurpose = DocumentSigning optional**

Returns

`CmsVerificationResult`

`public CmsVerificationResult VerifyCmsDetached(byte[] encodedCms, byte[] detachedContent, CmsVerificationOptions? options = null, CertificateValidationPurpose signerCertificatePurpose = DocumentSigning)` [#](#method-verifycmsdetached-byte-byte-officeimo-security-cmsverificationoptions-officeimo-security-certificatevalidationpurpose)

[OfficeSecurityProvider.cs:43](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Security/OfficeSecurityProvider.cs#L43)

Verifies detached CMS SignedData against the exact supplied content.

Parameters

**encodedCms byte[] required**

**detachedContent byte[] required**

**options OfficeIMO.Security.CmsVerificationOptions? = null optional**

**signerCertificatePurpose OfficeIMO.Security.CertificateValidationPurpose = DocumentSigning optional**

Returns

`CmsVerificationResult`

`public OfficeOpenPgpVerificationResult VerifyDetached(byte[] signature, byte[] signedContent, OfficeOpenPgpKeySet keys, OfficeOpenPgpOptions? options = null)` [#](#method-verifydetached-byte-byte-officeimo-security-officeopenpgpkeyset-officeimo-security-officeopenpgpoptions)

[OfficeSecurityProvider.cs:151](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Security/OfficeSecurityProvider.cs#L151)

Verifies a detached signature (binary or armored) over the exact supplied content.

Parameters

**signature byte[] required**

**signedContent byte[] required**

**keys OfficeIMO.Security.OfficeOpenPgpKeySet required**

**options OfficeIMO.Security.OfficeOpenPgpOptions? = null optional**

Returns

`OfficeOpenPgpVerificationResult`

`public Rfc3161TimestampVerificationResult VerifyTimestamp(byte[] encodedToken, byte[] timestampedData, CertificateValidationOptions? certificateOptions = null, long maxEncodedBytes = 16777216, int maxCertificates = 64)` [#](#method-verifytimestamp-byte-byte-officeimo-security-certificatevalidationoptions-int64-int32)

[OfficeSecurityProvider.cs:89](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Security/OfficeSecurityProvider.cs#L89)

Verifies an RFC 3161 timestamp token against the exact timestamped bytes.

Parameters

**encodedToken byte[] required**

**timestampedData byte[] required**

**certificateOptions OfficeIMO.Security.CertificateValidationOptions? = null optional**

**maxEncodedBytes long = 16777216 optional**

**maxCertificates int = 64 optional**

Returns

`Rfc3161TimestampVerificationResult`

`public XmlDigitalSignatureVerificationResult VerifyXmlSignature(XmlDigitalSignatureVerificationRequest request)` [#](#method-verifyxmlsignature-officeimo-security-xmldigitalsignatureverificationrequest)

[OfficeSecurityProvider.cs:102](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Security/OfficeSecurityProvider.cs#L102)

Verifies XML signature math and bounded local-reference processing independently of trust.

Parameters

**request OfficeIMO.Security.XmlDigitalSignatureVerificationRequest required**

Returns

`XmlDigitalSignatureVerificationResult`

## Inherited Methods

`public virtual bool Equals(object? obj)` [#](#method-equals-object)

Inherited from object

Parameters

**obj object? required**

Returns

`bool`

`public virtual int GetHashCode()` [#](#method-gethashcode)

Inherited from object

Returns

`int`

`public Type GetType()` [#](#method-gettype)

Inherited from object

Returns

`Type`

`public virtual string? ToString()` [#](#method-tostring)

Inherited from object

Returns

`string?`

## Properties

`public static OfficeSecurityProvider Default { get; }` [#](#property-default)

[OfficeSecurityProvider.cs:9](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Security/OfficeSecurityProvider.cs#L9)

Gets a reusable stateless provider instance.

`public string Name { get; }` [#](#property-name)

[OfficeSecurityProvider.cs:12](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Security/OfficeSecurityProvider.cs#L12)

Gets a stable provider name for diagnostics.

<!-- PowerForge markdown artifact sha256:E2456BFDCA8F118425341711BD82EE59BB7CD97E2EEA3077F2855BB71A33EAA5 -->
