8000 Make the crypto module doc match the code on the supported schemes and where the EncryptionInfo is by dominion525 · Pull Request #165 · dominion525/jetdb · GitHub
[go: up one dir, main page]
Skip to content

Make the crypto module doc match the code on the supported schemes and where the EncryptionInfo is - #165

Merged
dominion525 merged 1 commit into
mainfrom
docs/crypto-module-doc
Oct 26, 2026
Merged

Make the crypto module doc match the code on the supported schemes and where the EncryptionInfo is#165
dominion525 merged 1 commit into
mainfrom
docs/crypto-module-doc

Conversation

@dominion525
@dominion525 dominion525 commented Oct 26, 2026
Copy link
Copy Markdown
Owner

Summary

  • The module doc of crates/jetdb/src/crypto.rs did not list Standard AES, which crypto.rs reads and decrypts when the EncryptionInfo has the AES flag.
  • It said the EncryptionInfo is stored at page 0 offset 0x299; 0x299 holds its length (u16 LE), and the EncryptionInfo starts at 0x29B.
  • The comment of ENCRYPTION_INFO_OFFSET in format.rs said the offset is for Agile Encryption; the length is read there for every scheme, before the scheme is known.
  • Comments only; no code changes.

🤖 Generated with Claude Code

@dominion525 @claude
Make the crypto module doc match the code on the supported schemes an…
505e582 
…d where the EncryptionInfo is

- List Standard AES among the supported schemes
- Say that 0x299 holds the length of the EncryptionInfo and that the EncryptionInfo starts at 0x29B
- Drop from the comment of ENCRYPTION_INFO_OFFSET that it is for Agile Encryption, as every scheme has it

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@github-actions
github-actions Bot commented Oct 26, 2026
Copy link
Copy Markdown

Coverage

For 505e582.

Filename                       Regions    Missed Regions     Cover   Functions  Missed Functions  Executed       Lines      Missed Lines     Cover    Branches   Missed Branches     Cover
------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
jetdb-cli/src/export.rs            118                11    90.68%           6                 0   100.00%          65                 6    90.77%           0                 0         -
jetdb-cli/src/form.rs              239                19    92.05%          24                 5    79.17%         151                 6    96.03%           0                 0         -
jetdb-cli/src/macro_cmd.rs         117                10    91.45%           7                 2    71.43%          62                 4    93.55%           0                 0         -
jetdb-cli/src/main.rs              911                40    95.61%          82                 4    95.12%         579                29    94.99%           0                 0         -
jetdb-cli/src/prop.rs              332                20    93.98%          38                 2    94.74%         194                 9    95.36%           0                 0         -
jetdb-cli/src/query.rs              65                 3    95.38%           5                 0   100.00%          32                 0   100.00%           0                 0         -
jetdb-cli/src/vba.rs                59                 3    94.92%           5                 0   100.00%          28                 0   100.00%           0                 0         -
jetdb-wasm/src/lib.rs             3917               103    97.37%         257                 4    98.44%        2064                29    98.59%           0                 0         -
jetdb/src/catalog.rs               509                14    97.25%          46                 0   100.00%         299                 3    99.00%           0                 0         -
jetdb/src/complex.rs               924                32    96.54%          73                 0   100.00%         605                15    97.52%           0                 0         -
jetdb/src/crypto.rs               2300               112    95.13%         127                10    92.13%        1315                60    95.44%           0                 0         -
jetdb/src/csv.rs                   867                24    97.23%          73                 0   100.00%         492                 6    98.78%           0                 0         -
jetdb/src/data.rs                 4698                91    98.06%         295                 3    98.98%        2663                51    98.08%           0                 0         -
jetdb/src/ddl/access.rs             70                 0   100.00%           7                 0   100.00%          46                 0   100.00%           0                 0         -
jetdb/src/ddl/mod.rs              2771                 8    99.71%         208                 2    99.04%        1501                 6    99.60%           0                 0         -
jetdb/src/ddl/mysql.rs              70                 0   100.00%           7                 0   100.00%          46                 0   100.00%           0                 0         -
jetdb/src/ddl/postgres.rs           71                 0   100.00%           7                 0   100.00%          46                 0   100.00%           0                 0         -
jetdb/src/ddl/sqlite.rs             69                 0   100.00%           7                 0   100.00%          48                 0   100.00%           0                 0         -
jetdb/src/encoding.rs              284                 0   100.00%          30                 0   100.00%         153                 0   100.00%           0                 0         -
jetdb/src/file.rs                 1915                65    96.61%         117                 0   100.00%         983                18    98.17%           0                 0         -
jetdb/src/form.rs                 3212               128    96.01%         238                10    95.80%        1730                49    97.17%           0                 0         -
jetdb/src/form2000.rs              800                20    97.50%          62                 1    98.39%         425                 4    99.06%           0                 0         -
jetdb/src/format.rs                616                 2    99.68%          45                 0   100.00%         388                 2    99.48%           0                 0         -
jetdb/src/lib.rs                    10                 3    70.00%           1                 0   100.00%           7                 2    71.43%           0                 0         -
jetdb/src/macro_action.rs          299                19    93.65%          27                 3    88.89%         165                24    85.45%           0                 0         -
jetdb/src/macro_def.rs            2440                88    96.39%         196                 9    95.41%        1596                36    97.74%           0                 0         -
jetdb/src/macro_text.rs            804                24    97.01%          54                 2    96.30%         451                20    95.57%           0                 0         -
jetdb/src/map.rs                   416                13    96.88%          27                 0   100.00%         221                 5    97.74%           0                 0         -
jetdb/src/money.rs                 296                 0   100.00%          28                 0   100.00%         190                 0   100.00%           0                 0         -
jetdb/src/prop.rs                 1375                18    98.69%          90                 0   100.00%         695                10    98.56%           0                 0         -
jetdb/src/query.rs                2514                62    97.53%         200                 1    99.50%        1550                18    98.84%           0                 0         -
jetdb/src/relationship.rs          249                26    89.56%          22                 0   100.00%         177                10    94.35%           0                 0         -
jetdb/src/save_as_text.rs          574                27    95.30%          52                 3    94.23%         341                27    92.08%           0                 0         -
jetdb/src/storage.rs               764                32    95.81%          57                 0   100.00%         434                 6    98.62%           0                 0         -
jetdb/src/table.rs                1679                67    96.01%         109                 2    98.17%        1017                18    98.23%           0                 0         -
jetdb/src/timestamp.rs             491                 0   100.00%          51                 0   100.00%         285                 0   100.00%           0                 0         -
jetdb/src/vba.rs                   949                57    93.99%          82                11    86.59%         540                21    96.11%           0                 0         -
------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
TOTAL                            37794              1141    96.98%        2762                74    97.32%       21584               494    97.71%           0                 0         -

@dominion525
dominion525 merged 8000 commit 03c8680 into main Oct 26, 2026
11 checks passed
@dominion525
dominion525 deleted the docs/crypto-module-doc branch October 26, 2026 17:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@dominion525
0