| | """Utilities to get a password and/or the current user name. |
| | |
| | getpass(prompt[, stream]) - Prompt for a password, with echo turned off. |
| | getuser() - Get the user name from the environment or password database. |
| | |
| | GetPassWarning - This UserWarning is issued when getpass() cannot prevent |
| | echoing of the password contents while reading. |
| | |
| | On Windows, the msvcrt module will be used. |
| | |
| | """ |
| |
|
| | |
| | |
| | |
| |
|
| | import contextlib |
| | import io |
| | import os |
| | import sys |
| | import warnings |
| |
|
| | __all__ = ["getpass","getuser","GetPassWarning"] |
| |
|
| |
|
| | class GetPassWarning(UserWarning): pass |
| |
|
| |
|
| | def unix_getpass(prompt='Password: ', stream=None): |
| | """Prompt for a password, with echo turned off. |
| | |
| | Args: |
| | prompt: Written on stream to ask for the input. Default: 'Password: ' |
| | stream: A writable file object to display the prompt. Defaults to |
| | the tty. If no tty is available defaults to sys.stderr. |
| | Returns: |
| | The seKr3t input. |
| | Raises: |
| | EOFError: If our input tty or stdin was closed. |
| | GetPassWarning: When we were unable to turn echo off on the input. |
| | |
| | Always restores terminal settings before returning. |
| | """ |
| | passwd = None |
| | with contextlib.ExitStack() as stack: |
| | try: |
| | |
| | fd = os.open('/dev/tty', os.O_RDWR|os.O_NOCTTY) |
| | tty = io.FileIO(fd, 'w+') |
| | stack.enter_context(tty) |
| | input = io.TextIOWrapper(tty) |
| | stack.enter_context(input) |
| | if not stream: |
| | stream = input |
| | except OSError: |
| | |
| | stack.close() |
| | try: |
| | fd = sys.stdin.fileno() |
| | except (AttributeError, ValueError): |
| | fd = None |
| | passwd = fallback_getpass(prompt, stream) |
| | input = sys.stdin |
| | if not stream: |
| | stream = sys.stderr |
| |
|
| | if fd is not None: |
| | try: |
| | old = termios.tcgetattr(fd) |
| | new = old[:] |
| | new[3] &= ~termios.ECHO |
| | tcsetattr_flags = termios.TCSAFLUSH |
| | if hasattr(termios, 'TCSASOFT'): |
| | tcsetattr_flags |= termios.TCSASOFT |
| | try: |
| | termios.tcsetattr(fd, tcsetattr_flags, new) |
| | passwd = _raw_input(prompt, stream, input=input) |
| | finally: |
| | termios.tcsetattr(fd, tcsetattr_flags, old) |
| | stream.flush() |
| | except termios.error: |
| | if passwd is not None: |
| | |
| | |
| | raise |
| | |
| | |
| | if stream is not input: |
| | |
| | stack.close() |
| | passwd = fallback_getpass(prompt, stream) |
| |
|
| | stream.write('\n') |
| | return passwd |
| |
|
| |
|
| | def win_getpass(prompt='Password: ', stream=None): |
| | """Prompt for password with echo off, using Windows getwch().""" |
| | if sys.stdin is not sys.__stdin__: |
| | return fallback_getpass(prompt, stream) |
| |
|
| | for c in prompt: |
| | msvcrt.putwch(c) |
| | pw = "" |
| | while 1: |
| | c = msvcrt.getwch() |
| | if c == '\r' or c == '\n': |
| | break |
| | if c == '\003': |
| | raise KeyboardInterrupt |
| | if c == '\b': |
| | pw = pw[:-1] |
| | else: |
| | pw = pw + c |
| | msvcrt.putwch('\r') |
| | msvcrt.putwch('\n') |
| | return pw |
| |
|
| |
|
| | def fallback_getpass(prompt='Password: ', stream=None): |
| | warnings.warn("Can not control echo on the terminal.", GetPassWarning, |
| | stacklevel=2) |
| | if not stream: |
| | stream = sys.stderr |
| | print("Warning: Password input may be echoed.", file=stream) |
| | return _raw_input(prompt, stream) |
| |
|
| |
|
| | def _raw_input(prompt="", stream=None, input=None): |
| | |
| | if not stream: |
| | stream = sys.stderr |
| | if not input: |
| | input = sys.stdin |
| | prompt = str(prompt) |
| | if prompt: |
| | try: |
| | stream.write(prompt) |
| | except UnicodeEncodeError: |
| | |
| | prompt = prompt.encode(stream.encoding, 'replace') |
| | prompt = prompt.decode(stream.encoding) |
| | stream.write(prompt) |
| | stream.flush() |
| | |
| | line = input.readline() |
| | if not line: |
| | raise EOFError |
| | if line[-1] == '\n': |
| | line = line[:-1] |
| | return line |
| |
|
| |
|
| | def getuser(): |
| | """Get the username from the environment or password database. |
| | |
| | First try various environment variables, then the password |
| | database. This works on Windows as long as USERNAME is set. |
| | |
| | """ |
| |
|
| | for name in ('LOGNAME', 'USER', 'LNAME', 'USERNAME'): |
| | user = os.environ.get(name) |
| | if user: |
| | return user |
| |
|
| | |
| | import pwd |
| | return pwd.getpwuid(os.getuid())[0] |
| |
|
| | |
| | try: |
| | import termios |
| | |
| | |
| | termios.tcgetattr, termios.tcsetattr |
| | except (ImportError, AttributeError): |
| | try: |
| | import msvcrt |
| | except ImportError: |
| | getpass = fallback_getpass |
| | else: |
| | getpass = win_getpass |
| | else: |
| | getpass = unix_getpass |
| |
|