.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Git::Raw::Cred 3pm"
.TH Git::Raw::Cred 3pm 2024-01-10 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Git::Raw::Cred \- Git credentials class
.SH VERSION
.IX Header "VERSION"
version 0.90
.SH DESCRIPTION
.IX Header "DESCRIPTION"
A Git::Raw::Cred object is used to store credentials.
.PP
\&\fBWARNING\fR: The API of this module is unstable and may change without warning
(any change will be appropriately documented in the changelog).
.SH METHODS
.IX Header "METHODS"
.ie n .SS "userpass( $user, $pass )"
.el .SS "userpass( \f(CW$user\fP, \f(CW$pass\fP )"
.IX Subsection "userpass( $user, $pass )"
Create a new credential object with the given username and password.
.ie n .SS "sshkey( $user, $public, $private [, $pass ] )"
.el .SS "sshkey( \f(CW$user\fP, \f(CW$public\fP, \f(CW$private\fP [, \f(CW$pass\fP ] )"
.IX Subsection "sshkey( $user, $public, $private [, $pass ] )"
Create a new credential object given a SSH public and private key files, and
optionall the password of the private key. If the SSH support has not been
enabled at build-time, this method will always return \f(CW\*(C`undef\*(C'\fR.
.ie n .SS "sshagent( $user )"
.el .SS "sshagent( \f(CW$user\fP )"
.IX Subsection "sshagent( $user )"
Create a new credential object used for querying an ssh-agent. If the SSH
support has not been enabled at build-time, this method will always return
\&\f(CW\*(C`undef\*(C'\fR.
.ie n .SS "sshinteractive( $user, $callback )"
.el .SS "sshinteractive( \f(CW$user\fP, \f(CW$callback\fP )"
.IX Subsection "sshinteractive( $user, $callback )"
Create a new credential object based on interactive authentication. The
callback \f(CW$callback\fR will be invoked when the remote-side issues a challenge.
It receives the following parameters: \f(CW$name\fR, \f(CW$instruction\fR and
\&\f(CW@prompts\fR. Any of the parameters passed to the callback may be undefined.
Each \f(CW$prompt\fR entry in \f(CW@prompts\fR is a hash reference that may contain:
.IP \(bu 4
"text"
.Sp
Text for the prompt.
.IP \(bu 4
"echo"
.Sp
Parameter indicating whether the response of the challenge is safe
to be echoed.
.PP
The callback should return a list of responses, one for each prompt.
If the SSH support has not been enabled at build-time, this method will always
return \f(CW\*(C`undef\*(C'\fR.
.SH AUTHOR
.IX Header "AUTHOR"
Alessandro Ghedini <alexbio@cpan.org>
.PP
Jacques Germishuys <jacquesg@cpan.org>
.SH "LICENSE AND COPYRIGHT"
.IX Header "LICENSE AND COPYRIGHT"
Copyright 2012 Alessandro Ghedini.
.PP
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.
.PP
See http://dev.perl.org/licenses/ for more information.