Skip to content

Commit 93ebcfe

Browse files
unverbuggtunverbuggt
committed
update documentation for crypto-es
1 parent a698fbb commit 93ebcfe

File tree

3 files changed

+52
-34
lines changed

3 files changed

+52
-34
lines changed

‎README.md‎

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ In order to use environment variables in user names or passwords, use the
7777
* [Arithmatex support](#Arithmatex-support)
7878
* [Mermaid.js support](#Mermaid.js-support)
7979
* [Security](#Security)
80-
* [Crypto-js or webcrypto?](#Crypto-js-or-webcrypto?)
80+
* [Crypto-js, crypto-es or webcrypto?](#Crypto-js,-crypto-es-or-webcrypto?)
8181
* [File name obfuscation](#File-name-obfuscation)
8282
* [Signing of generated files](#Signing-of-generated-files)
8383

@@ -923,20 +923,29 @@ The script is called after successful decryption and renders the mermaid graphs
923923
the theme would normally do.
924924
## Security
925925

926-
### Crypto-js or webcrypto?
926+
### Crypto-js, crypto-es or webcrypto?
927927

928928
By default the plugin uses the crypto-js library for page decryption, but using
929-
the browser's built-in webcrypto engine is also possible (set `webcrypto: True`).
929+
the browser's built-in webcrypto engine is also possible (set `webcrypto: true`).
930930

931931
The main advantage of webcrypto over crypto-js is that it is much faster, allowing higher
932932
calculation difficulty for key derivation (`kdf_pow`). Also it may be easier to implement
933933
key derivation functions other than PBKDF2 with webcrypto in the future.
934934

935-
On the other hand crypto-js is implemented in pure Javascript without dependencies and well
936-
tested (but it probably won't receive any updates as development stalled in 2021)
935+
On the other hand crypto-js is implemented in pure Javascript without any dependencies and well
936+
tested (but it probably won't receive any updates as development stalled in 2021, see [here](https://github.com/brix/crypto-js/#discontinued))
937937
and we know nothing about how good or bad webcrypto is implemented in different browsers.
938938

939-
#### Self-host crypto-js
939+
There is a new variation of [crypto-js](https://github.com/brix/crypto-js), called [crypto-es](https://github.com/entronad/crypto-es).
940+
It provides the same functions, but is implemented in modern javascript and can be activated by setting `esm: true`.
941+
If `webcrypto: true` and `esm: true` is set, then webcrypto will be loaded as a
942+
javascript module (speeding up material theme with instant loading feature).
943+
944+
> Crypto-js causes a bug when browsing through encrypted pages,
945+
> if used in `mkdocs-material` together with the `navigation.instant` feature.
946+
> It is advised to use `webcrypto: true` or crypto-es with `esm: true` in this case.
947+
948+
#### Self-host Crypto-js or Crypto-es
940949

941950
If you enable `selfhost` then you'll choose to upload crypto-js to your web server rather than using cloudflare CDN.
942951
The self-host location is "SITE_URL/assets/javascripts/cryptojs/".

‎documentation/docs/features/security.md‎

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,28 @@
11
## Security
22

3-
### Crypto-js or webcrypto?
3+
### Crypto-js, crypto-es or webcrypto?
44

55
By default the plugin uses the crypto-js library for page decryption, but using
6-
the browser's built-in webcrypto engine is also possible (set `webcrypto: True`).
6+
the browser's built-in webcrypto engine is also possible (set `webcrypto: true`).
77

88
The main advantage of webcrypto over crypto-js is that it is much faster, allowing higher
99
calculation difficulty for key derivation (`kdf_pow`). Also it may be easier to implement
1010
key derivation functions other than PBKDF2 with webcrypto in the future.
1111

12-
On the other hand crypto-js is implemented in pure Javascript without dependencies and well
13-
tested (but it probably won't receive any updates as development stalled in 2021)
12+
On the other hand crypto-js is implemented in pure Javascript without any dependencies and well
13+
tested (but it probably won't receive any updates as development stalled in 2021, see [here](https://github.com/brix/crypto-js/#discontinued))
1414
and we know nothing about how good or bad webcrypto is implemented in different browsers.
1515

16-
#### Self-host crypto-js
16+
There is a new variation of [crypto-js](https://github.com/brix/crypto-js), called [crypto-es](https://github.com/entronad/crypto-es).
17+
It provides the same functions, but is implemented in modern javascript and can be activated by setting `esm: true`.
18+
If `webcrypto: true` and `esm: true` is set, then webcrypto will be loaded as a
19+
javascript module (speeding up material theme with instant loading feature).
20+
21+
> Crypto-js causes a bug when browsing through encrypted pages,
22+
> if used in `mkdocs-material` together with the `navigation.instant` feature.
23+
> It is advised to use `webcrypto: true` or crypto-es with `esm: true` in this case.
24+
25+
#### Self-host Crypto-js or Crypto-es
1726

1827
If you enable `selfhost` then you'll choose to upload crypto-js to your web server rather than using cloudflare CDN.
1928
The self-host location is "SITE_URL/assets/javascripts/cryptojs/".

‎documentation/encryptcontent.cache‎

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,27 @@
11
kdf_iterations: 100000
22
obfuscate:
3-
Crawler be gone!: 711f92110a8dd89b94ea1124581afcc9a9b9881493405c3d9257e60debf4ab8b;9279e068c38dffcfc91040b486b7712d;1d33d92c9a0575adc758448318661831aca40e21d6a2df25289dd7ec6c8eaff9
4-
Kriechtier hau ab!: 2e1a0274df07ad25ba5ed18d01ebdb0cc29fdfb2ca7c2ac2a3d2b16eb3d4c251;5c0de2e3b5ef0243c2e37ac7f7819479;742046b038ee3ac691c570072da792e27c2cd4e4559cd12e6fc789062b55f5ba
3+
Crawler be gone!: 0f55b28d6b4c41b39ab02050244006b6935cae92f202aebf9ef7087bfeec8817;ac4e84ab4d80c19ab10fa1c8ffa91d48;1d33d92c9a0575adc758448318661831aca40e21d6a2df25289dd7ec6c8eaff9
4+
Kriechtier hau ab!: 530113ac1dfb0546568a826dd154cc0cb32614f81e9be57d7da2023e4c7c564b;514751d957e2dcd6d823c4eac76277ee;742046b038ee3ac691c570072da792e27c2cd4e4559cd12e6fc789062b55f5ba
55
password:
6-
C4bbage Profile blinking: 8fe8c8d23a651f25a4b975c0aa66c50f0cf3f73c27fad1b17f699e4c23dbd25e;a334f1ae4e6de2478005abb227864b6f;94f412a70a4d3b4706ba1430bde980bb64d181547ff74c9d42f4520d807c0cdb
7-
Clique.Shampoo.Ve55el: 62afff53da7664d055f44ec8ee0bcb9804aafa92dab285cf04d7209efc12335d;18af2ffe7cc0db381f4d0c626febf677;71f79f20ed1ff827531bb581334583168f3cb66f6afec2ac5a329b88d396aae9
8-
Hatless,hertz,C4lzone: 3cb464dbe5ffdce566b38966049f12ec992091bccd1981390ad51a64faa4d81e;11473243debfe6ce9ecc094d945c4810;f0aabe443c278b157d7c6e34eb67a9273e33acd4d9324dcf14a5fcdd32af2883
9-
Head32_Sculpture_bovine_: 6ae8a090dfc04663866864ee36f427545e3f2597f604ad58dd5566c2bdcc19ba;6f8e39574b9baa6f4d094204af96b0a0;41e11778e2f2d5c1551392aba6f96dbd580426b109a3cea1f2b62cc323d43563
10-
Negotiator-leftover-567: e6b3b45aef9ff223a4da5ff36ca80cb74e57954d24be34f19117cc3e3085ab4a;9b09716117d93e9214a1b0e81bea7a64;a774c2d2cbba8e60ed37cc32846a18b8149698e2c5a3a2ec55f722b5b5385947
11-
Password if PASSWORD2_FROM_ENV undefined or empty: d1d9e44ff073f8f673d935ec6674b519b3e1e97d89b1439b8a5080f7b9e8915c;0dd1a42c24f84592d822ca815f7362b1;25beb0c687ad6c69c82f76951ba4e4f739465a55944ce66d903788e44ed3af27
12-
SpotChestOilCycle22: 0155d08357940a620f4048ffcd66a3aa3be257d46e52d20098b026e2e2348f47;e1f147135505838c5e8d4bebd144c66f;6f166999fdb5968851efd563c9231546c349da41281db994ec67cc1eeef05c5e
13-
"TeGhD9aq\xDFQnHujmLdsa": a624d0f0390ac17556fa18cabc07fefc262641651e1b669448d19ab10a0f87f3;a5406e022938a90a7a4799fc641f2bbf;46ac08a4fdc9e7dcfd21bc4645e036d42bcf8c7c497a13d5e95f38aa67e29e1a
14-
"WOgh0\xDCwyKHoc*I_das": 9962c6b45cf7e0405304113014c15edc34f9d09538121e790089f7954a953961;53875d959cd9e911dcf442085c176353;2a9afc1fa2f32b7eb75c9052cc0c9978c4808763118afdb6e1baa2e1f365f04d
15-
"gncku\xE4shfliglkffhbvrG:Wurst": 96cc0e8b569ce4fa9031d1c2f1bf541c7f89f14029d636cfd52d9d522ace5935;61b1f50904c93f99f75d94a07310cd9f;ccda65e51e9b4643dc381fae28c25dc882989da4fdcbdeb0807479a7b7b25231
16-
m00dy#augmented#Arsonist: ec59d0f5889f8a91ec6a5a4cf9de9c1e1c91af08e4b80822a763cc8a23fc30ec;73a844548f0eac55ffc5e3a293e42c0e;afe95398efc93acd6e37c1bb185e6b07d7ab944aea5a60c6187c717db8673bd5
17-
moist:W00l:kept:royal: 4e85a7361fcb8c8f9f0aebc4bae5506eb465b6b1ad115020956073fb8d7c7d4c;dd0d280832d255fb65d6a0c440c235f8;4bb6ed11fa82cb2f1c9b3ad5dd092e740adfa356fb49102793979fdb7181d1ac
18-
"yDAHKmYjmCsA\xE9kUChasd": c04d21a4eaad20c990773f9e2ec2f0525e762f9339145a7108e23e6a1538ed26;15f36cd61fcd1f72582aa424c3277675;0859304b34a323dd4388e6a7ff248f51dd8ca88d49804cb05dca84d92d2383dd
6+
C4bbage Profile blinking: e44c04c01fbaa072b8e894d618d05db73f724eabd367904ea4c1848057563aa6;a126c0c006a7e2630967cb760a5abd32;94f412a70a4d3b4706ba1430bde980bb64d181547ff74c9d42f4520d807c0cdb
7+
Clique.Shampoo.Ve55el: b14e82fac7d5e71a688b8ee693441092b1f986090816b50825942da75000704e;91075dcb83380e9eb57735b253d0e602;71f79f20ed1ff827531bb581334583168f3cb66f6afec2ac5a329b88d396aae9
8+
Hatless,hertz,C4lzone: 4f867fda2a55bdcea4c9282a0f9500c8d242a7e546dced53fcaa01f6ea88d478;b5bba1e47841d4c1f92d48b1c7a568cc;f0aabe443c278b157d7c6e34eb67a9273e33acd4d9324dcf14a5fcdd32af2883
9+
Head32_Sculpture_bovine_: c91429da7625f5bbadfdde1a04355dc487ac4493042e795f3deb5f1ba14554be;4c13f011fffd76c221a97b11a37adf1d;41e11778e2f2d5c1551392aba6f96dbd580426b109a3cea1f2b62cc323d43563
10+
Negotiator-leftover-567: 4fdc5a958d58b91dffaf6b1afef75906d7e6d63fd4cef79f92970042a768db0d;5a262dd04653138f921e4c795a27433d;a774c2d2cbba8e60ed37cc32846a18b8149698e2c5a3a2ec55f722b5b5385947
11+
Password if PASSWORD2_FROM_ENV undefined or empty: afc8dfdd42daff85b4366b8565115158fa8f34e24eca87e93d14a2e4e13effbf;f0d7ce859b19e2ae581619c92e8f6bbb;25beb0c687ad6c69c82f76951ba4e4f739465a55944ce66d903788e44ed3af27
12+
SpotChestOilCycle22: f024872a4c3269d9ee6bb0431bf2f84f45a47c1cb0c0a6809a03e65ad82c833e;a166b70a2586223ec774c83840f570fb;6f166999fdb5968851efd563c9231546c349da41281db994ec67cc1eeef05c5e
13+
"TeGhD9aq\xDFQnHujmLdsa": 8ced5f4c26a9caaeb64859a16ec30dd08c79671bf3b9a4b3fdc49d0e52a66ef4;f07bfe75cae510567e6e2f24de6ae5d6;46ac08a4fdc9e7dcfd21bc4645e036d42bcf8c7c497a13d5e95f38aa67e29e1a
14+
"WOgh0\xDCwyKHoc*I_das": 1dfe7d872b9513006d38ce247b210adecab11f80e4fbee41841a3a348dc2cfd5;1aa18d82558e29e1b3d925aacf572644;2a9afc1fa2f32b7eb75c9052cc0c9978c4808763118afdb6e1baa2e1f365f04d
15+
"gncku\xE4shfliglkffhbvrG:Wurst": e4ad279aaf87fe509700885c2ada1712dffbf2820d270488b4e12cb3628ccf5c;da1c57514adbe32cf97f55f4ec95a061;ccda65e51e9b4643dc381fae28c25dc882989da4fdcbdeb0807479a7b7b25231
16+
m00dy#augmented#Arsonist: 1d0f4bc6e0522616f994e809c46a88de67137e2d8a6fc37d87d909931a1f2000;e616e156db08731855be61ae2e357f9b;afe95398efc93acd6e37c1bb185e6b07d7ab944aea5a60c6187c717db8673bd5
17+
moist:W00l:kept:royal: 969f2196c178a40693bb76372a9d5ab44f231f68e88e62eb28eb605be9ade5b1;e25064beb6674d563e6a2bfc29a0cdeb;4bb6ed11fa82cb2f1c9b3ad5dd092e740adfa356fb49102793979fdb7181d1ac
18+
"yDAHKmYjmCsA\xE9kUChasd": 887dd96ab192b6d83acf853b75ca50a8997bd808f0dbf999c2b552ce5f3a05a5;2e062e42b03f6885fdd20302cfb802c6;0859304b34a323dd4388e6a7ff248f51dd8ca88d49804cb05dca84d92d2383dd
1919
userpass:
20-
alice: 1a9dd7f612ff51a9633c83050fb03c48595aa99a363515de8bb3b6620a222284;0f4a14bdd81c05402b8a9e80a2f21f7c;b9dda5ae9d522ebb921baeb5fc18bf42f12434142dd804cb51e413f4d77d84af
21-
bob: dfabf2f5129080c28890c47da37bdcd698c7b920873d1b458b0af9a70362ae5d;1421fe13c7d20ff1dd2ffaf7b57cafb3;464aff500cbc51a343d40df2149e129977ca1f0ee720dd8398afc29e5b8add38
22-
carlos: 3a2468421c9b1f595cdd3bee75133d1fb3f01478feacceb4cf85cf6204ae93e2;c782fc165f22c8741c66482a219c1d8d;71b18753ecb8bf45fe26216dab5a42c7354248c4e104f1bedfaac0cb7aa6ce7d
23-
carol: bc8b7bb3c9f4e56c712f8d90cf2e96b6433d41486a87c472f0080768f79fd0b9;25dbc2b5d00e6769dc7ffa13562210ee;d0f332a563327a57ef77b27e2124d9b11498236bd44e294319aefe7340d3008c
24-
charlie: c5fff2dc96c5d40ea19cbc001ec5d3d876436f8f8e81e9b378abc9d42aa693a7;28011edfe35fdd5bb89a329c7a989a97;e388b4f36f17490de9024db442ce3e5fb8519d04f9f58823daeeac4d78fe66d9
25-
dan: 39fa8fc71e04901fc640a52c7908c836ea0d15fca3ddf03f6e4889a7986f7752;a0923645b6cdbd632f9cf691ae16432c;4e33dad99f63fb404b605fbab332fc7509f552485bc529a7a828d7701f009d86
26-
dave: 8ae890bc5dc9a1c3f94f6990c82783e06640d194bbcd0115904c43956449b975;00490a83cbc1e88e941f70228fb7e6ef;c572a4ecf47faa2ee942580faf9f50d8ac73b0e91752967c874cbf92d3e3f27d
27-
david: 7f62246fb9b1587f281154fec7a04a346bd12e1fa372e28cce8b876ea01996bb;c89243b6b55ebf7c6b1ba6ce87a6c9f4;03018e5dd1050f072a9295c874f8b5f55ce559f1518541320768941f30d90ec9
20+
alice: d934e4ffff5ba9153fb2132e0612e712115222de4f5a0ea442189e1e6165d9ec;3318753822f08e506977bce9ba45f390;b9dda5ae9d522ebb921baeb5fc18bf42f12434142dd804cb51e413f4d77d84af
21+
bob: 2cb3b98f0c0b262ba69b965d1fc5e5ab20f3b13a31d8cca7b863f52ae1a4f6cc;50af439e7b290e1a87da35ff89d11d15;464aff500cbc51a343d40df2149e129977ca1f0ee720dd8398afc29e5b8add38
22+
carlos: b981c3831e7084fabe33490f905ea3f9f5f67c7b28e02c05810c4e49167255c5;19c354bccce0cf18d9b7897912833cb2;71b18753ecb8bf45fe26216dab5a42c7354248c4e104f1bedfaac0cb7aa6ce7d
23+
carol: b71e9d5a770523349868e086f64e85ca455463170cb8cb8a6f42fa6e8e48d024;05205ff527bbcf6652c82be90182fc5a;d0f332a563327a57ef77b27e2124d9b11498236bd44e294319aefe7340d3008c
24+
charlie: 8824950905311b88794df61725a67c96bba87f0dde6b5f17be5fd18d07d262e9;071fd5779282a6d4fa24f93a0d65ca2b;e388b4f36f17490de9024db442ce3e5fb8519d04f9f58823daeeac4d78fe66d9
25+
dan: 226e4489b942f11aa38c9588b08a7cfe11d3dd1df05ad4b73d26af7d81c4ffda;2fd34f0ca35e7fe3ef1b61b524e44342;4e33dad99f63fb404b605fbab332fc7509f552485bc529a7a828d7701f009d86
26+
dave: 115cd1e4cdd11d8151980275cb16bbbd6b10edbb8dd917740842cc192ce97644;0e30d05a90516da78bf21ec555beb442;c572a4ecf47faa2ee942580faf9f50d8ac73b0e91752967c874cbf92d3e3f27d
27+
david: 03cfb3b44b73ecffbb225d7c4faa71cdd6bb0d3f255d43b9d5bba6f0296a5613;7b24d77abf9a4e890c92d3e2fd9e47dc;03018e5dd1050f072a9295c874f8b5f55ce559f1518541320768941f30d90ec9

0 commit comments

Comments
 (0)