Note
Deze pagina bevat slechts een korte samenvatting over de beschikbare klassen in paramiko. Raadpleeg de volledige documentatie op de paramiko website voor meer informatie: http://paramiko.org/
Paramiko (een combinatie van de esperanto-woorden voor “paranoïde” en “vriend”) is een module voor python 2.3 of hoger die het SSH2-protocol implementeert voor veilige (versleutelde en geauthenticeerde) verbindingen met machines op afstand. In tegenstelling tot SSL (aka TLS), vereist het SSH2 protocol geen hiërarchische certificaten ondertekend door een machtige centrale autoriteit. U kent SSH2 wellicht als het protocol dat telnet en rsh heeft vervangen voor veilige toegang tot shells op afstand, maar het protocol bevat ook de mogelijkheid om arbitraire kanalen te openen naar diensten op afstand over een versleutelde tunnel. (Dit is hoe sftp werkt, bijvoorbeeld.)
De high-level client API begint met het maken van een SSHClient object. Voor meer directe controle, geef een socket (of socket-achtig object) door aan een Transport, en gebruik start_server of start_client om te onderhandelen met de remote host als ofwel een server of client. Als client ben je verantwoordelijk voor de authenticatie met een wachtwoord of privésleutel, en het controleren van de hostsleutel van de server. (Sleutelondertekening en -verificatie wordt door paramiko gedaan, maar u zult private sleutels moeten verstrekken en controleren of de inhoud van een publieke sleutel overeenkomt met wat u verwachtte te zien). Als server ben je verantwoordelijk voor het beslissen welke gebruikers, wachtwoorden en sleutels je toestaat, en wat voor soort kanalen je toestaat.
Als je klaar bent, kan elke kant flow-controlled Channels aanvragen bij de andere kant, dat zijn python objecten die zich gedragen als sockets, maar data verzenden en ontvangen over de versleutelde sessie.
Paramiko is geheel in python geschreven (geen C of platform-afhankelijke code) en is vrijgegeven onder de GNU Lesser General Public License (LGPL).
Klassen:
klasseparamiko.
SecurityOptions
¶
Eenvoudig object dat de beveiligingsvoorkeuren van een ssh-transport bevat.
klasseparamiko.
Transport
¶
Een SSH-transport maakt verbinding met een stream (meestal een socket), onderhandelt over een versleutelde sessie, authenticeert, en creëert dan stream-tunnels, Channels genaamd, over de sessie.
klasseparamiko.
SSHClient
¶
Een high-level representatie van een sessie met een SSH-server.
klasseparamiko.
MissingHostKeyPolicy
¶
Interface voor het definiëren van het beleid dat SSHClient moet gebruiken wanneer de hostnaam van de SSH-server niet voorkomt in de systeemhostsleutels of de sleutels van de toepassing.
classparamiko.
AutoAddPolicy
¶
Beleidslijn voor het automatisch toevoegen van de hostnaam en de nieuwe hostsleutel aan het lokale HostKeys-object, en het opslaan ervan.
klasseparamiko.
RejectPolicy
¶
Beleid voor het automatisch weigeren van de onbekende hostname & sleutel.
klasseparamiko.
WarningPolicy
¶
Policy voor het loggen van een python-achtige waarschuwing voor een onbekende hostsleutel, maar voor het accepteren ervan.
klasseparamiko.
Channel
¶
Een beveiligde tunnel over een SSH-transport.
klasseparamiko.
SSHException
¶
Uitzondering die wordt veroorzaakt door mislukkingen in de SSH2-protocolonderhandeling of logische fouten.
classparamiko.
PasswordRequiredException
¶
Uitzondering die wordt veroorzaakt wanneer een wachtwoord nodig is om een privésleutelbestand te ontgrendelen.
klasseparamiko.
BadAuthenticationType
¶
Uitzondering wanneer een authenticatietype (zoals wachtwoord) wordt gebruikt, maar de server dat type niet toestaat.
klasseparamiko.
ChannelException
¶
Uitzondering gemaakt wanneer een poging om een nieuw kanaal te openen mislukt.
klasseparamiko.
BadHostKeyException
De hostsleutel die door de SSH-server is opgegeven, kwam niet overeen met wat we verwachtten.
klasseAuthenticationException
¶
Exception raised when authentication failed for some reason.
klasseparamiko.
ServerInterface
¶
Deze klasse definieert een interface voor het regelen van het gedrag van paramiko in servermodus.
klasseparamiko.
SubsystemHandler
¶
Handler voor een subsytem in servermodus.
klasseparamiko.
RSAKey
¶
Voorstelling van een RSA-sleutel die kan worden gebruikt om SSH2-gegevens te ondertekenen en verifiëren.
klasseparamiko.
DSSKey
¶
Voorstelling van een DSS-sleutel die kan worden gebruikt om SSH2-gegevens te ondertekenen en te verifiëren.
klasseparamiko.
SFTPError
¶ klasseparamiko.
SFTP
¶
een alias voor SFTPClient voor achterwaartse compatibiliteit
klasseparamiko.
SFTPClient
¶
SFTP-clientobject.
klasseparamiko.
SFTPServer
¶
Server-side SFTP subsysteem ondersteuning.
klasseparamiko.
SFTPAttributes
¶
Representatie van de attributen van een bestand (of proxied bestand) voor SFTP in client- of servermodus.
klasseparamiko.
SFTPHandle
¶
Een abstract object dat een handle naar een open bestand (of map) in een SFTP-serverimplementatie vertegenwoordigt.
klasseparamiko.
SFTPServerInterface
¶
Deze klasse definieert een interface voor het regelen van het gedrag van paramiko wanneer het SFTPServer subsysteem wordt gebruikt om een SFTP-server aan te bieden.
klasseparamiko.
SFTPFile
¶
Proxy object voor een bestand op de remote server, in client mode SFTP.
klasseparamiko.
¶
Een SSH2-bericht is een stroom van bytes die een combinatie van tekenreeksen, gehele getallen, bools en integers met oneindige precisie codeert (in python bekend als longs).
klasseparamiko.
BufferedFile
¶
Herbruikbare basisklasse om python-stijl bestandsbuffering rond een eenvoudiger stroom te implementeren.
klasseparamiko.
Agent
¶
Client-interface voor het gebruik van private sleutels van een SSH-agent die op de lokale machine draait.
klasseparamiko.
AgentKey