Application

class CodeSignApplication(api)

Bases: _CodeSignApplicationBase

Parameters:

api (Authenticate)

count_references(application)

Get the number of references to a Application or a ApplicationCollection that are currently in use within CodeSign Protect projects.

Parameters:

application (Application | ApplicationCollection) – class:~.models.codesign.Application or ApplicationCollection

Returns:

Integer

create(name, parent_folder='\\VED\\Code Signing\\Signing Applications', description=None, hash=None, location=None, permitted_argument_pattern=None, signatory_issuer=None, signatory_subject=None, size=None, version=None, raise_if_already_exists=False)

Create an application with specified values.

Parameters:

  • name (str) – Name of the application.

  • parent_folder (Object | str) – Config Object or Distinguished Name (DN) of the parent folder.

  • description (str) – Description of the application.

  • hash (str) – The SHA256 checksum of the application binary.

  • location (str) – The physical path where the signing application is installed.

  • permitted_argument_pattern (str) – The pattern of arguments that the signing application uses to run.

  • signatory_issuer (str) – The X.500 certificate issuer that signs the application.

  • signatory_subject (str) – The X.500 certificate subject.

  • size (int) – The size of the signing application executable.

  • version (str) – The signing application version.

  • raise_if_already_exists (bool) – If the object already exists, raise an error.

Returns:

Application

Return type:

Application

delete(application)

Delete an application.

Parameters:

application (str | Object | Application) – Application, Distinguished Name (DN) , or Config Object of the application.

enumerate(_filter=None)

Enumerate the applications.

Parameters:

_filter (str) – The partial tool name and optional trailing asterisk (*) wild card.

Returns:

list[Application]

Return type:

list[Application]

enumerate_references(application=None, application_dn=None, application_guid=None, collection=None, collection_dn=None, collection_guid=None)

Get the Distinguished Name (DN) that references a Application or a ApplicationCollection using one parameter.

Parameters:
Returns:

list[Distinguished Name (DN)]

Return type:

list[str]

get(dn=None, guid=None, id=None)

Get an application using a Distinguished Name (DN), GUID, or Identifier.

Parameters:

  • dn (str) – Distinguished Name (DN) of the application.

  • guid (str) – GUID of the application.

  • id (str) – Identifier of the application.

Returns:

Application

Return type:

Application

rename(application, new_dn)

Rename an application by giving it a new Distinguished Name (DN).

Parameters:
update(application)

Update an application.

Parameters:

application (Object | Application) – The updated Application.