GpgParser - Documentation

Constructor

new GpgParser()

Source:

gpg-parser.js, line 26

Methods

(static) parseColons(input, schemaopt)

Source:

gpg-parser.js, line 111

Parses colon-delimited CSV into json and merge related lines into combined objects Useful for decoding content produced by commands using gpg --with-colons .... See gnupg/DETAILS#format-of-the-colon-listings for detailed format specification

Parameters:

Name	Type	Attributes	Default	Description
`input`	string
`schema`	Object	<optional>	`GpgParser.DefaultSchema`	Row header schema

(static) parseReaderColons(input)

Source:

gpg-parser.js, line 164

Parse content produced by gpg --with-colons ... commands. See gnupg/DETAILS#format-of-the-colon-listings for detailed format specification

Parameters:

Name	Type	Description
`input`	string

(static) parseStatusFd(input) → {GPGStatusArray}

Source:

gpg-parser.js, line 260

Parses space-delimited CSV into json objects Useful for decoding content produced by commands using gpg --status-fd N .... See gnupg/DETAILS#format-of-the-status-fd-output for detailed format specification

Parameters:

Name	Type	Description
`input`	string	Input string

Returns:

Type: GPGStatusArray

(static) Status_AssertSignatureAllowed(status, allowed)

Source:

gpg-parser.js, line 341

Parameters:

Name	Type	Description
`status`	GPGStatusArray
`allowed`	Array.<string>	List of allowed uid, fpr or keyid

(static) Status_AssertSignatureTrusted(status, options)

Source:

gpg-parser.js, line 364

Decrypt cipher text

Parameters:

Name Type Description

status GPGStatusArray

options

Object

Properties

Name Type Description

level

Object

Acceptable signer trust levels. Trust level of a specific signature is computed with respect to configured trust model

Properties

Name	Type	Description
`none`	boolean	Accept signers with no trust
`unknown`	boolean	Accept signers with unknown/undefined trust
`never`	boolean	Accept untrustowrthy signers, potentially with revoked or bad keys
`marginal`	boolean	Accept signers with marginal trust
`full`	boolean	Accept signers with full trust
`ultimate`	boolean	Accept signers with ultimate trust

allow

Object

Acceptable signature/signer expiry/revoke status

Properties

Name	Type	Description
`allow_expired_sig`	boolean	Accept expired signatures
`allow_expired_key`	boolean	Accept expired signer key
`allow_revoked_key`	boolean	Accept revoked signer key

Status_GetImportedKeys(status)

Source:

gpg-parser.js, line 313

Parameters:

Name	Type	Description
`status`	GPGStatusArray

Status_GetSigPrimaryFpr(status) → {string}

Source:

gpg-parser.js, line 327

Parameters:

Name	Type	Description
`status`	GPGStatusArray

Returns:

Primary fingerprint

Type: string

Status_GetSigResult(status) → {string}

Source:

gpg-parser.js, line 451

Parameters:

Name	Type	Description
`status`	GPGStatusArray

Returns:

Type: string

Status_GetSigTrustResult(status) → {string}

Source:

gpg-parser.js, line 466

Parameters:

Name	Type	Description
`status`	GPGStatusArray

Returns:

Type: string

Status_HasKeyword(status, keyword) → {boolean}

Source:

gpg-parser.js, line 299

Parameters:

Name	Type	Description
`status`	GPGStatusArray
`keyword`	string

Returns:

Type: boolean

Status_IsSigBad(status) → {boolean}

Source:

gpg-parser.js, line 489

Parameters:

Name	Type	Description
`status`	GPGStatusArray

Returns:

Type: boolean

Status_IsSigError(status) → {boolean}

Source:

gpg-parser.js, line 498

Parameters:

Name	Type	Description
`status`	GPGStatusArray

Returns:

Type: boolean

Status_IsSigExpired(status) → {boolean}

Source:

gpg-parser.js, line 507

Parameters:

Name	Type	Description
`status`	GPGStatusArray

Returns:

Type: boolean

Status_IsSigGood(status) → {boolean}

Source:

gpg-parser.js, line 480

Parameters:

Name	Type	Description
`status`	GPGStatusArray

Returns:

Type: boolean

Status_IsSigKeyExpired(status) → {boolean}

Source:

gpg-parser.js, line 516

Parameters:

Name	Type	Description
`status`	GPGStatusArray

Returns:

Type: boolean

Status_IsSigKeyRevoked(status) → {boolean}

Source:

gpg-parser.js, line 525

Parameters:

Name	Type	Description
`status`	GPGStatusArray

Returns:

Type: boolean

Status_IsSignerAllowed(status, allowed) → {boolean}

Source:

gpg-parser.js, line 580

Parameters:

Name	Type	Description
`status`	GPGStatusArray
`allowed`	Array.<string>	List of allowed uid, fpr or keyid

Returns:

Type: boolean

Status_IsSigTrustFully(status) → {boolean}

Source:

gpg-parser.js, line 561

Parameters:

Name	Type	Description
`status`	GPGStatusArray

Returns:

Type: boolean

Status_IsSigTrustMarginal(status) → {boolean}

Source:

gpg-parser.js, line 552

Parameters:

Name	Type	Description
`status`	GPGStatusArray

Returns:

Type: boolean

Status_IsSigTrustNever(status) → {boolean}

Source:

gpg-parser.js, line 543

Parameters:

Name	Type	Description
`status`	GPGStatusArray

Returns:

Type: boolean

Status_IsSigTrustUltimate(status) → {boolean}

Source:

gpg-parser.js, line 570

Parameters:

Name	Type	Description
`status`	GPGStatusArray

Returns:

Type: boolean

Status_IsSigTrustUnknown(status) → {boolean}

Source:

gpg-parser.js, line 534

Parameters:

Name	Type	Description
`status`	GPGStatusArray

Returns:

Type: boolean