Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

OfficeSecurityProvider

OfficeIMO.Security

Namespace
OfficeIMO.Security
Assembly
OfficeIMO.Security
Source revision
ba882f6b0d07 with working tree changes
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

Constructors

public OfficeSecurityProvider() #

Methods

public byte[] CanonicalizeXml(byte[] xml, string algorithm, string? inclusiveNamespacesPrefixList = null, long maxOutputBytes = 16777216) #

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) #

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) #

Creates one bounded enveloping XML signature.

Parameters

request OfficeIMO.Security.XmlDigitalSignatureCreationRequest required

Returns

byte[]
public CmsDecryptionResult DecryptCms(byte[] encodedCms, X509Certificate2 recipientCertificate, CmsEnvelopeOptions? options = null) #

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) #

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) #

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) #

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) #

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) #

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) #

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) #

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) #

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) #

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) #

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) #

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) #

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) #

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) #

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

Parameters

request OfficeIMO.Security.XmlDigitalSignatureVerificationRequest required

Returns

XmlDigitalSignatureVerificationResult

Properties

public static OfficeSecurityProvider Default { get; } #

Gets a reusable stateless provider instance.

public string Name { get; } #

Gets a stable provider name for diagnostics.