Note
Cette page ne contient qu’un bref résumé sur les classes disponibles dans paramiko. Veuillez vous référer à la documentation complète sur le site web de paramiko pour plus d’informations : http://paramiko.org/
Paramiko (combinaison des mots esperanto pour « paranoïaque » et « ami ») est un module pour python 2.3 ou supérieur qui implémente le protocole SSH2 pour les connexions sécurisées (cryptées et authentifiées) aux machines distantes. Contrairement à SSL (alias TLS), le protocole SSH2 ne nécessite pas de certificats hiérarchiques signés par une puissante autorité centrale. Vous connaissez peut-être SSH2 comme le protocole qui a remplacé telnet et rsh pour l’accès sécurisé aux shells distants, mais le protocole inclut également la possibilité d’ouvrir des canaux arbitraires vers des services distants à travers un tunnel crypté. (C’est ainsi que fonctionne sftp, par exemple.)
L’API client de haut niveau commence par la création d’un objet SSHClient. Pour un contrôle plus direct, passez un socket (ou un objet de type socket) à un Transport, et utilisez start_server ou start_client pour négocier avec l’hôte distant en tant que serveur ou client. En tant que client, vous êtes responsable de l’authentification à l’aide d’un mot de passe ou d’une clé privée, et de la vérification de la clé hôte du serveur. (La signature et la vérification des clés sont effectuées par paramiko, mais vous devrez fournir des clés privées et vérifier que le contenu d’une clé publique correspond à ce que vous vous attendiez à voir). En tant que serveur, vous êtes responsable de décider quels utilisateurs, mots de passe et clés autoriser, et quel type de canaux autoriser.
Une fois que vous avez terminé, chaque partie peut demander des canaux à flux contrôlé à l’autre partie, qui sont des objets python qui agissent comme des sockets, mais qui envoient et reçoivent des données sur la session cryptée.
Paramiko est entièrement écrit en python (pas de code C ou dépendant de la plateforme) et est publié sous la licence GNU Lesser General Public License (LGPL).
Classes:
classeparamiko.
SecurityOptions
¶
Objet simple contenant les préférences de sécurité d’un transport ssh.
classparamiko.
Transport
¶
Un transport SSH s’attache à un flux (généralement un socket), négocie une session chiffrée, s’authentifie, puis crée des tunnels de flux, appelés Channels, à travers la session.
classparamiko.
SSHClient
¶
Une représentation de haut niveau d’une session avec un serveur SSH.
classparamiko.
MissingHostKeyPolicy
¶
Interface permettant de définir la politique que SSHClient doit utiliser lorsque le nom d’hôte du serveur SSH ne figure ni dans les clés d’hôte du système ni dans les clés de l’application.
classparamiko.
AutoAddPolicy
¶
Politique pour ajouter automatiquement le nom d’hôte et la nouvelle clé d’hôte à l’objet HostKeys local, et le sauvegarder.
classparamiko.
RejectPolicy
¶
Politique de rejet automatique de la clé de nom d’hôte inconnu &.
classparamiko.
WarningPolicy
¶
Politique pour consigner un avertissement de style python pour une clé d’hôte inconnu, mais l’accepter.
classparamiko.
Channel
¶
Un tunnel sécurisé à travers un transport SSH.
classparamiko.
SSHException
¶
Exception levée par des échecs de négociation du protocole SSH2 ou des erreurs de logique.
classparamiko.
PasswordRequiredException
¶
Exception levée lorsqu’un mot de passe est nécessaire pour déverrouiller un fichier de clé privée.
classparamiko.
BadAuthenticationType
¶
Exception levée lorsqu’un type d’authentification (comme le mot de passe) est utilisé, mais que le serveur n’autorise pas ce type.
classparamiko.
ChannelException
¶
Exception levée lorsqu’une tentative d’ouverture d’un nouveau canal échoue.
classparamiko.
BadHostKeyException
La clé d’hôte donnée par le serveur SSH ne correspondait pas à ce que nous attendions.
classeAuthenticationException
¶
Exception levée lorsque l’authentification a échoué pour une raison quelconque.
classeparamiko.
ServerInterface
¶
Cette classe définit une interface pour contrôler le comportement de paramiko en mode serveur.
classeparamiko.
SubsystemHandler
¶
Handler pour un sous-système en mode serveur.
classparamiko.
RSAKey
¶
Représentation d’une clé RSA qui peut être utilisée pour signer et vérifier les données SSH2.
classparamiko.
DSSKey
¶
Représentation d’une clé DSS qui peut être utilisée pour signer et vérifier des données SSH2.
¶ classeparamiko.
SFTPError
¶ classeparamiko.
SFTP
¶
un alias pour SFTPClient pour une compatibilité rétroactive
classparamiko.
SFTPClient
¶
Objet client SFTP.
classparamiko.
SFTPServer
¶
Support du sous-système SFTP côté serveur.
classparamiko.
SFTPAttributes
¶
Représentation des attributs d’un fichier (ou d’un fichier proxy) pour SFTP en mode client ou serveur.
classeparamiko.
SFTPHandle
¶
Objet abstrait représentant un handle vers un fichier (ou un dossier) ouvert dans une implémentation de serveur SFTP.
classeparamiko.
SFTPServerInterface
¶
Cette classe définit une interface pour contrôler le comportement de paramiko lors de l’utilisation du sous-système SFTPServer pour fournir un serveur SFTP.
classparamiko.
SFTPFile
¶
Objet proxy pour un fichier sur le serveur distant, en mode client SFTP.
classparamiko.
Message
¶
Un message SSH2 est un flux d’octets qui code une certaine combinaison de chaînes de caractères, d’entiers, de bools et d’entiers de précision infinie (connus en python sous le nom de longs).
classeparamiko.
BufferedFile
¶
Une classe de base réutilisable pour mettre en œuvre une mise en mémoire tampon de fichier de style python autour d’un flux plus simple.
classeparamiko.
Agent
¶
Interface client pour utiliser les clés privées d’un agent SSH s’exécutant sur la machine locale.
classeparamiko.
AgentKey
.