persistent_ssh_agent.cli module

Command-line interface for persistent-ssh-agent.

class persistent_ssh_agent.cli.Args(**kwargs)

Bases: object

Simple class to mimic argparse namespace for compatibility with existing functions.

class persistent_ssh_agent.cli.ConfigManager

Bases: object

Manages persistent configuration for SSH agent.

add_key(name: str, identity_file: str) → bool

Add a named SSH key.

Parameters:

• name – Name of the key

• identity_file – Path to SSH identity file

Returns:

True if successful

Return type:

bool

clear_config() → bool

Clear all configuration.

Returns:

True if successful

Return type:

bool

deobfuscate_passphrase(encrypted_data: str) → str

Decrypt passphrase.

Parameters:

encrypted_data – Encrypted passphrase

Returns:

Plain text passphrase

Return type:

str

export_config(include_sensitive: bool = False) → Dict

Export configuration.

Parameters:

include_sensitive – Whether to include sensitive information

Returns:

Exported configuration

Return type:

Dict

get_expiration_time() → int | None

Get stored expiration time.

Returns:

Expiration time in seconds or None

Return type:

Optional[int]

get_identity_file() → str | None

Get stored identity file path.

Returns:

Stored identity file path or None

Return type:

Optional[str]

get_passphrase() → str | None

Get stored passphrase.

Returns:

Stored passphrase or None

Return type:

Optional[str]

get_reuse_agent() → bool | None

Get stored reuse agent setting.

Returns:

Reuse agent setting or None

Return type:

Optional[bool]

import_config(config_data: Dict) → bool

Import configuration.

Parameters:

config_data – Configuration data to import

Returns:

True if successful

Return type:

bool

list_keys() → Dict

List all configured SSH keys.

Returns:

Dictionary of configured keys

Return type:

Dict

load_config() → Dict

Load configuration from file.

Returns:

Configuration dictionary

Return type:

Dict

remove_key(name: str) → bool

Remove a named SSH key.

Parameters:

name – Name of the key

Returns:

True if successful

Return type:

bool

save_config(config: Dict) → bool

Save configuration to file.

Parameters:

config – Configuration dictionary

Returns:

True if successful

Return type:

bool

static secure_delete_from_memory(data: str | bytes | bytearray) → None

Securely delete sensitive data from memory.

Parameters:

data – Data to delete

set_expiration_time(hours: int) → bool

Set and store expiration time.

Parameters:

hours – Expiration time in hours

Returns:

True if successful

Return type:

bool

set_identity_file(identity_file: str) → bool

Set and store identity file path.

Parameters:

identity_file – Path to SSH identity file

Returns:

True if successful

Return type:

bool

set_passphrase(passphrase: str) → bool

Set and store passphrase.

Parameters:

passphrase – SSH key passphrase

Returns:

True if successful

Return type:

bool

set_reuse_agent(reuse: bool) → bool

Set and store reuse agent setting.

Parameters:

reuse – Whether to reuse existing SSH agent

Returns:

True if successful

Return type:

bool

persistent_ssh_agent.cli.add_key(args)

Add a configured SSH key.

Parameters:

args – Command line arguments

persistent_ssh_agent.cli.export_config(args)

Export configuration.

Parameters:

args – Command line arguments

persistent_ssh_agent.cli.import_config(args)

Import configuration.

Parameters:

args – Command line arguments

persistent_ssh_agent.cli.list_keys(_)

List all configured SSH keys.

Parameters:

_ – Command line arguments (unused)

persistent_ssh_agent.cli.remove_key(args)

Remove a configured SSH key.

Parameters:

args – Command line arguments

persistent_ssh_agent.cli.run_ssh_connection_test(args)

Test SSH connection.

Parameters:

args – Command line arguments

persistent_ssh_agent.cli.setup_config(args)

Set up configuration.

Parameters:

args – Command line arguments