comparison roundup/configuration.py @ 8043:69629a4f7262

doc: in description, replace field with header for csrf_* settings The doc for the csrf_* settings referered to "field is missing" when referencing it as headers elsewhere in the doc. Change to use header instead of field to reduce confusion.
author John Rouillard <rouilj@ieee.org>
date Tue, 25 Jun 2024 12:10:14 -0400
parents 9ba60ddafd2a
children 5a2b9435a04d
comparison
equal deleted inserted replaced
8042:9ba60ddafd2a 8043:69629a4f7262
1346 tracker.web setting in config.ini. 1346 tracker.web setting in config.ini.
1347 Set this to 'required' to block the post and notify 1347 Set this to 'required' to block the post and notify
1348 the user if the header is missing or invalid. 1348 the user if the header is missing or invalid.
1349 Set this to 'yes' to block the post and notify the user 1349 Set this to 'yes' to block the post and notify the user
1350 if the header is invalid, but accept the form if 1350 if the header is invalid, but accept the form if
1351 the field is missing. 1351 the header is missing.
1352 Set this to 'logfailure' to log a notice to the roundup 1352 Set this to 'logfailure' to log a notice to the roundup
1353 log if the header is invalid or missing, but accept 1353 log if the header is invalid or missing, but accept
1354 the post. 1354 the post.
1355 Set this to 'no' to ignore the header and accept the post."""), 1355 Set this to 'no' to ignore the header and accept the post."""),
1356 (CsrfSettingOption, 'csrf_enforce_header_origin', "yes", 1356 (CsrfSettingOption, 'csrf_enforce_header_origin', "yes",
1358 tracker.web setting in config.ini. 1358 tracker.web setting in config.ini.
1359 Set this to 'required' to block the post and notify 1359 Set this to 'required' to block the post and notify
1360 the user if the header is missing or invalid. 1360 the user if the header is missing or invalid.
1361 Set this to 'yes' to block the post and notify the user 1361 Set this to 'yes' to block the post and notify the user
1362 if the header is invalid, but accept the form if 1362 if the header is invalid, but accept the form if
1363 the field is missing. 1363 the header is missing.
1364 Set this to 'logfailure' to log a notice to the roundup 1364 Set this to 'logfailure' to log a notice to the roundup
1365 log if the header is invalid or missing, but accept 1365 log if the header is invalid or missing, but accept
1366 the post. 1366 the post.
1367 Set this to 'no' to ignore the header and accept the post."""), 1367 Set this to 'no' to ignore the header and accept the post."""),
1368 (OriginHeadersListOption, 'allowed_api_origins', "", 1368 (OriginHeadersListOption, 'allowed_api_origins', "",
1389 the host part of the tracker.web setting in config.ini. 1389 the host part of the tracker.web setting in config.ini.
1390 Set this to 'required' to block the post and notify 1390 Set this to 'required' to block the post and notify
1391 the user if the header is missing or invalid. 1391 the user if the header is missing or invalid.
1392 Set this to 'yes' to block the post and notify the user 1392 Set this to 'yes' to block the post and notify the user
1393 if the header is invalid, but accept the form if 1393 if the header is invalid, but accept the form if
1394 the field is missing. 1394 the header is missing.
1395 Set this to 'logfailure' to log a notice to the roundup 1395 Set this to 'logfailure' to log a notice to the roundup
1396 log if the header is invalid or missing, but accept 1396 log if the header is invalid or missing, but accept
1397 the post. 1397 the post.
1398 Set this to 'no' to ignore the header and accept the post."""), 1398 Set this to 'no' to ignore the header and accept the post."""),
1399 (CsrfSettingOption, 'csrf_enforce_header_host', "yes", 1399 (CsrfSettingOption, 'csrf_enforce_header_host', "yes",
1402 tracker.web setting in config.ini. 1402 tracker.web setting in config.ini.
1403 Set this to 'required' to block the post and notify 1403 Set this to 'required' to block the post and notify
1404 the user if the header is missing or invalid. 1404 the user if the header is missing or invalid.
1405 Set this to 'yes' to block the post and notify the user 1405 Set this to 'yes' to block the post and notify the user
1406 if the header is invalid, but accept the form if 1406 if the header is invalid, but accept the form if
1407 the field is missing. 1407 the header is missing.
1408 Set this to 'logfailure' to log a notice to the roundup 1408 Set this to 'logfailure' to log a notice to the roundup
1409 log if the header is invalid or missing, but accept 1409 log if the header is invalid or missing, but accept
1410 the post. 1410 the post.
1411 Set this to 'no' to ignore the header and accept the post."""), 1411 Set this to 'no' to ignore the header and accept the post."""),
1412 (IntegerNumberGeqZeroOption, 'csrf_header_min_count', "1", 1412 (IntegerNumberGeqZeroOption, 'csrf_header_min_count', "1",

Roundup Issue Tracker: http://roundup-tracker.org/