Python getpassとは?パスワードを画面に出さずに入力する方法
getpassは、入力した文字を画面に出さずに受け取る標準ライブラリです。
input()でパスワードを聞くと画面にそのまま表示されてしまいます。肩越しに見られる、画面共有に映る、ターミナルの履歴に残るといった問題が起きます。
使い方
import getpass
pw = getpass.getpass("パスワード: ")
print("入力された文字数:", len(pw))
実行するとパスワード: と表示され、打った文字は一切表示されません。カーソルも動きません。
打てていないように見えて不安になりますが、正しく受け取れています。これはUNIX系のコマンドと同じ挙動です。
input() との違い
input()… 打った文字がそのまま見える。履歴にも残りうるgetpass()… 表示されない。改行で確定- どちらも戻り値は文字列
プロンプトの既定値は'Password: 'です。日本語にしたいときだけ引数を渡します。
端末が無い環境では警告が出る
パイプ経由やCIの中など、端末を制御できない環境では次の警告が出ます。
Warning: Password input may be echoed.
警告の実体を確認するとGetPassWarningでした。
import warnings, io, sys, getpass
with warnings.catch_warnings(record=True) as rec:
warnings.simplefilter("always")
sys.stdin = io.StringIO("secret\n")
v = getpass.getpass("パスワード: ")
sys.stdin = sys.__stdin__
print("取得できた値:", repr(v))
for r in rec:
print("警告:", r.category.__name__, "->", r.message)
実行結果:
取得できた値: 'secret'
警告: GetPassWarning -> Can not control echo on the terminal.
値は取れますが、入力が画面に出てしまう可能性があるという意味の警告です。自動実行の中でパスワードを聞く設計そのものを見直す合図でもあります。
自動実行では環境変数を使う
import os, getpass, sys
pw = os.environ.get("APP_PASSWORD")
if pw is None:
if sys.stdin.isatty():
pw = getpass.getpass("パスワード: ")
else:
sys.exit("APP_PASSWORD を設定してください")
sys.stdin.isatty()で人が操作しているかどうかを判定できます。人が居るなら聞き、居ないなら環境変数を要求する、という切り分けです。
ログイン名を取る
import getpass
print(getpass.getuser())
実行結果:
user
getuser()は環境変数のLOGNAME・USER・LNAME・USERNAMEを順に見て、見つからなければOSに問い合わせます。
環境変数を先に見るので、書き換えられていれば別の名前が返ります。認証の根拠には使えません。表示用と考えてください。
受け取った値の扱い
- ログに出さない …
print(pw)やデバッグ出力に混ぜない - 例外のメッセージに混ぜない … トレースバックに乗って残る
- 比較は secrets.compare_digest() … Python secrets.compare_digest()とは?安全に文字列を比較する方法
==での比較は一致した文字数によって処理時間が変わるため、理論上は推測の手がかりになります。
まとめ
- パスワードを聞くなら
input()ではなくgetpass.getpass() - 打った文字は表示されない。故障ではない
- 端末が無いと
GetPassWarningが出る getuser()は環境変数依存。認証に使わない
関連記事
あわせて読むと理解が深まります。






