py‐monopla auth.py

SIPF_AUTHプロトコルのクライアント機能を提供します。

クラス

SipfAuthクラス

認証情報の保持と保持している認証情報からHTTPのAuthorizationヘッダで使用する値を生成します。

メンバー変数

変数名	意味	型
user_name	ユーザー名	文字列
password	パスワード	文字列

コンストラクタ

SipfAuth()

引数

なし

戻り値

SipfAuthクラスのインスタンス

例外

なし

メソッド

basic_auth_value()

保持している認証情報からHTTP BASIC認証で使用するBASE64文字列を生成します。

引数

なし

戻り値

戻り値	意味
文字列	user_nameとpasswordから生成したBASE64文字列

例外

なし

関数

get_auth_info(auth)

SIM認証を要求し、認証情報を取得します。

引数

引数名	意味	in/out	型	概要
auth	認証情報	out	SipfAuthクラス	SIPF_AUTHプロトコルで取得した認証情報を格納するSipfAuthクラスのインスタンスを指定します

戻り値

戻り値	意味
0	成功
-1	失敗
-1未満	HTTPエラー(ステータスコード×1) 例：ステータス451の場合は-451

例外

例外	意味
TypeError	引数authがSipfAuthクラスではない
urllib.error.URLError	urllibで発生した例外