Home
About
Blog
Products
Forum
Support
Contact
Sunbelt Computer Software
PL/B Language Development and Support
Home
About
Blog
Products
Forum
Support
Contact
cpython/Lib/getpass.py at 3.12 · python/cpython · GitHub
Skip to content
Navigation Menu
Sign in
Appearance settings
Platform
AI CODE CREATION
GitHub Copilot
Write better code with AI
GitHub Copilot app
Direct agents from issue to merge
MCP Registry
Integrate external tools
DEVELOPER WORKFLOWS
Actions
Automate any workflow
Codespaces
Instant dev environments
Issues
Plan and track work
Code Review
Manage code changes
Code Quality
Enforce quality at merge
APPLICATION SECURITY
GitHub Advanced Security
Find and fix vulnerabilities
Code security
Secure your code as you build
Secret protection
Stop leaks before they start
EXPLORE
Why GitHub
Documentation
Blog
Changelog
Marketplace
View all features
Solutions
BY COMPANY SIZE
Enterprises
Small and medium teams
Startups
Nonprofits
BY USE CASE
App Modernization
DevSecOps
DevOps
CI/CD
View all use cases
BY INDUSTRY
Healthcare
Financial services
Manufacturing
Government
View all industries
View all solutions
Resources
EXPLORE BY TOPIC
AI
Software Development
DevOps
Security
View all topics
EXPLORE BY TYPE
Customer stories
Events & webinars
Ebooks & reports
Business insights
GitHub Skills
SUPPORT & SERVICES
Documentation
Customer support
Community forum
Trust center
Partners
View all resources
Open Source
COMMUNITY
GitHub Sponsors
Fund open source developers
PROGRAMS
Security Lab
Maintainer Community
GitHub Stars
Archive Program
REPOSITORIES
Topics
Trending
Collections
Enterprise
ENTERPRISE SOLUTIONS
Enterprise platform
AI-powered developer platform
AVAILABLE ADD-ONS
GitHub Advanced Security
Enterprise-grade security features
Copilot for Business
Enterprise-grade AI features
Premium Support
Enterprise-grade 24/7 support
Pricing
Search
/
Sign in
Sign up
Appearance settings
You signed in with another tab or window.
Reload
to refresh your session.
You signed out in another tab or window.
Reload
to refresh your session.
You switched accounts on another tab or window.
Reload
to refresh your session.
Dismiss alert
{{ message }}
Uh oh!
There was an error while loading.
Please reload this page
.
python
/
cpython
Public
Uh oh!
There was an error while loading.
Please reload this page
.
Notifications
You must be signed in to change notification settings
Fork
35.4k
Star
77.2k
Code
Issues
5k+
Pull requests
2.6k
Actions
Projects
Security and quality
0
Insights
Additional navigation options
Code
Issues
Pull requests
Actions
Projects
Security and quality
Insights
Files
Expand file tree
3.12
Breadcrumbs
cpython
/
Lib
/
getpass.py
Copy path
Blame
More file actions
Blame
More file actions
Latest commit
History
History
History
185 lines (156 loc) · 5.85 KB
3.12
Breadcrumbs
cpython
/
Lib
/
getpass.py
Copy path
Top
File metadata and controls
Code
Blame
185 lines (156 loc) · 5.85 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
"""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.
"""
# Authors: Piers Lauder (original)
# Guido van Rossum (Windows support and cleanup)
# Gregory P. Smith (tty support & GetPassWarning)
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
:
# Always try reading and writing directly on the tty first.
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
:
# If that fails, see if stdin can be controlled.
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
)
# a copy to save
new
=
old
[:]
new
[
3
]
&=
~
termios
.
ECHO
# 3 == 'lflags'
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
()
# issue7208
except
termios
.
error
:
if
passwd
is
not
None
:
# _raw_input succeeded. The final tcsetattr failed. Reraise
# instead of leaving the terminal in an unknown state.
raise
# We can't control the tty or stdin. Give up and use normal IO.
# fallback_getpass() raises an appropriate warning.
if
stream
is
not
input
:
# clean up unused file objects before blocking
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
):
# This doesn't save the string in the GNU readline history.
if
not
stream
:
stream
=
sys
.
stderr
if
not
input
:
input
=
sys
.
stdin
prompt
=
str
(
prompt
)
if
prompt
:
try
:
stream
.
write
(
prompt
)
except
UnicodeEncodeError
:
# Use replace error handler to get as much as possible printed.
prompt
=
prompt
.
encode
(
stream
.
encoding
,
'replace'
)
prompt
=
prompt
.
decode
(
stream
.
encoding
)
stream
.
write
(
prompt
)
stream
.
flush
()
# NOTE: The Python C API calls flockfile() (and unlock) during readline.
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
# If this fails, the exception will "explain" why
import
pwd
return
pwd
.
getpwuid
(
os
.
getuid
())[
0
]
# Bind the name getpass to the appropriate function
try
:
import
termios
# it's possible there is an incompatible termios from the
# McMillan Installer, make sure we have a UNIX-compatible termios
termios
.
tcgetattr
,
termios
.
tcsetattr
except
(
ImportError
,
AttributeError
):
try
:
import
msvcrt
except
ImportError
:
getpass
=
fallback_getpass
else
:
getpass
=
win_getpass
else
:
getpass
=
unix_getpass
You can’t perform that action at this time.