# OfficePackageSigningOptions

Options for signing an Open Packaging Convention package.

Class 

`OfficeIMO.Security`

**Namespace**

`OfficeIMO.Security`

**Assembly**

`OfficeIMO.Core`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[OfficePackageSignatureWriter.cs:17](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Security/PackageSignatures/OfficePackageSignatureWriter.cs#L17)

**Modifiers**

sealed

Options for signing an Open Packaging Convention package.

## Inheritance

- object
- OfficePackageSigningOptions

Filter members 

Show inherited

## Constructors

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

[OfficePackageSignatureWriter.cs:17](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Security/PackageSignatures/OfficePackageSignatureWriter.cs#L17)

## 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 IReadOnlyCollection<string>? PartUris { get; set; }` [#](#property-parturis)

[OfficePackageSignatureWriter.cs:15](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Security/PackageSignatures/OfficePackageSignatureWriter.cs#L15)

Package-part URIs to sign, or null to sign every eligible package part.

`public bool IncludePackageRelationships { get; set; }` [#](#property-includepackagerelationships)

[OfficePackageSignatureWriter.cs:17](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Security/PackageSignatures/OfficePackageSignatureWriter.cs#L17)

Whether to authenticate selected root-package relationships.

`public bool IncludePartRelationships { get; set; }` [#](#property-includepartrelationships)

[OfficePackageSignatureWriter.cs:19](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Security/PackageSignatures/OfficePackageSignatureWriter.cs#L19)

Whether to authenticate relationships owned by signed parts.

`public string HashAlgorithm { get; set; }` [#](#property-hashalgorithm)

[OfficePackageSignatureWriter.cs:21](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Security/PackageSignatures/OfficePackageSignatureWriter.cs#L21)

XML DSig digest algorithm URI. The implementation accepts its bounded supported set only.

`public string? SignatureId { get; set; }` [#](#property-signatureid)

[OfficePackageSignatureWriter.cs:23](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Security/PackageSignatures/OfficePackageSignatureWriter.cs#L23)

Optional XML signature identifier.

`public DateTimeOffset? SigningTime { get; set; }` [#](#property-signingtime)

[OfficePackageSignatureWriter.cs:25](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Security/PackageSignatures/OfficePackageSignatureWriter.cs#L25)

Optional signing time; UTC now is used when omitted.

`public IReadOnlyCollection<X509Certificate2>? AdditionalCertificates { get; set; }` [#](#property-additionalcertificates)

[OfficePackageSignatureWriter.cs:27](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Security/PackageSignatures/OfficePackageSignatureWriter.cs#L27)

Additional certificates to embed after the signing certificate.

`public int MaxPackageParts { get; set; }` [#](#property-maxpackageparts)

[OfficePackageSignatureWriter.cs:29](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Security/PackageSignatures/OfficePackageSignatureWriter.cs#L29)

Maximum number of package parts accepted for signing.

`public long MaxPackageBytes { get; set; }` [#](#property-maxpackagebytes)

[OfficePackageSignatureWriter.cs:31](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Security/PackageSignatures/OfficePackageSignatureWriter.cs#L31)

Maximum package size in bytes accepted for signing.

`public long MaxPartBytes { get; set; }` [#](#property-maxpartbytes)

[OfficePackageSignatureWriter.cs:33](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Security/PackageSignatures/OfficePackageSignatureWriter.cs#L33)

Maximum uncompressed size in bytes of one signed part.

`public long MaxTotalDigestBytes { get; set; }` [#](#property-maxtotaldigestbytes)

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

Maximum aggregate bytes read while calculating package digests.

`public int MaxSignedReferences { get; set; }` [#](#property-maxsignedreferences)

[OfficePackageSignatureWriter.cs:37](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Security/PackageSignatures/OfficePackageSignatureWriter.cs#L37)

Maximum authenticated part references and relationship selectors.

`public long MaxSignatureBytes { get; set; }` [#](#property-maxsignaturebytes)

[OfficePackageSignatureWriter.cs:39](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Security/PackageSignatures/OfficePackageSignatureWriter.cs#L39)

Maximum generated XML signature size in bytes.

`public int MaxCertificates { get; set; }` [#](#property-maxcertificates)

[OfficePackageSignatureWriter.cs:41](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Security/PackageSignatures/OfficePackageSignatureWriter.cs#L41)

Maximum number of certificates embedded in the signature.

`public long MaxCertificateBytes { get; set; }` [#](#property-maxcertificatebytes)

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

Maximum encoded size in bytes of one certificate.

`public long MaxTotalCertificateBytes { get; set; }` [#](#property-maxtotalcertificatebytes)

[OfficePackageSignatureWriter.cs:45](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Security/PackageSignatures/OfficePackageSignatureWriter.cs#L45)

Maximum aggregate encoded certificate bytes.

<!-- PowerForge markdown artifact sha256:0E9634229D28524D55A3D11930A3963416E890A09283AA580968CF54A7E67FF8 -->
