EDataServer.SourceOpenPGP

g EDataServer.SourceExtension EDataServer.SourceExtension EDataServer.SourceOpenPGP EDataServer.SourceOpenPGP EDataServer.SourceExtension->EDataServer.SourceOpenPGP GObject.Object GObject.Object GObject.Object->EDataServer.SourceExtension

Subclasses:

None

Methods

Inherited:

EDataServer.SourceExtension (4), GObject.Object (37)

Structs:

GObject.ObjectClass (5)

dup_key_id ()

dup_signing_algorithm ()

get_always_trust ()

get_encrypt_by_default ()

get_encrypt_to_self ()

get_key_id ()

get_locate_keys ()

get_prefer_inline ()

get_send_prefer_encrypt ()

get_send_public_key ()

get_sign_by_default ()

get_signing_algorithm ()

set_always_trust (always_trust)

set_encrypt_by_default (encrypt_by_default)

set_encrypt_to_self (encrypt_to_self)

set_key_id (key_id)

set_locate_keys (locate_keys)

set_prefer_inline (prefer_inline)

set_send_prefer_encrypt (send_prefer_encrypt)

set_send_public_key (send_public_key)

set_sign_by_default (sign_by_default)

set_signing_algorithm (signing_algorithm)

Virtual Methods

Inherited:

GObject.Object (7)

Properties

Inherited:

EDataServer.SourceExtension (1)

Name

Type

Flags

Short Description

always-trust

bool

r/w/c/en

Always trust keys in my keyring

encrypt-by-default

bool

r/w/c/en

Encrypt outgoing messages by default

encrypt-to-self

bool

r/w/c/en

Always encrypt to myself

key-id

str

r/w/c/en

PGP/GPG Key ID

locate-keys

bool

r/w/c/en

Locate keys in WKD for encryption

prefer-inline

bool

r/w/c/en

Prefer inline sign/encrypt

send-prefer-encrypt

bool

r/w/c/en

Send whether prefers encryption together with the public key in messages

send-public-key

bool

r/w/c/en

Send public key in messages

sign-by-default

bool

r/w/c/en

Sign outgoing messages by default

signing-algorithm

str

r/w/c/en

Hash algorithm used to sign messages

Signals

Inherited:

GObject.Object (1)

Fields

Inherited:

GObject.Object (1)

Name

Type

Access

Description

parent

EDataServer.SourceExtension

r

Class Details

class EDataServer.SourceOpenPGP(**kwargs)
Bases:

EDataServer.SourceExtension

Abstract:

No

Structure:

EDataServer.SourceOpenPGPClass

Contains only private data that should be read and manipulated using the functions below.

New in version 3.6.

dup_key_id()
Returns:

a newly-allocated copy of EDataServer.SourceOpenPGP :key-id

Return type:

str

Thread-safe variation of EDataServer.SourceOpenPGP.get_key_id(). Use this function when accessing self from multiple threads.

The returned string should be freed with GLib.free() when no longer needed.

New in version 3.6.

dup_signing_algorithm()
Returns:

a newly-allocated copy of EDataServer.SourceOpenPGP :signing-algorithm

Return type:

str

Thread-safe variation of EDataServer.SourceOpenPGP.get_signing_algorithm(). Use this function when accessing self from multiple threads.

The returned string should be freed with GLib.free() when no longer needed.

New in version 3.6.

get_always_trust()
Returns:

whether used keys are always fully trusted

Return type:

bool

Returns whether to skip key validation and assume that used keys are always fully trusted.

New in version 3.6.

get_encrypt_by_default()
Returns:

whether to encrypt outgoing messages by default

Return type:

bool

Returns whether to digitally encrypt outgoing messages by default using OpenPGP-compliant software such as GNU Privacy Guard (GnuPG).

New in version 3.18.

get_encrypt_to_self()
Returns:

whether to “encrypt-to-self”

Return type:

bool

Returns whether to “encrypt-to-self” when sending encrypted messages.

New in version 3.6.

get_key_id()
Returns:

the key ID used to sign and encrypt messages

Return type:

str

Returns the OpenPGP key ID used to sign and encrypt messages.

New in version 3.6.

get_locate_keys()
Returns:

whether gpg can locate keys using Web Key Directory (WKD) lookup when encrypting messages.

Return type:

bool

Returns, whether gpg can locate keys using Web Key Directory (WKD) lookup when encrypting messages. The default is True.

New in version 3.46.

get_prefer_inline()
Returns:

whether to prefer inline sign/encrypt of the text/plain messages

Return type:

bool

Returns whether to prefer inline sign/encrypt of the text/plain messages.

New in version 3.20.

get_send_prefer_encrypt()
Returns:

whether should claim the encryption is preferred when sending public key in messages

Return type:

bool

Returns, whether should claim the encryption is preferred when sending public key in messages. The default is True.

New in version 3.50.

get_send_public_key()
Returns:

whether should send GPG public key in messages

Return type:

bool

Returns, whether should send GPG public key in messages. The default is True.

New in version 3.50.

get_sign_by_default()
Returns:

whether to sign outgoing messages by default

Return type:

bool

Returns whether to digitally sign outgoing messages by default using OpenPGP-compliant software such as GNU Privacy Guard (GnuPG).

New in version 3.6.

get_signing_algorithm()
Returns:

the signing algorithm for outgoing messages

Return type:

str

Returns the name of the hash algorithm used to digitally sign outgoing messages.

New in version 3.6.

set_always_trust(always_trust)
Parameters:

always_trust (bool) – whether used keys are always fully trusted

Sets whether to skip key validation and assume that used keys are always fully trusted.

New in version 3.6.

set_encrypt_by_default(encrypt_by_default)
Parameters:

encrypt_by_default (bool) – whether to encrypt outgoing messages by default

Sets whether to digitally encrypt outgoing messages by default using OpenPGP-compliant software such as GNU Privacy Guard (GnuPG).

New in version 3.18.

set_encrypt_to_self(encrypt_to_self)
Parameters:

encrypt_to_self (bool) – whether to “encrypt-to-self”

Sets whether to “encrypt-to-self” when sending encrypted messages.

New in version 3.6.

set_key_id(key_id)
Parameters:

key_id (str) – the key ID used to sign and encrypt messages

Sets the OpenPGP key ID used to sign and encrypt messages.

The internal copy of key_id is automatically stripped of leading and trailing whitespace. If the resulting string is empty, None is set instead.

New in version 3.6.

set_locate_keys(locate_keys)
Parameters:

locate_keys (bool) – value to set

Sets the locate_keys on the self, which is used to instruct gpg to locate keys using Web Key Directory (WKD) lookup when encrypting messages.

New in version 3.46.

set_prefer_inline(prefer_inline)
Parameters:

prefer_inline (bool) – whether to prefer inline sign/encrypt of the text/plain messages

Sets whether to prefer inline sign/encrypt of the text/plain messages.

New in version 3.20.

set_send_prefer_encrypt(send_prefer_encrypt)
Parameters:

send_prefer_encrypt (bool) – value to set

Sets the send_prefer_encrypt on the self, which tells the client to claim the user prefer encryption when also sending its public key in the messages (EDataServer.SourceOpenPGP.set_send_public_key()).

New in version 3.50.

set_send_public_key(send_public_key)
Parameters:

send_public_key (bool) – value to set

Sets the send_public_key on the self, which tells the client to include user’s public key in the messages in an Autocrypt header.

New in version 3.50.

set_sign_by_default(sign_by_default)
Parameters:

sign_by_default (bool) – whether to sign outgoing messages by default

Sets whether to digitally sign outgoing messages by default using OpenPGP-compliant software such as GNU Privacy Guard (GnuPG).

New in version 3.6.

set_signing_algorithm(signing_algorithm)
Parameters:

signing_algorithm (str) – the signing algorithm for outgoing messages

Sets the name of the hash algorithm used to digitally sign outgoing messages.

The internal copy of signing_algorithm is automatically stripped of leading and trailing whitespace. If the resulting string is empty, None is set instead.

New in version 3.6.

Property Details

EDataServer.SourceOpenPGP.props.always_trust
Name:

always-trust

Type:

bool

Default Value:

False

Flags:

READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

Always trust keys in my keyring

EDataServer.SourceOpenPGP.props.encrypt_by_default
Name:

encrypt-by-default

Type:

bool

Default Value:

False

Flags:

READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

Encrypt outgoing messages by default

EDataServer.SourceOpenPGP.props.encrypt_to_self
Name:

encrypt-to-self

Type:

bool

Default Value:

True

Flags:

READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

Always encrypt to myself

EDataServer.SourceOpenPGP.props.key_id
Name:

key-id

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

PGP/GPG Key ID

EDataServer.SourceOpenPGP.props.locate_keys
Name:

locate-keys

Type:

bool

Default Value:

True

Flags:

READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

Locate keys in WKD for encryption

EDataServer.SourceOpenPGP.props.prefer_inline
Name:

prefer-inline

Type:

bool

Default Value:

False

Flags:

READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

Prefer inline sign/encrypt

EDataServer.SourceOpenPGP.props.send_prefer_encrypt
Name:

send-prefer-encrypt

Type:

bool

Default Value:

True

Flags:

READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

Send whether prefers encryption together with the public key in messages

EDataServer.SourceOpenPGP.props.send_public_key
Name:

send-public-key

Type:

bool

Default Value:

True

Flags:

READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

Send public key in messages

EDataServer.SourceOpenPGP.props.sign_by_default
Name:

sign-by-default

Type:

bool

Default Value:

False

Flags:

READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

Sign outgoing messages by default

EDataServer.SourceOpenPGP.props.signing_algorithm
Name:

signing-algorithm

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

Hash algorithm used to sign messages