mirror of
https://github.com/theupdateframework/python-tuf
synced 2026-05-24 10:08:28 +00:00
Clarify docstring commets about Mercury paper
Signed-off-by: Martin Vrachev <mvrachev@vmware.com>
This commit is contained in:
parent
2297c4b501
commit
80818e9ee1
2 changed files with 20 additions and 12 deletions
|
|
@ -1561,14 +1561,16 @@ def generate_snapshot_metadata(metadata_directory, version, expiration_date,
|
|||
use_length:
|
||||
Whether to include the optional length attribute for targets
|
||||
metadata files in the snapshot metadata.
|
||||
Default is False because of bandwidth considerations.
|
||||
Default is False to save bandwidth but without losing security
|
||||
from rollback attacks.
|
||||
Read more at section 5.6 from the Mercury paper:
|
||||
https://www.usenix.org/conference/atc17/technical-sessions/presentation/kuppusamy
|
||||
|
||||
use_hashes:
|
||||
Whether to include the optional hashes attribute for targets
|
||||
metadata files in the snapshot metadata.
|
||||
Default is False because of bandwidth considerations.
|
||||
Default is False to save bandwidth but without losing security
|
||||
from rollback attacks.
|
||||
Read more at section 5.6 from the Mercury paper:
|
||||
https://www.usenix.org/conference/atc17/technical-sessions/presentation/kuppusamy
|
||||
|
||||
|
|
|
|||
|
|
@ -191,14 +191,16 @@ class Repository(object):
|
|||
use_snapshot_length:
|
||||
Whether to include the optional length attribute for targets
|
||||
metadata files in the snapshot metadata.
|
||||
Default is False because of bandwidth considerations.
|
||||
Default is False to save bandwidth but without losing security
|
||||
from rollback attacks.
|
||||
Read more at section 5.6 from the Mercury paper:
|
||||
https://www.usenix.org/conference/atc17/technical-sessions/presentation/kuppusamy
|
||||
|
||||
use_snapshot_hashes:
|
||||
Whether to include the optional hashes attribute for targets
|
||||
metadata files in the snapshot metadata.
|
||||
Default is False because of bandwidth considerations.
|
||||
Default is False to save bandwidth but without losing security
|
||||
from rollback attacks.
|
||||
Read more at section 5.6 from the Mercury paper:
|
||||
https://www.usenix.org/conference/atc17/technical-sessions/presentation/kuppusamy
|
||||
|
||||
|
|
@ -2918,15 +2920,17 @@ def create_new_repository(repository_directory, repository_name='default',
|
|||
use_snapshot_length:
|
||||
Whether to include the optional length attribute for targets
|
||||
metadata files in the snapshot metadata.
|
||||
Default is False because of bandwidth considerations.
|
||||
Read more here:
|
||||
Default is False to save bandwidth but without losing security
|
||||
from rollback attacks.
|
||||
Read more at section 5.6 from the Mercury paper:
|
||||
https://www.usenix.org/conference/atc17/technical-sessions/presentation/kuppusamy
|
||||
|
||||
use_snapshot_hashes:
|
||||
Whether to include the optional hashes attribute for targets
|
||||
metadata files in the snapshot metadata.
|
||||
Default is False because of bandwidth considerations.
|
||||
Read more here:
|
||||
Default is False to save bandwidth but without losing security
|
||||
from rollback attacks.
|
||||
Read more at section 5.6 from the Mercury paper:
|
||||
https://www.usenix.org/conference/atc17/technical-sessions/presentation/kuppusamy
|
||||
|
||||
<Exceptions>
|
||||
|
|
@ -3025,15 +3029,17 @@ def load_repository(repository_directory, repository_name='default',
|
|||
use_snapshot_length:
|
||||
Whether to include the optional length attribute for targets
|
||||
metadata files in the snapshot metadata.
|
||||
Default is False because of bandwidth considerations.
|
||||
Read more here:
|
||||
Default is False to save bandwidth but without losing security
|
||||
from rollback attacks.
|
||||
Read more at section 5.6 from the Mercury paper:
|
||||
https://www.usenix.org/conference/atc17/technical-sessions/presentation/kuppusamy
|
||||
|
||||
use_snapshot_hashes:
|
||||
Whether to include the optional hashes attribute for targets
|
||||
metadata files in the snapshot metadata.
|
||||
Default is False because of bandwidth considerations.
|
||||
Read more here:
|
||||
Default is False to save bandwidth but without losing security
|
||||
from rollback attacks.
|
||||
Read more at section 5.6 from the Mercury paper:
|
||||
https://www.usenix.org/conference/atc17/technical-sessions/presentation/kuppusamy
|
||||
|
||||
<Exceptions>
|
||||
|
|
|
|||
Loading…
Reference in a new issue