# SignParams

## Content

# Type Alias: SignParams

```ts
type SignParams = object;
```

Represents parameters shared across the stages of the document signing process:

1. **Preparation stage** - validates input parameters and performs necessary initialization.
   Implemented by [Pkcs7SignerBase.getSignParams](../classes/Pkcs7SignerBase#getsignparams). This stage throws
   an error if parameters are invalid or incompatible.

2. **Signature generation stage** - builds the final PKCS#7 signature container.
   Implemented by [Pkcs7SignerBase.buildSignatureContainer](../classes/Pkcs7SignerBase#buildsignaturecontainer).

An instance of SignParams is used to pass data between these stages and may
also carry additional custom data required during signing.

## Indexable

```ts
[key: string]: any
```

Additional custom properties used to transfer data between
signing stages or extend the signing workflow.

## Properties

### certificateChainPem

```ts
certificateChainPem: string[];
```

The certificate chain in PEM format.
The first certificate must be the end-entity (signing) certificate,
followed by any intermediate certificates.

***

### crls?

```ts
optional crls?: ArrayBuffer[];
```

Optional list of DER-encoded Certificate Revocation Lists (CRLs)
to include in the signature container.
If this parameter is not specified (undefined) then
it will be calculated on the base of [Pkcs7SignerBase.crls](../classes/Pkcs7SignerBase#crls).

***

### digestEncryptionAlgorithmOID

```ts
digestEncryptionAlgorithmOID: string;
```

The object identifier (OID) of the signature (digest encryption)
algorithm used to produce the signature value.

For example: RSA -> "1.2.840.113549.1.1.1".

***

### hashAlgorithmOID

```ts
hashAlgorithmOID: string;
```

The object identifier (OID) of hash algorithm used to compute the message digest
for the signature.
Note, if the signature format is set to [Pkcs7SignatureFormat.adbe\_pkcs7\_sha1](../enumerations/Pkcs7SignatureFormat#adbe_pkcs7_sha1),
the value will be ignored and SHA-1 will be used.

***

### ocsps?

```ts
optional ocsps?: ArrayBuffer[];
```

Optional list of DER-encoded OCSP responses
to include in the signature container.
If this parameter is not specified (undefined) then
it will be calculated on the base of [Pkcs7SignerBase.includeOcsp](../classes/Pkcs7SignerBase#includeocsp).