PdfSecurityManager Class


PdfSecurityManager Class

Applies security to an existing PDF document: encryption (passwords, permissions, key size and algorithm) and digital signing with a PFX certificate. Load a document with one of the Load overloads, configure it, then persist with Save(String) / GetDocument.

Inheritance Hierarchy

SystemObject
SelectPdf.UniversalPdfSecurityManager

Namespace: SelectPdf.Universal
Assembly: SelectPdf.Universal (in SelectPdf.Universal.dll) Version: 26.5

Syntax

Copy

public class PdfSecurityManager : IDisposable

Public Class PdfSecurityManager
	Implements IDisposable

The PdfSecurityManager type exposes the following members.

Constructors

	Name	Description
	PdfSecurityManager	Initializes a new instance of the PdfSecurityManager class.

Top

Properties

	Name	Description
	CanAccessibilityCopyContent	Gets or sets whether copying content for accessibility is allowed.
	CanAssembleDocument	Gets or sets whether assembling the document is allowed.
	CanCopyContent	Gets or sets whether copying content is allowed.
	CanEditAnnotations	Gets or sets whether editing annotations is allowed.
	CanEditContent	Gets or sets whether editing content is allowed.
	CanFillFields	Gets or sets whether filling form fields is allowed.
	CanFullQualityPrint	Gets or sets whether full-quality printing is allowed.
	CanPrint	Gets or sets whether printing is allowed.
	DigestAlgorithm	Gets or sets the hash algorithm the signature added by Sign is computed with.
	EnableLtv	Gets or sets a value indicating whether the signature added by Sign is made LTV-enabled (long-term validation) when the document is saved.
	EncryptionAlgorithm	Gets or sets the encryption algorithm. Defaults to AES for a document that is not encrypted; an encrypted document keeps its own.
	EncryptionKeySize	Gets or sets the encryption key size. Defaults to EncryptKey256BitRevision6 (AES-256) for a document that is not encrypted; an encrypted document keeps its own.
	EncryptMetadata	Gets or sets whether the document's XMP metadata stream is encrypted with the rest of the document. The default value is true, or what the loaded document already does.
	OwnerPassword	Gets or sets the owner (permissions) password.
	RevocationCheckEnabled	Gets or sets whether ValidateSignatures asks the issuer of each signer's certificate whether it has been revoked, through OCSP or a certificate revocation list. The default value is false.
	SignatureBackgroundImage	Gets or sets an image drawn behind the text of the visible signature Sign adds - a company logo, a seal, a scanned handwritten signature - in place of the default mark.
	SignatureBackgroundOpacity	Gets or sets how strongly the background of the visible signature is drawn, from 0 (no background) to 1 (the image's own colours).
	UserPassword	Gets or sets the user (open) password.

Top

Methods

	Name	Description
	Close	Closes the loaded document and releases its resources.
	CompleteExternalSignature(Byte, String, String, IListByte, PdfSignatureDigest, Byte)	Writes the signature value into a prepared document held in memory and returns the signed document.
	CompleteExternalSignature(String, String, String, IListByte, PdfSignatureDigest, Byte)	Writes the signature value into a document prepared with PrepareExternalSignature(IListByte, String) and saves the signed document.
	Dispose	Releases the loaded document, the same as Close. Lets the PdfSecurityManager be used in a using statement. Calling it after Close, or more than once, does nothing.
	GetDocument	Returns the current state as a new PdfDocument.
	Load(Byte)	Loads a PDF document from a byte array.
	Load(PdfDocument)	Loads an existing PdfDocument.
	Load(Stream)	Loads a PDF document from a stream.
	Load(String)	Loads a PDF document from a file.
	Load(Byte, String)	Loads a password-protected PDF document from a byte array.
	Load(PdfDocument, String)	Loads an existing PdfDocument with a password.
	Load(Stream, String)	Loads a password-protected PDF document from a stream.
	Load(String, String)	Loads a password-protected PDF document from a file.
	PrepareExternalSignature(IListByte, String)	Prepares the PDF document for a signature produced later, outside this call: the document is given a signature field with an empty, reserved signature, and the request to be signed is returned.
	PrepareExternalSignature(IListByte, String, String, String, String, Int32, RectangleF)	Prepares the PDF document for a signature produced later, recording the reason, location and contact info and placing a visible signature on the given page.
	Save	Saves the document (with the applied security) and returns the bytes.
	Save(Stream)	Saves the document (with the applied security) to a stream.
	Save(String)	Saves the document (with the applied security) to a file.
	Sign(IPdfExternalSigner)	Signs the PDF document with an external signer - a key held in a hardware security module, a smart card or a key service.
	Sign(IPdfExternalSigner, String)	Signs the PDF document with an external signer.
	Sign(String, String)	Signs the PDF document with the specified PFX certificate.
	Sign(String, String, String)	Signs the PDF document with the specified PFX certificate.
	Sign(IPdfExternalSigner, String, String, String, String)	Signs the PDF document with an external signer, recording the reason, location and contact info.
	Sign(String, String, String, String, String, String)	Signs the PDF document, recording the reason, location and contact info.
	Sign(IPdfExternalSigner, String, String, String, String, Int32, RectangleF)	Signs the PDF document with an external signer and places a visible signature on the given page.
	Sign(IPdfExternalSigner, String, String, String, String, Int32, RectangleF, TimeStampAuthority)	Signs the PDF document with an external signer and, optionally, timestamps it via the specified time-stamp authority.
	Sign(String, String, String, String, String, String, Int32, RectangleF)	Signs the PDF document and places a visible signature on the given page.
	Sign(String, String, String, String, String, String, Int32, RectangleF, TimeStampAuthority)	Signs the PDF document and, optionally, timestamps it via the specified time-stamp authority.
	ValidateSignatures	Validates every digital signature of the loaded document, trusting the certificates in the system's trusted store.
	ValidateSignatures(PdfDigitalCertificatesCollection)	Validates every digital signature of the loaded document, trusting the given certificates as roots - for example your organisation's own certificate authority - in addition to the system's trusted store.

Top

Example

Copy

PdfSecurityManager manager = new PdfSecurityManager();
manager.Load("document.pdf");
manager.EncryptionAlgorithm = PdfEncryptionAlgorithm.AES;
manager.EncryptionKeySize = PdfEncryptionKeySize.EncryptKey128Bit;
manager.UserPassword = "open123";
manager.OwnerPassword = "owner456";
manager.CanPrint = true;
manager.Save("encrypted.pdf");
manager.Close();

Dim manager As New PdfSecurityManager()
manager.Load("document.pdf")
manager.EncryptionAlgorithm = PdfEncryptionAlgorithm.AES
manager.EncryptionKeySize = PdfEncryptionKeySize.EncryptKey128Bit
manager.UserPassword = "open123"
manager.OwnerPassword = "owner456"
manager.CanPrint = True
manager.Save("encrypted.pdf")
manager.Close()

Reference

SelectPdf.Universal Namespace