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に問い合わせます。

環境変数を先に見るので、書き換えられていれば別の名前が返ります。認証の根拠には使えません。表示用と考えてください。


受け取った値の扱い

==での比較は一致した文字数によって処理時間が変わるため、理論上は推測の手がかりになります。


まとめ

  • パスワードを聞くならinput()ではなくgetpass.getpass()
  • 打った文字は表示されない。故障ではない
  • 端末が無いとGetPassWarningが出る
  • getuser()は環境変数依存。認証に使わない

関連記事

あわせて読むと理解が深まります。

対面・無料|東京・永田町で毎週土曜日13時

この記事のようなコードを、講師に聞きながら動かしてみる

ゼロからはじめるPython入門講座

8年間・累計600回開催/これまで全国で2万人以上が参加

「やはり対面で聞けるのはとても気づきがあり、価値があると思います」

参加者の声

  • 本当に初心者からの講座です。プログラミングに触ったことがなくて大丈夫です
  • 対面だから、その場で聞けます。つまずいた所を持ち帰らずに解決できます
  • 講座は1時間。そのあとも残って学習を続けられ、講師にも質問できます
  • 独学で挫折した方も。糸口が見つかって、講座のあと会員になる方が多くいます

無料で参加する|開催日程を見る

参加費は無料です