SecurityHandler properties

appearances

docEncrypt

name

signValidate

digitalIDs

isLoggedIn

signAuthor

signVisible

directories

loginName

signFDF

uiName

directoryHandlers

loginPath

signInvisible

validateFDF

docDecrypt

 

 

 

appearances

5.0

 

S 

 

An array containing the language-dependent names of the available user-configured appearances for the specified security handler. Appearances are used to create the on-page visual representation of a signature when signing a signature field. The name of an appearance can be specified as a signature info object property when signing a signature field using the Field object signatureSign method.

Acrobat provides a standard signature appearance module that is used by Adobe signature plug-ins and that can also be used by third-party signature plug-ins. This standard signature appearance module is preconfigured with one appearance and can be configured by users to contain more appearances. The name of the one pre-configured appearance, called Standard Text in the user interface, is not returned by this property.

If a security handler does not support selection of appearances, this property will return null.

Type

Array

Access

R

digitalIDs

6.0

 

S 

 

The certificates that are associated with the currently selected digital IDs for this security handler.

Type

Object

Access

R

The return value is a generic object with the following properties:

Property

Type

Version

Description

oEndUserSignCert 

Certificate object

6.0

The certificate that is associated with the currently selected digital IDs that is to be used by this SecurityHandler object when signing. The property is undefined if there is no current selection.

oEndUserCryptCert 

Certificate object

6.0

The certificate that is associated with the currently selected digital IDs that is to be used when encrypting a document with this SecurityHandler object. The property is undefined if there is no current selection.

certs 

Array of Certificate
objects

6.0

An array of certificates corresponding to the list of all digital IDs that are available for this SecurityHandler object.

stores 

Array of Strings

6.0

An array of strings, one for every Certificate object, identifying the store where the digital ID is stored. The string values are up to the security handler. For Adobe.PPKLite the valid values are ‘PKCS12’ and ‘MSCAPI’.

The Adobe.PPKLite security handler returns all currently available digital IDs present in Password-protected digital ID files (both PKCS#12 and APF) and, on Windows, IDs present in the Windows (MSCAPI) store.

Both oEndUserSignCert and oEndUserCryptCert properties can be set using the user-interface. oEndUserSignCert can also be set using the login method. This means that oEndUserCryptCert will only be returned when using a Security Handler object that is obtained using the getHandler method with bUIEngine set to true.

Example

Export to a file the certificate that is associated with the currently selected digital IDs.

   var sh = security.getHandler( "Adobe.PPKMS", true );

   var ids = sh.digitalIDs;

   var oCert = ids.oEndUserSignCert;

   security.exportToFile( oCert, "/c/MySigningCert.cer" );

directories

6.0

 

S 

 

An array of the available Directory objects for this Security Handler. New Directory objects can be created using the newDirectory method.

Type

Array

Access

R

directoryHandlers

6.0

 

S 

 

An array containing the language-independent names of the available directory handlers for the specified security handler. For example, the Adobe.PPKMS security handler has a directory handler named Adobe.PPKMS.ADSI that supports queries using the Microsoft Active Directory Script Interface (ADSI). Valid directory handler names are required when activating a new Directory object using its info property.

Type

Array

Access

R

docDecrypt

6.0

 

S 

 

Returns true, if the security handler is capable of decrypting PDF files.

Type

Boolean

Access

R

docEncrypt

6.0

 

S 

 

Returns true, if the security handler is capable of encrypting PDF files.

Type

Boolean

Access

R

isLoggedIn

5.0

 

S 

 

Returns true if currently logged into this SecurityHandler object. See the login method.

Different security handlers will have their own rules for determining the value of this property. The Adobe.PPKLite handler will return true if a user is logged in to a profile file (also called credential file, implemented as a PKCS#12 file). Adobe.PPKMS will always return true.

Type

Boolean

Access

R

Example

Generic script to illustrate isLoggedIn.

   var ppklite = security.getHandler("Adobe.PPKLite", true);

   console.println( "Is logged in = " + ppklite.isLoggedIn ); // False

   ppklite.login( "dps017", "/C/signatures/DPSmith.pfx");

   console.println( "Is logged in = " + ppklite.isLoggedIn ); // True

loginName

5.0

 

S 

 

The name associated with the actively selected signing digital ID for the security handler. This may require that the login method be called to select a signing credential. The return value is null if a signing credential is not selected or if the security handler does not support this property.

Type

String

Access

R

loginPath

5.0

 

S 

 

The device-independent path to the user’s profile file used to log in to the security handler. The return value is null if no one is logged in, if the security handler does not support this property, or if this property is irrelevant for the currently logged in user.

Type

String

Access

R

name

5.0

 

S 

 

The language-independent name of the security handler. Example values for the Default Certificate, Windows Certificate, and Entrust Security Handlers are Adobe.PPKLite, Adobe.PPKMS, and Entrust.PPKEF. All security handlers must support this property.

Type

String

Access

R

signAuthor

6.0

 

S 

 

Specifies whether the security handler is capable of generating certified documents. A certified document is signed with both a byte-range signature and an object signature. Object signatures, which are generated by traversing the document’s object tree, are used to detect and prevent modifications to a document. See the mdp property of the SignatureInfo object for details regarding modification detection and prevention (MDP) settings.

Type

Boolean

Access

R

signFDF

6.0

 

S 

 

Indicates that the security handler is capable of signing FDF files.

Type

Boolean

Access

R

signInvisible

5.0

 

S 

 

Specifies whether the security handler is capable of generating invisible signatures.

Type

Boolean

Access

R

signValidate

6.0

 

S 

 

Indicates whether the security handler is capable of validating signatures.

Type

Boolean

Access

R

signVisible

5.0

 

S 

 

Specifies whether the security handler is capable of generating visible signatures.

Type

Boolean

Access

R

uiName

5.0

 

S 

 

The language-dependent string for the security handler. This string is suitable for user interfaces. All security handlers must support this property.

Type

String

Access

R

validateFDF

6.0

 

S 

 

Returns true, if the security handler is capable of validating signatures over FDF files.

Type

Boolean

Access

R