diff --git a/README.md b/README.md index 55169a1..26993d1 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,10 @@ This software was not developed by an experienced security expert and should be used with caution. There may be bugs and missing features. Each vault chunk is limited to 50 KB and SeedPass periodically publishes a new snapshot to keep accumulated deltas small. The security of the program's memory management and logs has not been evaluated and may leak sensitive information. Loss or exposure of the parent seed places all derived passwords, accounts, and other artifacts at risk. +**🚨 Breaking Change** + +Recent releases derive passwords and other artifacts using a fully deterministic algorithm that behaves consistently across Python versions. This improvement means artifacts generated with earlier versions of SeedPass will not match those produced now. Regenerate any previously derived data or retain the old version if you need to reproduce older passwords or keys. + --- ### Supported OS diff --git a/docs/docs/content/01-getting-started/04-migrations.md b/docs/docs/content/01-getting-started/04-migrations.md index f6a1ce0..c3b20f8 100644 --- a/docs/docs/content/01-getting-started/04-migrations.md +++ b/docs/docs/content/01-getting-started/04-migrations.md @@ -3,6 +3,8 @@ SeedPass stores its password index in an encrypted JSON file. Each index contains a `schema_version` field so the application knows how to upgrade older files. +> **Note:** Recent releases derive passwords and other artifacts using a new deterministic algorithm that works consistently across Python versions. Artifacts produced with older versions will not match outputs from this release and must be regenerated. + ## How migrations work When the vault loads the index, `Vault.load_index()` checks the version and diff --git a/docs/docs/content/index.md b/docs/docs/content/index.md index 96f4a8d..f6bc594 100644 --- a/docs/docs/content/index.md +++ b/docs/docs/content/index.md @@ -10,6 +10,10 @@ This software was not developed by an experienced security expert and should be used with caution. There may be bugs and missing features. Each vault chunk is limited to 50 KB and SeedPass periodically publishes a new snapshot to keep accumulated deltas small. The security of the program's memory management and logs has not been evaluated and may leak sensitive information. Loss or exposure of the parent seed places all derived passwords, accounts, and other artifacts at risk. +**🚨 Breaking Change** + +Recent releases derive passwords and other artifacts using a fully deterministic algorithm that behaves consistently across Python versions. This improvement means artifacts generated with earlier versions of SeedPass will not match those produced now. Regenerate any previously derived data or retain the old version if you need to reproduce older passwords or keys. + --- ### Supported OS