| 1 |
import netrc, os, unittest, sys, textwrap |
| 2 |
from test import support |
| 3 |
from test.support import os_helper |
| 4 |
|
| 5 |
temp_filename = os_helper.TESTFN |
| 6 |
|
| 7 |
class NetrcTestCase(unittest.TestCase): |
| 8 |
|
| 9 |
def make_nrc(self, test_data): |
| 10 |
test_data = textwrap.dedent(test_data) |
| 11 |
mode = 'w' |
| 12 |
if sys.platform != 'cygwin': |
| 13 |
mode += 't' |
| 14 |
with open(temp_filename, mode, encoding="utf-8") as fp: |
| 15 |
fp.write(test_data) |
| 16 |
try: |
| 17 |
nrc = netrc.netrc(temp_filename) |
| 18 |
finally: |
| 19 |
os.unlink(temp_filename) |
| 20 |
return nrc |
| 21 |
|
| 22 |
def test_toplevel_non_ordered_tokens(self): |
| 23 |
nrc = self.make_nrc("""\ |
| 24 |
machine host.domain.com password pass1 login log1 account acct1 |
| 25 |
default login log2 password pass2 account acct2 |
| 26 |
""") |
| 27 |
self.assertEqual(nrc.hosts['host.domain.com'], ('log1', 'acct1', 'pass1')) |
| 28 |
self.assertEqual(nrc.hosts['default'], ('log2', 'acct2', 'pass2')) |
| 29 |
|
| 30 |
def test_toplevel_tokens(self): |
| 31 |
nrc = self.make_nrc("""\ |
| 32 |
machine host.domain.com login log1 password pass1 account acct1 |
| 33 |
default login log2 password pass2 account acct2 |
| 34 |
""") |
| 35 |
self.assertEqual(nrc.hosts['host.domain.com'], ('log1', 'acct1', 'pass1')) |
| 36 |
self.assertEqual(nrc.hosts['default'], ('log2', 'acct2', 'pass2')) |
| 37 |
|
| 38 |
def test_macros(self): |
| 39 |
data = """\ |
| 40 |
macdef macro1 |
| 41 |
line1 |
| 42 |
line2 |
| 43 |
|
| 44 |
macdef macro2 |
| 45 |
line3 |
| 46 |
line4 |
| 47 |
|
| 48 |
""" |
| 49 |
nrc = self.make_nrc(data) |
| 50 |
self.assertEqual(nrc.macros, {'macro1': ['line1\n', 'line2\n'], |
| 51 |
'macro2': ['line3\n', 'line4\n']}) |
| 52 |
# strip the last \n |
| 53 |
self.assertRaises(netrc.NetrcParseError, self.make_nrc, |
| 54 |
data.rstrip(' ')[:-1]) |
| 55 |
|
| 56 |
def test_optional_tokens(self): |
| 57 |
data = ( |
| 58 |
"machine host.domain.com", |
| 59 |
"machine host.domain.com login", |
| 60 |
"machine host.domain.com account", |
| 61 |
"machine host.domain.com password", |
| 62 |
"machine host.domain.com login \"\" account", |
| 63 |
"machine host.domain.com login \"\" password", |
| 64 |
"machine host.domain.com account \"\" password" |
| 65 |
) |
| 66 |
for item in data: |
| 67 |
nrc = self.make_nrc(item) |
| 68 |
self.assertEqual(nrc.hosts['host.domain.com'], ('', '', '')) |
| 69 |
data = ( |
| 70 |
"default", |
| 71 |
"default login", |
| 72 |
"default account", |
| 73 |
"default password", |
| 74 |
"default login \"\" account", |
| 75 |
"default login \"\" password", |
| 76 |
"default account \"\" password" |
| 77 |
) |
| 78 |
for item in data: |
| 79 |
nrc = self.make_nrc(item) |
| 80 |
self.assertEqual(nrc.hosts['default'], ('', '', '')) |
| 81 |
|
| 82 |
def test_invalid_tokens(self): |
| 83 |
data = ( |
| 84 |
"invalid host.domain.com", |
| 85 |
"machine host.domain.com invalid", |
| 86 |
"machine host.domain.com login log password pass account acct invalid", |
| 87 |
"default host.domain.com invalid", |
| 88 |
"default host.domain.com login log password pass account acct invalid" |
| 89 |
) |
| 90 |
for item in data: |
| 91 |
self.assertRaises(netrc.NetrcParseError, self.make_nrc, item) |
| 92 |
|
| 93 |
def _test_token_x(self, nrc, token, value): |
| 94 |
nrc = self.make_nrc(nrc) |
| 95 |
if token == 'login': |
| 96 |
self.assertEqual(nrc.hosts['host.domain.com'], (value, 'acct', 'pass')) |
| 97 |
elif token == 'account': |
| 98 |
self.assertEqual(nrc.hosts['host.domain.com'], ('log', value, 'pass')) |
| 99 |
elif token == 'password': |
| 100 |
self.assertEqual(nrc.hosts['host.domain.com'], ('log', 'acct', value)) |
| 101 |
|
| 102 |
def test_token_value_quotes(self): |
| 103 |
self._test_token_x("""\ |
| 104 |
machine host.domain.com login "log" password pass account acct |
| 105 |
""", 'login', 'log') |
| 106 |
self._test_token_x("""\ |
| 107 |
machine host.domain.com login log password pass account "acct" |
| 108 |
""", 'account', 'acct') |
| 109 |
self._test_token_x("""\ |
| 110 |
machine host.domain.com login log password "pass" account acct |
| 111 |
""", 'password', 'pass') |
| 112 |
|
| 113 |
def test_token_value_escape(self): |
| 114 |
self._test_token_x("""\ |
| 115 |
machine host.domain.com login \\"log password pass account acct |
| 116 |
""", 'login', '"log') |
| 117 |
self._test_token_x("""\ |
| 118 |
machine host.domain.com login "\\"log" password pass account acct |
| 119 |
""", 'login', '"log') |
| 120 |
self._test_token_x("""\ |
| 121 |
machine host.domain.com login log password pass account \\"acct |
| 122 |
""", 'account', '"acct') |
| 123 |
self._test_token_x("""\ |
| 124 |
machine host.domain.com login log password pass account "\\"acct" |
| 125 |
""", 'account', '"acct') |
| 126 |
self._test_token_x("""\ |
| 127 |
machine host.domain.com login log password \\"pass account acct |
| 128 |
""", 'password', '"pass') |
| 129 |
self._test_token_x("""\ |
| 130 |
machine host.domain.com login log password "\\"pass" account acct |
| 131 |
""", 'password', '"pass') |
| 132 |
|
| 133 |
def test_token_value_whitespace(self): |
| 134 |
self._test_token_x("""\ |
| 135 |
machine host.domain.com login "lo g" password pass account acct |
| 136 |
""", 'login', 'lo g') |
| 137 |
self._test_token_x("""\ |
| 138 |
machine host.domain.com login log password "pas s" account acct |
| 139 |
""", 'password', 'pas s') |
| 140 |
self._test_token_x("""\ |
| 141 |
machine host.domain.com login log password pass account "acc t" |
| 142 |
""", 'account', 'acc t') |
| 143 |
|
| 144 |
def test_token_value_non_ascii(self): |
| 145 |
self._test_token_x("""\ |
| 146 |
machine host.domain.com login \xa1\xa2 password pass account acct |
| 147 |
""", 'login', '\xa1\xa2') |
| 148 |
self._test_token_x("""\ |
| 149 |
machine host.domain.com login log password pass account \xa1\xa2 |
| 150 |
""", 'account', '\xa1\xa2') |
| 151 |
self._test_token_x("""\ |
| 152 |
machine host.domain.com login log password \xa1\xa2 account acct |
| 153 |
""", 'password', '\xa1\xa2') |
| 154 |
|
| 155 |
def test_token_value_leading_hash(self): |
| 156 |
self._test_token_x("""\ |
| 157 |
machine host.domain.com login #log password pass account acct |
| 158 |
""", 'login', '#log') |
| 159 |
self._test_token_x("""\ |
| 160 |
machine host.domain.com login log password pass account #acct |
| 161 |
""", 'account', '#acct') |
| 162 |
self._test_token_x("""\ |
| 163 |
machine host.domain.com login log password #pass account acct |
| 164 |
""", 'password', '#pass') |
| 165 |
|
| 166 |
def test_token_value_trailing_hash(self): |
| 167 |
self._test_token_x("""\ |
| 168 |
machine host.domain.com login log# password pass account acct |
| 169 |
""", 'login', 'log#') |
| 170 |
self._test_token_x("""\ |
| 171 |
machine host.domain.com login log password pass account acct# |
| 172 |
""", 'account', 'acct#') |
| 173 |
self._test_token_x("""\ |
| 174 |
machine host.domain.com login log password pass# account acct |
| 175 |
""", 'password', 'pass#') |
| 176 |
|
| 177 |
def test_token_value_internal_hash(self): |
| 178 |
self._test_token_x("""\ |
| 179 |
machine host.domain.com login lo#g password pass account acct |
| 180 |
""", 'login', 'lo#g') |
| 181 |
self._test_token_x("""\ |
| 182 |
machine host.domain.com login log password pass account ac#ct |
| 183 |
""", 'account', 'ac#ct') |
| 184 |
self._test_token_x("""\ |
| 185 |
machine host.domain.com login log password pa#ss account acct |
| 186 |
""", 'password', 'pa#ss') |
| 187 |
|
| 188 |
def _test_comment(self, nrc, passwd='pass'): |
| 189 |
nrc = self.make_nrc(nrc) |
| 190 |
self.assertEqual(nrc.hosts['foo.domain.com'], ('bar', '', passwd)) |
| 191 |
self.assertEqual(nrc.hosts['bar.domain.com'], ('foo', '', 'pass')) |
| 192 |
|
| 193 |
def test_comment_before_machine_line(self): |
| 194 |
self._test_comment("""\ |
| 195 |
# comment |
| 196 |
machine foo.domain.com login bar password pass |
| 197 |
machine bar.domain.com login foo password pass |
| 198 |
""") |
| 199 |
|
| 200 |
def test_comment_before_machine_line_no_space(self): |
| 201 |
self._test_comment("""\ |
| 202 |
#comment |
| 203 |
machine foo.domain.com login bar password pass |
| 204 |
machine bar.domain.com login foo password pass |
| 205 |
""") |
| 206 |
|
| 207 |
def test_comment_before_machine_line_hash_only(self): |
| 208 |
self._test_comment("""\ |
| 209 |
# |
| 210 |
machine foo.domain.com login bar password pass |
| 211 |
machine bar.domain.com login foo password pass |
| 212 |
""") |
| 213 |
|
| 214 |
def test_comment_after_machine_line(self): |
| 215 |
self._test_comment("""\ |
| 216 |
machine foo.domain.com login bar password pass |
| 217 |
# comment |
| 218 |
machine bar.domain.com login foo password pass |
| 219 |
""") |
| 220 |
self._test_comment("""\ |
| 221 |
machine foo.domain.com login bar password pass |
| 222 |
machine bar.domain.com login foo password pass |
| 223 |
# comment |
| 224 |
""") |
| 225 |
|
| 226 |
def test_comment_after_machine_line_no_space(self): |
| 227 |
self._test_comment("""\ |
| 228 |
machine foo.domain.com login bar password pass |
| 229 |
#comment |
| 230 |
machine bar.domain.com login foo password pass |
| 231 |
""") |
| 232 |
self._test_comment("""\ |
| 233 |
machine foo.domain.com login bar password pass |
| 234 |
machine bar.domain.com login foo password pass |
| 235 |
#comment |
| 236 |
""") |
| 237 |
|
| 238 |
def test_comment_after_machine_line_hash_only(self): |
| 239 |
self._test_comment("""\ |
| 240 |
machine foo.domain.com login bar password pass |
| 241 |
# |
| 242 |
machine bar.domain.com login foo password pass |
| 243 |
""") |
| 244 |
self._test_comment("""\ |
| 245 |
machine foo.domain.com login bar password pass |
| 246 |
machine bar.domain.com login foo password pass |
| 247 |
# |
| 248 |
""") |
| 249 |
|
| 250 |
def test_comment_at_end_of_machine_line(self): |
| 251 |
self._test_comment("""\ |
| 252 |
machine foo.domain.com login bar password pass # comment |
| 253 |
machine bar.domain.com login foo password pass |
| 254 |
""") |
| 255 |
|
| 256 |
def test_comment_at_end_of_machine_line_no_space(self): |
| 257 |
self._test_comment("""\ |
| 258 |
machine foo.domain.com login bar password pass #comment |
| 259 |
machine bar.domain.com login foo password pass |
| 260 |
""") |
| 261 |
|
| 262 |
def test_comment_at_end_of_machine_line_pass_has_hash(self): |
| 263 |
self._test_comment("""\ |
| 264 |
machine foo.domain.com login bar password #pass #comment |
| 265 |
machine bar.domain.com login foo password pass |
| 266 |
""", '#pass') |
| 267 |
|
| 268 |
@unittest.skipUnless(support.is_wasi, 'WASI only test') |
| 269 |
def test_security_on_WASI(self): |
| 270 |
self.assertFalse(netrc._can_security_check()) |
| 271 |
self.assertEqual(netrc._getpwuid(0), 'uid 0') |
| 272 |
self.assertEqual(netrc._getpwuid(123456), 'uid 123456') |
| 273 |
|
| 274 |
@unittest.skipUnless(os.name == 'posix', 'POSIX only test') |
| 275 |
@unittest.skipUnless(hasattr(os, 'getuid'), "os.getuid is required") |
| 276 |
@os_helper.skip_unless_working_chmod |
| 277 |
def test_security(self): |
| 278 |
# This test is incomplete since we are normally not run as root and |
| 279 |
# therefore can't test the file ownership being wrong. |
| 280 |
d = os_helper.TESTFN |
| 281 |
os.mkdir(d) |
| 282 |
self.addCleanup(os_helper.rmtree, d) |
| 283 |
fn = os.path.join(d, '.netrc') |
| 284 |
with open(fn, 'wt') as f: |
| 285 |
f.write("""\ |
| 286 |
machine foo.domain.com login bar password pass |
| 287 |
default login foo password pass |
| 288 |
""") |
| 289 |
with os_helper.EnvironmentVarGuard() as environ: |
| 290 |
environ.set('HOME', d) |
| 291 |
os.chmod(fn, 0o600) |
| 292 |
nrc = netrc.netrc() |
| 293 |
self.assertEqual(nrc.hosts['foo.domain.com'], |
| 294 |
('bar', '', 'pass')) |
| 295 |
os.chmod(fn, 0o622) |
| 296 |
self.assertRaises(netrc.NetrcParseError, netrc.netrc) |
| 297 |
with open(fn, 'wt') as f: |
| 298 |
f.write("""\ |
| 299 |
machine foo.domain.com login anonymous password pass |
| 300 |
default login foo password pass |
| 301 |
""") |
| 302 |
with os_helper.EnvironmentVarGuard() as environ: |
| 303 |
environ.set('HOME', d) |
| 304 |
os.chmod(fn, 0o600) |
| 305 |
nrc = netrc.netrc() |
| 306 |
self.assertEqual(nrc.hosts['foo.domain.com'], |
| 307 |
('anonymous', '', 'pass')) |
| 308 |
os.chmod(fn, 0o622) |
| 309 |
self.assertEqual(nrc.hosts['foo.domain.com'], |
| 310 |
('anonymous', '', 'pass')) |
| 311 |
|
| 312 |
|
| 313 |
if __name__ == "__main__": |
| 314 |
unittest.main() |