common.configuration.specs.sftp_crendentials
SFTPCredentials Objects
@configspec
class SFTPCredentials(CredentialsConfiguration)
Credentials for SFTP filesystem, compatible with fsspec SFTP protocol.
Authentication is attempted in the following order of priority:
- `key_filename` may contain OpenSSH public certificate paths
as well as regular private-key paths; when files ending in `-cert.pub` are found, they are assumed to match
a private key, and both components will be loaded.
- Any key found through an SSH agent: any “id_rsa”, “id_dsa”, or “id_ecdsa” key discoverable in ~/.ssh/.
- Plain username/password authentication, if a password was provided.
- If a private key requires a password to unlock it, and a password is provided, that password will be used to
attempt to unlock the key.
For more information about parameters: https://docs.paramiko.org/en/3.3/api/client.html#paramiko.client.SSHClient.connect
to_fsspec_credentials
def to_fsspec_credentials() -> Dict[str, Any]
Return a dict that can be passed to fsspec SFTP/SSHClient.connect method.