Heading

Paramiko (esperanto word for “paranoid” and “friend”) は python 2.3 以降のモジュールで、リモートマシンへの安全な (暗号化および認証された) 接続のための SSH2 プロトコルを実装しています。 SSL (別名 TLS) とは異なり、SSH2 プロトコルは強力な中央機関によって署名された 階層的な証明書を必要としません。 SSH2 は telnet や rsh に代わるリモートシェルへの安全なアクセスのためのプロトコルとして知られていますが、このプロトコルには、暗号化トンネルを介してリモートサービスへの任意のチャネルを開く機能も含まれています。

高レベルのクライアント API は、まず SSHClient オブジェクトの生成から始まります。 より直接的な制御のためには、トランスポートにソケット(またはソケットに似たオブジェクト)を渡し、start_serverまたはstart_clientを使って、リモートホストをサーバまたはクライアントとしてネゴシエートします。 クライアントとしては、パスワードや秘密鍵を使った認証や、サーバーのホスト鍵の確認を行うことになります。 (鍵の署名と検証はparamikoが行いますが、お客様は秘密鍵を提供し、公開鍵の内容が期待したものと一致していることを確認する必要があります)

この作業が終わると、どちらかの側がフロー制御されたチャネルを相手側に要求することができます。チャネルとは、ソケットのように動作するpythonオブジェクトですが、暗号化されたセッション上でデータを送受信します。

Paramikoは完全にpythonで書かれており(Cやプラットフォーム依存のコードはありません)、GNU Lesser General Public License (LGPL)の下でリリースされています。

Classes:

class paramiko.SecurityOptions ¶

sshトランスポートのセキュリティ設定を含むシンプルなオブジェクトです。

class paramiko.Transport¶

SSHトランスポートはストリーム(通常はソケット)にアタッチし、暗号化されたセッションをネゴシエートし、認証を行い、セッションをまたいでチャネルと呼ばれるストリームトンネルを作成します。

class paramiko.SSHClient ¶

SSHサーバーとのセッションの高レベルの表現です。

class paramiko.MissingHostKeyPolicy¶

SSHサーバーのホスト名がシステムのホストキーにもアプリケーションのキーにもないときに、SSHClientが使うべきポリシーを定義するためのインターフェイス。

class paramiko.AutoAddPolicy ¶

ホスト名と新しいホストキーをローカルの HostKeys オブジェクトに自動的に追加し、保存するためのポリシー。

class paramiko.RejectPolicy¶

未知のホスト名&キーを自動的に拒否するためのポリシーです。

class paramiko.WarningPolicy¶ Policy for logging a python-style warning for an unknown host key, but accepting it. class paramiko.Channel ¶

SSH トランスポートを介した安全なトンネルです。

class paramiko.SSHException¶

SSH2プロトコルのネゴシエーションに失敗したり、ロジックエラーが発生した場合に発生する例外です。

class paramiko.PasswordRequiredException¶

秘密鍵ファイルのロックを解除するためにパスワードが必要な場合に発生する例外です。

class paramiko.BadAuthenticationType ¶

認証タイプ（パスワードなど）が使用されているが、サーバーがそのタイプを許可していない場合に発生する例外。

class paramiko.ChannelException¶

新しいChannelを開こうとする試みが失敗したときに発生する例外です。

class paramiko.BadHostKeyException

SSHサーバーから与えられたホストキーが、期待していたものと一致しませんでした。

class AuthenticationException¶

認証が何らかの理由で失敗したときに発生する例外です。

class paramiko.ServerInterface¶

このクラスは、サーバーモードでのparamikoの動作を制御するためのインターフェイスを定義しています。

class paramiko.SubsystemHandler¶

サーバーモードでのサブサイトのためのHandlerです。

class paramiko.RSAKey ¶

SSH2データの署名と検証に使用できるRSA鍵の表現です。

class paramiko.DSSKey ¶

SSH2データの署名・検証に使用できるDSSキーの表現。

クラス paramiko.SFTPErrorparamiko.SFTP ¶

SFTPClientの別名。

class paramiko.SFTPClient ¶

SFTPクライアントオブジェクト。

class paramiko.SFTPServer ¶

サーバー側のSFTPサブシステムのサポート。

class paramiko.SFTPAttributes ¶

クライアントまたはサーバーモードのSFTPのためのファイル(またはプロキシされたファイル)の属性の表現。

class paramiko.SFTPHandle ¶

SFTPサーバーの実装において、開いているファイル（またはフォルダ）へのハンドルを表す抽象オブジェクトです。

class paramiko.SFTPServerInterface¶

このクラスは、SFTPサーバーを提供するためにSFTPServerサブシステムを使用する際に、paramikoの動作を制御するためのインターフェースを定義します。

class paramiko.SFTPFile¶

クライアントモードのSFTPで、リモートサーバー上のファイルのためのプロキシオブジェクトです。

class paramiko.Message¶

SSH2メッセージは、文字列、整数、bool、無限精度の整数(pythonではlongと呼ばれる)の組み合わせをエンコードしたバイトのストリームです。

class paramiko.BufferedFile¶

よりシンプルなストリームの周りにパイソンスタイルのファイルバッファリングを実装するための再利用可能なベースクラスです。

class paramiko.Agent¶

ローカルマシン上で実行されているSSHエージェントからの秘密鍵を使用するためのクライアントインターフェイス

class paramiko.AgentKey