The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
Passwd-Keyring-Gnome-0.2501
River stage zero No dependents
/ Passwd::Keyring::Gnome

NAME

Passwd::Keyring::Gnome - Password storage implementation based on GNOME Keyring.

VERSION

Version 0.2501

SYNOPSIS

Gnome Keyring based implementation of Keyring.

use Passwd::Keyring::Gnome;

my $keyring = Passwd::Keyring::Gnome->new(
     app=>"My beautiful app",     # in fact unimportant at the moment
     group=>"My app passwords",   # visible in seahorse and used to separate different passwords
);

$keyring->set_password("John", "verysecret", "my-pseudodomain");
# And later, on next run maybe
my $password = $keyring->get_password("John", "my-pseudodomain");
# plus
$keyring->clear_password("John", "my-pseudodomain");

Note: see Passwd::Keyring::Auto::KeyringAPI for detailed comments on keyring method semantics (this document is installed with Passwd::Keyring::Auto package).

SUBROUTINES/METHODS

new(app=>'app name', group=>'passwords folder')

Initializes the processing. Croaks if gnome keyring does not seem to be available.

Handled named parameters:

- app - symbolic app name (not used at the moment, but can be used in future as comment and in prompts, so set sensibly)

- group - name for password group (will be visible in seahorse so can be used to find passwords, different group means different password set)

set_password(username, password, domain)

Sets (stores) password identified by given domain for given user

get_password($user_name, $domain)

Reads previously stored password for given user in given app. If such password can not be found, returns undef.

clear_password($user_name, $domain)

Removes given password (if present)

Returns how many passwords actually were removed

is_persistent

Returns info, whether this keyring actually saves passwords persistently.

(true in this case)

AUTHOR

Marcin Kasperski

BUGS

Please report any bugs or feature requests to issue tracker at https://bitbucket.org/Mekk/perl-keyring-gnome.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc Passwd::Keyring::Gnome

You can also look for information at:

http://search.cpan.org/~mekk/Passwd-Keyring-Gnome/

Source code is tracked at:

https://bitbucket.org/Mekk/perl-keyring-gnome

LICENSE AND COPYRIGHT

Copyright 2010-2012 Marcin Kasperski.

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.