Class PadesSigner
Class for creating PAdES signatures
Assembly: Lacuna.Pki.dll
Syntax
Constructors
|
Improve this Doc
View Source
PadesSigner()
Declaration
Properties
|
Improve this Doc
View Source
ValidationResults
Declaration
public ValidationResults ValidationResults { get; }
Property Value
Methods
|
Improve this Doc
View Source
AddAttributeCertificate(AttributeCertificate)
Declaration
public void AddAttributeCertificate(AttributeCertificate attributeCertificate)
Parameters
|
Improve this Doc
View Source
Adds a PDF metdata key and value
Declaration
public void AddMetadata(string key, string value)
Parameters
| Type |
Name |
Description |
| String |
key |
Metadata key
|
| String |
value |
Metadata value
|
|
Improve this Doc
View Source
ComputeSignature()
Declaration
public void ComputeSignature()
|
Improve this Doc
View Source
GetPadesSignature()
Declaration
public byte[] GetPadesSignature()
Returns
|
Improve this Doc
View Source
GetToSignBytes(out SignatureAlgorithm, out Byte[])
Declaration
public byte[] GetToSignBytes(out SignatureAlgorithm signatureAlgorithm, out byte[] transferData)
Parameters
Returns
|
Improve this Doc
View Source
SetCertificateStore(ICertificateStore)
Declaration
public void SetCertificateStore(ICertificateStore certStore)
Parameters
|
Improve this Doc
View Source
SetCertificateValidationConfigurator(Action<CertificateValidationOptions>)
Sets an action for configuring the signer certificate validation
Declaration
public void SetCertificateValidationConfigurator(Action<CertificateValidationOptions> configureCertificateValidation)
Parameters
|
Improve this Doc
View Source
SetCertificationLevel(PadesCertificationLevel)
Declaration
public void SetCertificationLevel(PadesCertificationLevel certLevel)
Parameters
|
Improve this Doc
View Source
SetCommitmentType(CommitmentType)
Sets the signer commitment type signed attribute
Declaration
public void SetCommitmentType(CommitmentType commitmentType)
Parameters
|
Improve this Doc
View Source
SetCustomSignatureFieldName(String)
(Optional) Sets a custom signature unique field name. Default is "SignatureX" where X is incremental on each signer starting at 1.
Declaration
public void SetCustomSignatureFieldName(string name)
Parameters
| Type |
Name |
Description |
| String |
name |
|
|
Improve this Doc
View Source
SetLocation(String)
(Optional) Sets the PDF signing location. The CPU host name or physical location of the signing.
Declaration
public void SetLocation(string location)
Parameters
| Type |
Name |
Description |
| String |
location |
|
|
Improve this Doc
View Source
SetPdfToSign(Byte[])
Declaration
public void SetPdfToSign(byte[] content)
Parameters
| Type |
Name |
Description |
| Byte[] |
content |
|
|
Improve this Doc
View Source
SetPdfToSign(Stream)
Declaration
public void SetPdfToSign(Stream stream)
Parameters
| Type |
Name |
Description |
| Stream |
stream |
|
|
Improve this Doc
View Source
SetPdfToSign(String)
Declaration
public void SetPdfToSign(string path)
Parameters
| Type |
Name |
Description |
| String |
path |
|
|
Improve this Doc
View Source
SetPolicy(IPadesPolicyMapper)
Declaration
public void SetPolicy(IPadesPolicyMapper mapper)
Parameters
|
Improve this Doc
View Source
SetPolicy(PadesPolicySpec)
Declaration
public void SetPolicy(PadesPolicySpec policy)
Parameters
|
Improve this Doc
View Source
SetPreComputedSignature(Byte[], Byte[])
Sets pre-computed signature from the client. Used in a remote key signature
Declaration
public void SetPreComputedSignature(byte[] signature, byte[] padesTransferData)
Parameters
| Type |
Name |
Description |
| Byte[] |
signature |
|
| Byte[] |
padesTransferData |
|
|
Improve this Doc
View Source
SetReason(String)
(Optional) Sets the PDF signing reason field
Declaration
public void SetReason(string reason)
Parameters
| Type |
Name |
Description |
| String |
reason |
|
|
Improve this Doc
View Source
SetSignerName(String)
(Optional) Sets the PDF signer name.
PDF 32000-1:2008: The name of the person or authority signing the document.
This value should be used ONLY WHEN it is not possible to extract the name from the signature (From the certificate of the signer.)
Declaration
public void SetSignerName(string name)
Parameters
| Type |
Name |
Description |
| String |
name |
|
|
Improve this Doc
View Source
SetSigningCertificate(PKCertificate)
Declaration
public void SetSigningCertificate(PKCertificate certificate)
Parameters
|
Improve this Doc
View Source
SetSigningCertificate(PKCertificateWithKey)
Declaration
public void SetSigningCertificate(PKCertificateWithKey certificate)
Parameters
|
Improve this Doc
View Source
SetTimestampRequester(ITimestampRequester)
Declaration
public void SetTimestampRequester(ITimestampRequester tsRequester)
Parameters
|
Improve this Doc
View Source
SetUseRandomAccessArrayMethod(Boolean)
Use in case of huge PDF files passed as byte array
Declaration
public void SetUseRandomAccessArrayMethod(bool useRandomAccessMethod)
Parameters
| Type |
Name |
Description |
| Boolean |
useRandomAccessMethod |
|
|
Improve this Doc
View Source
SetVisualRepresentation(PadesVisualRepresentation)
Declaration
[Obsolete("Use SetVisualRepresentation(PadesVisualSignature2 visualRepresentation) instead")]
public void SetVisualRepresentation(PadesVisualRepresentation visualRepresentation)
Parameters
|
Improve this Doc
View Source
SetVisualRepresentation(PadesVisualRepresentation2)
Declaration
public void SetVisualRepresentation(PadesVisualRepresentation2 visualRepresentation)
Parameters
|
Improve this Doc
View Source
VerifyParameters(Boolean)
Verifies if PadesSigner necessary parameters are set. If not, throws Exception.
Declaration
public void VerifyParameters(bool computingSignature = false)
Parameters
| Type |
Name |
Description |
| Boolean |
computingSignature |
Whether or not you will call the ComputeSignature() method to complete the siganture process in this step.
|