1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145
|
# Copyright 2010-2025 The pygit2 contributors
#
# This file is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License, version 2,
# as published by the Free Software Foundation.
#
# In addition to the permissions in the GNU General Public License,
# the authors give you unlimited permission to link the compiled
# version of this file into combinations with other programs,
# and to distribute those combinations without any restriction
# coming from the use of this file. (The General Public License
# restrictions do apply in other respects; for example, they cover
# modification of the file, and distribution when not linked into
# a combined executable.)
#
# This file is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; see the file COPYING. If not, write to
# the Free Software Foundation, 51 Franklin Street, Fifth Floor,
# Boston, MA 02110-1301, USA.
from __future__ import annotations
from typing import TYPE_CHECKING
from .enums import CredentialType
if TYPE_CHECKING:
from pathlib import Path
class Username:
"""Username credentials
This is an object suitable for passing to a remote's credentials
callback and for returning from said callback.
"""
def __init__(self, username: str):
self._username = username
@property
def credential_type(self) -> CredentialType:
return CredentialType.USERNAME
@property
def credential_tuple(self) -> tuple[str]:
return (self._username,)
def __call__(
self, _url: str, _username: str | None, _allowed: CredentialType
) -> Username:
return self
class UserPass:
"""Username/Password credentials
This is an object suitable for passing to a remote's credentials
callback and for returning from said callback.
"""
def __init__(self, username: str, password: str):
self._username = username
self._password = password
@property
def credential_type(self) -> CredentialType:
return CredentialType.USERPASS_PLAINTEXT
@property
def credential_tuple(self) -> tuple[str, str]:
return (self._username, self._password)
def __call__(
self, _url: str, _username: str | None, _allowed: CredentialType
) -> UserPass:
return self
class Keypair:
"""
SSH key pair credentials.
This is an object suitable for passing to a remote's credentials
callback and for returning from said callback.
Parameters:
username : str
The username being used to authenticate with the remote server.
pubkey : str
The path to the user's public key file.
privkey : str
The path to the user's private key file.
passphrase : str
The password used to decrypt the private key file, or empty string if
no passphrase is required.
"""
def __init__(
self,
username: str,
pubkey: str | Path | None,
privkey: str | Path | None,
passphrase: str | None,
):
self._username = username
self._pubkey = pubkey
self._privkey = privkey
self._passphrase = passphrase
@property
def credential_type(self) -> CredentialType:
return CredentialType.SSH_KEY
@property
def credential_tuple(
self,
) -> tuple[str, str | Path | None, str | Path | None, str | None]:
return (self._username, self._pubkey, self._privkey, self._passphrase)
def __call__(
self, _url: str, _username: str | None, _allowed: CredentialType
) -> Keypair:
return self
class KeypairFromAgent(Keypair):
def __init__(self, username: str):
super().__init__(username, None, None, None)
class KeypairFromMemory(Keypair):
@property
def credential_type(self) -> CredentialType:
return CredentialType.SSH_MEMORY
|