OfficeSecurityProvider
OfficeIMO.Security
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
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[]
- algorithm string
- inclusiveNamespacesPrefixList string? = null
- maxOutputBytes long = 16777216
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
Returns
ICmsVerificationSessionpublic byte[] CreateXmlSignature(XmlDigitalSignatureCreationRequest request) #Creates one bounded enveloping XML signature.
Parameters
- request OfficeIMO.Security.XmlDigitalSignatureCreationRequest
Returns
byte[]public CmsDecryptionResult DecryptCms(byte[] encodedCms, X509Certificate2 recipientCertificate, CmsEnvelopeOptions? options = null) #Decrypts CMS EnvelopedData for a matching recipient certificate.
Parameters
- encodedCms byte[]
- recipientCertificate System.Security.Cryptography.X509Certificates.X509Certificate2
- options OfficeIMO.Security.CmsEnvelopeOptions? = null
Returns
CmsDecryptionResultpublic byte[] EncryptCms(byte[] content, IEnumerable<X509Certificate2> recipients, CmsEnvelopeOptions? options = null) #Creates CMS EnvelopedData for the supplied recipients.
Parameters
- content byte[]
- recipients System.Collections.Generic.IEnumerable<System.Security.Cryptography.X509Certificates.X509Certificate2>
- options OfficeIMO.Security.CmsEnvelopeOptions? = null
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[]
- allowTrailingZeroPadding bool
- maxEncodedBytes long
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[]
- keys OfficeIMO.Security.OfficeOpenPgpKeySet
- options OfficeIMO.Security.OfficeOpenPgpOptions? = null
Returns
OfficeOpenPgpMessageResultpublic 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[]
- signingCertificate System.Security.Cryptography.X509Certificates.X509Certificate2
- options OfficeIMO.Security.CmsSigningOptions? = null
- certificateChain System.Collections.Generic.IEnumerable<System.Security.Cryptography.X509Certificates.X509Certificate2>? = null
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[]
- signingCertificate System.Security.Cryptography.X509Certificates.X509Certificate2
- options OfficeIMO.Security.CmsSigningOptions? = null
- certificateChain System.Collections.Generic.IEnumerable<System.Security.Cryptography.X509Certificates.X509Certificate2>? = null
Returns
byte[]public bool Supports(OfficePublicKeySignatureAlgorithm algorithm) #Returns true when the verifier implements algorithm.
Parameters
- algorithm OfficeIMO.Security.OfficePublicKeySignatureAlgorithm
Returns
boolpublic 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
- additionalCertificates System.Collections.Generic.IEnumerable<System.Security.Cryptography.X509Certificates.X509Certificate2>? = null
- options OfficeIMO.Security.CertificateValidationOptions? = null
- purpose OfficeIMO.Security.CertificateValidationPurpose = DocumentSigning
Returns
CertificateTrustValidationResultpublic OfficePublicKeySignatureCheck Verify(OfficePublicKeySignatureAlgorithm algorithm, byte[] publicKey, byte[] data, byte[] signature) #Verifies signature over data.
Parameters
- algorithm OfficeIMO.Security.OfficePublicKeySignatureAlgorithm
- Signature scheme.
- publicKey byte[]
- For RSA, a DER SubjectPublicKeyInfo or PKCS #1 RSAPublicKey. For Ed25519, the raw 32-byte public key.
- data byte[]
- Exact signed bytes. RSA schemes hash them; Ed25519 signs them directly.
- signature byte[]
- Signature value.
Returns
OfficePublicKeySignatureCheckpublic OfficeOpenPgpVerificationResult VerifyCleartext(byte[] armoredMessage, OfficeOpenPgpKeySet keys, OfficeOpenPgpOptions? options = null) #Verifies an inline cleartext-signed message ("BEGIN PGP SIGNED MESSAGE").
Parameters
- armoredMessage byte[]
- keys OfficeIMO.Security.OfficeOpenPgpKeySet
- options OfficeIMO.Security.OfficeOpenPgpOptions? = null
Returns
OfficeOpenPgpVerificationResultpublic CmsVerificationResult VerifyCms(byte[] encodedCms, CmsVerificationOptions? options = null, CertificateValidationPurpose signerCertificatePurpose = DocumentSigning) #Verifies encapsulated CMS SignedData.
Parameters
- encodedCms byte[]
- options OfficeIMO.Security.CmsVerificationOptions? = null
- signerCertificatePurpose OfficeIMO.Security.CertificateValidationPurpose = DocumentSigning
Returns
CmsVerificationResultpublic CmsVerificationResult VerifyCmsDetached(byte[] encodedCms, byte[] detachedContent, CmsVerificationOptions? options = null, CertificateValidationPurpose signerCertificatePurpose = DocumentSigning) #Verifies detached CMS SignedData against the exact supplied content.
Parameters
- encodedCms byte[]
- detachedContent byte[]
- options OfficeIMO.Security.CmsVerificationOptions? = null
- signerCertificatePurpose OfficeIMO.Security.CertificateValidationPurpose = DocumentSigning
Returns
CmsVerificationResultpublic 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[]
- signedContent byte[]
- keys OfficeIMO.Security.OfficeOpenPgpKeySet
- options OfficeIMO.Security.OfficeOpenPgpOptions? = null
Returns
OfficeOpenPgpVerificationResultpublic 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[]
- timestampedData byte[]
- certificateOptions OfficeIMO.Security.CertificateValidationOptions? = null
- maxEncodedBytes long = 16777216
- maxCertificates int = 64
Returns
Rfc3161TimestampVerificationResultpublic XmlDigitalSignatureVerificationResult VerifyXmlSignature(XmlDigitalSignatureVerificationRequest request) #Verifies XML signature math and bounded local-reference processing independently of trust.
Parameters
- request OfficeIMO.Security.XmlDigitalSignatureVerificationRequest
Returns
XmlDigitalSignatureVerificationResult