Patch 9.0.1488

[Bram Moolenaar]

Patch 9.0.1488
Problem: xchacha20v2 crypt header is platform dependent.
Solution: Avoid using "size_t". (Ozaki Kiichi, closses #12296)
Files: src/crypt.c, src/testdir/test_crypt.vim


*** ../vim-9.0.1487/src/crypt.c 2023-04-23 17:50:14.853935966 +0100
--- src/crypt.c 2023-04-25 15:23:59.187508624 +0100
***************
*** 30,52 ****
*/

typedef struct {
! char *name; // encryption name as used in 'cryptmethod'
! char *magic; // magic bytes stored in file header
! int salt_len; // length of salt, or 0 when not using salt
! int seed_len; // length of seed, or 0 when not using seed
! int add_len; // additional length in the header needed for storing
! // custom data
#ifdef CRYPT_NOT_INPLACE
! int works_inplace; // encryption/decryption can be done in-place
#endif
! int whole_undofile; // whole undo file is encrypted

// Optional function pointer for a self-test.
! int (* self_test_fn)(void);

// Function pointer for initializing encryption/decryption.
! int (* init_fn)(cryptstate_T *state, char_u *key,
! crypt_arg_T *arg);

// Function pointers for encoding/decoding from one buffer into another.
// Optional, however, these or the _buffer ones should be configured.
--- 30,51 ----
*/

typedef struct {
! char *name; // encryption name as used in 'cryptmethod'
! char *magic; // magic bytes stored in file header
! int salt_len; // length of salt, or 0 when not using salt
! int seed_len; // length of seed, or 0 when not using seed
! int add_len; // additional length in the header needed for storing
! // custom data
#ifdef CRYPT_NOT_INPLACE
! int works_inplace; // encryption/decryption can be done in-place
#endif
! int whole_undofile; // whole undo file is encrypted

// Optional function pointer for a self-test.
! int (*self_test_fn)(void);

// Function pointer for initializing encryption/decryption.
! int (* init_fn)(cryptstate_T *state, char_u *key, crypt_arg_T *arg);

// Function pointers for encoding/decoding from one buffer into another.
// Optional, however, these or the _buffer ones should be configured.
***************
*** 79,85 ****
static long crypt_sodium_buffer_decode(cryptstate_T *state, char_u *from, size_t len, char_u **buf_out, int last);
static long crypt_sodium_buffer_encode(cryptstate_T *state, char_u *from, size_t len, char_u **buf_out, int last);
#if defined(FEAT_EVAL) && defined(FEAT_SODIUM)
! static void crypt_sodium_report_hash_params( unsigned long long opslimit, unsigned long long ops_def, size_t memlimit, size_t mem_def, int alg, int alg_def);
#endif

// index is method_nr of cryptstate_T, CRYPT_M_*
--- 78,84 ----
static long crypt_sodium_buffer_decode(cryptstate_T *state, char_u *from, size_t len, char_u **buf_out, int last);
static long crypt_sodium_buffer_encode(cryptstate_T *state, char_u *from, size_t len, char_u **buf_out, int last);
#if defined(FEAT_EVAL) && defined(FEAT_SODIUM)
! static void crypt_sodium_report_hash_params(unsigned long long opslimit, unsigned long long ops_def, size_t memlimit, size_t mem_def, int alg, int alg_def);
#endif

// index is method_nr of cryptstate_T, CRYPT_M_*
***************
*** 916,922 ****
sodium_state_T *sd_state;
int retval = 0;
unsigned long long opslimit;
! size_t memlimit;
int alg;

if (sodium_init() < 0)
--- 915,921 ----
sodium_state_T *sd_state;
int retval = 0;
unsigned long long opslimit;
! unsigned long long memlimit;
int alg;

if (sodium_init() < 0)
***************
*** 943,949 ****

// derive a key from the password
if (crypto_pwhash(dkey, sizeof(dkey), (const char *)key, STRLEN(key),
! arg->cat_salt, opslimit, memlimit, alg) != 0)
{
// out of memory
sodium_free(sd_state);
--- 942,948 ----

// derive a key from the password
if (crypto_pwhash(dkey, sizeof(dkey), (const char *)key, STRLEN(key),
! arg->cat_salt, opslimit, (size_t)memlimit, alg) != 0)
{
// out of memory
sodium_free(sd_state);
***************
*** 995,1006 ****
#ifdef FEAT_EVAL
crypt_sodium_report_hash_params(opslimit,
crypto_pwhash_OPSLIMIT_INTERACTIVE,
! memlimit, crypto_pwhash_MEMLIMIT_INTERACTIVE,
alg, crypto_pwhash_ALG_DEFAULT);
#endif

if (crypto_pwhash(dkey, sizeof(dkey), (const char *)key, STRLEN(key),
! arg->cat_salt, opslimit, memlimit, alg) != 0)
{
// out of memory
sodium_free(sd_state);
--- 994,1005 ----
#ifdef FEAT_EVAL
crypt_sodium_report_hash_params(opslimit,
crypto_pwhash_OPSLIMIT_INTERACTIVE,
! (size_t)memlimit, crypto_pwhash_MEMLIMIT_INTERACTIVE,
alg, crypto_pwhash_ALG_DEFAULT);
#endif

if (crypto_pwhash(dkey, sizeof(dkey), (const char *)key, STRLEN(key),
! arg->cat_salt, opslimit, (size_t)memlimit, alg) != 0)
{
// out of memory
sodium_free(sd_state);
*** ../vim-9.0.1487/src/testdir/test_crypt.vim 2023-04-23 17:50:14.857935970 +0100
--- src/testdir/test_crypt.vim 2023-04-25 15:14:58.543246103 +0100
***************
*** 49,57 ****
call assert_equal(a:method, &cryptmethod)

split Xtest.txt
! let text = ['01234567890123456789012345678901234567',
! \ 'line 2 foo bar blah',
! \ 'line 3 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx']
call setline(1, text)
call feedkeys(":X\<CR>foobar\<CR>foobar\<CR>", 'xt')
call assert_equal('*****', &key)
--- 49,59 ----
call assert_equal(a:method, &cryptmethod)

split Xtest.txt
! let text =<< trim END
! 01234567890123456789012345678901234567,
! line 2 foo bar blah,
! line 3 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
! END
call setline(1, text)
call feedkeys(":X\<CR>foobar\<CR>foobar\<CR>", 'xt')
call assert_equal('*****', &key)
***************
*** 134,148 ****

func Test_uncrypt_xchacha20()
CheckFeature sodium
! let hex = ['00000000: 5669 6d43 7279 7074 7e30 3421 6b7d e607 vimCrypt~04!k}..',
! \ '00000010: 4ea4 e99f 923e f67f 7b59 a80d 3bca 2f06 N....>..{Y..;./.',
! \ '00000020: fa11 b951 8d09 0dc9 470f e7cf 8b90 4310 ...Q....G.....C.',
! \ '00000030: 653b b83b e493 378b 0390 0e38 f912 626b e;.;..7....8..bk',
! \ '00000040: a02e 4697 0254 2625 2d8e 3a0b 784b e89c ..F..T&%-.:.xK..',
! \ '00000050: 0c67 a975 3c17 9319 8ffd 1463 7783 a1f3 .g.u<......cw...',
! \ '00000060: d917 dcb3 8b3e ecd7 c7d4 086b 6059 7ead .....>.....k`Y~.',
! \ '00000070: 9b07 f96b 5c1b 4d08 cd91 f208 5221 7484 ...k\.M.....R!t.',
! \ '00000080: 72be 0136 84a1 d3 r..6...']
" the file should be in latin1 encoding, this makes sure that readfile()
" retries several times converting the multi-byte characters
call Uncrypt_stable_xxd('xchacha20', hex, "sodium_crypt", ["abcdefghijklmnopqrstuvwxyzäöü", "ZZZ_äüöÄÜÖ_!@#$%^&*()_+=-`~"], 0)
--- 136,152 ----

func Test_uncrypt_xchacha20()
CheckFeature sodium
! let hex =<< trim END
! 00000000: 5669 6d43 7279 7074 7e30 3421 6b7d e607 vimCrypt~04!k}..
! 00000010: 4ea4 e99f 923e f67f 7b59 a80d 3bca 2f06 N....>..{Y..;./.
! 00000020: fa11 b951 8d09 0dc9 470f e7cf 8b90 4310 ...Q....G.....C.
! 00000030: 653b b83b e493 378b 0390 0e38 f912 626b e;.;..7....8..bk
! 00000040: a02e 4697 0254 2625 2d8e 3a0b 784b e89c ..F..T&%-.:.xK..
! 00000050: 0c67 a975 3c17 9319 8ffd 1463 7783 a1f3 .g.u<......cw...
! 00000060: d917 dcb3 8b3e ecd7 c7d4 086b 6059 7ead .....>.....k`Y~.
! 00000070: 9b07 f96b 5c1b 4d08 cd91 f208 5221 7484 ...k\.M.....R!t.
! 00000080: 72be 0136 84a1 d3 r..6...
! END
" the file should be in latin1 encoding, this makes sure that readfile()
" retries several times converting the multi-byte characters
call Uncrypt_stable_xxd('xchacha20', hex, "sodium_crypt", ["abcdefghijklmnopqrstuvwxyzäöü", "ZZZ_äüöÄÜÖ_!@#$%^&*()_+=-`~"], 0)
***************
*** 151,164 ****
func Test_uncrypt_xchacha20v2_custom()
CheckFeature sodium
" Test, reading xchacha20v2 with custom encryption parameters
! let hex = ['00000000: 5669 6d43 7279 7074 7e30 3521 934b f288 VimCrypt~05!.K..',
! \ '00000010: 10ba 8bc9 25a0 8876 f85c f135 6fb8 518b ....%..v.\.5o.Q.',
! \ '00000020: b133 9af1 0300 0000 0000 0000 0000 0010 .3..............',
! \ '00000030: 0000 0000 0200 0000 b973 5f33 80e9 54fc .........s_3..T.',
! \ '00000040: 138f ba3e 046b 3135 90b7 7783 5eac 7fe3 ...>.k15..w.^...',
! \ '00000050: 0cd2 14df ed75 4b65 8763 8205 035c ec81 .....uKe.c...\..',
! \ "00000060: a4cf 33d2 7507 ec38 ba62 a327 9068 d8ad ..3.u..8.b.'.h..",
! \ '00000070: 2607 3fa6 f95d 7ea8 9799 f997 4820 0c &.?..]~.....H .']
call Uncrypt_stable_xxd('xchacha20v2', hex, "foobar", ["", "foo", "bar", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10"], 1)
call assert_match('xchacha20v2: using custom \w\+ "\d\+" for Key derivation.', execute(':messages'))
endfunc
--- 155,170 ----
func Test_uncrypt_xchacha20v2_custom()
CheckFeature sodium
" Test, reading xchacha20v2 with custom encryption parameters
! let hex =<< trim END
! 00000000: 5669 6d43 7279 7074 7e30 3521 934b f288 VimCrypt~05!.K..
! 00000010: 10ba 8bc9 25a0 8876 f85c f135 6fb8 518b ....%..v.\.5o.Q.
! 00000020: b133 9af1 0300 0000 0000 0000 0000 0010 .3..............
! 00000030: 0000 0000 0200 0000 b973 5f33 80e9 54fc .........s_3..T.
! 00000040: 138f ba3e 046b 3135 90b7 7783 5eac 7fe3 ...>.k15..w.^...
! 00000050: 0cd2 14df ed75 4b65 8763 8205 035c ec81 .....uKe.c...\..
! 00000060: a4cf 33d2 7507 ec38 ba62 a327 9068 d8ad ..3.u..8.b.'.h..
! 00000070: 2607 3fa6 f95d 7ea8 9799 f997 4820 0c &.?..]~.....H .
! END
call Uncrypt_stable_xxd('xchacha20v2', hex, "foobar", ["", "foo", "bar", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10"], 1)
call assert_match('xchacha20v2: using custom \w\+ "\d\+" for Key derivation.', execute(':messages'))
endfunc
***************
*** 166,183 ****
func Test_uncrypt_xchacha20v2()
CheckFeature sodium
" Test, reading xchacha20v2
! let hex = [
! \ '00000000: 5669 6d43 7279 7074 7e30 3521 9f20 4e14 VimCrypt~05!. N.',
! \ '00000010: c7da c1bd 7dea 8fbc db6c 38e6 7a77 6fef ....}....l8.zwo.',
! \ '00000020: 82dd 964b 0300 0000 0000 0000 0000 0010 ...K............',
! \ '00000030: 0000 0000 0200 0000 a97c 2f00 0b9d 19eb .........|/.....',
! \ '00000040: 1d92 1ea5 3f22 c179 4b3e 870a eb19 6380 ....?".yK>....c.',
! \ '00000050: 63f8 222d b5d1 3c73 7be5 d580 47ea 44cc c."-..<s{...G.D.',
! \ '00000060: 6c25 8078 3fd5 d836 c700 0122 bb30 7a59 l%.x?..6...".0zY',
! \ '00000070: b184 2ae8 e7db 113a f732 938f 7a34 1333 ..*....:.2..z4.3',
! \ '00000080: dc89 1491 51a0 67b9 0f3a b56c 1f9d 53b0 ....Q.g..:.l..S.',
! \ '00000090: 2416 205a 8c4c 5fde 4dac 2611 8a48 24f0 $. Z.L_.M.&..H$.',
! \ '000000a0: ba00 92c1 60 ....`']
call Uncrypt_stable_xxd('xchacha20v2', hex, "foo1234", ["abcdefghijklmnopqrstuvwxyzäöü", 'ZZZ_äüöÄÜÖ_!@#$%^&*()_+=-`~"'], 0)
endfunc

--- 172,190 ----
func Test_uncrypt_xchacha20v2()
CheckFeature sodium
" Test, reading xchacha20v2
! let hex =<< trim END
! 00000000: 5669 6d43 7279 7074 7e30 3521 9f20 4e14 VimCrypt~05!. N.
! 00000010: c7da c1bd 7dea 8fbc db6c 38e6 7a77 6fef ....}....l8.zwo.
! 00000020: 82dd 964b 0300 0000 0000 0000 0000 0010 ...K............
! 00000030: 0000 0000 0200 0000 a97c 2f00 0b9d 19eb .........|/.....
! 00000040: 1d92 1ea5 3f22 c179 4b3e 870a eb19 6380 ....?".yK>....c.
! 00000050: 63f8 222d b5d1 3c73 7be5 d580 47ea 44cc c."-..<s{...G.D.
! 00000060: 6c25 8078 3fd5 d836 c700 0122 bb30 7a59 l%.x?..6...".0zY
! 00000070: b184 2ae8 e7db 113a f732 938f 7a34 1333 ..*....:.2..z4.3
! 00000080: dc89 1491 51a0 67b9 0f3a b56c 1f9d 53b0 ....Q.g..:.l..S.
! 00000090: 2416 205a 8c4c 5fde 4dac 2611 8a48 24f0 $. Z.L_.M.&..H$.
! 000000a0: ba00 92c1 60 ....`
! END
call Uncrypt_stable_xxd('xchacha20v2', hex, "foo1234", ["abcdefghijklmnopqrstuvwxyzäöü", 'ZZZ_äüöÄÜÖ_!@#$%^&*()_+=-`~"'], 0)
endfunc

*** ../vim-9.0.1487/src/version.c 2023-04-25 14:54:50.030918440 +0100
--- src/version.c 2023-04-25 15:16:21.407295889 +0100
***************
*** 697,698 ****
--- 697,700 ----
{ /* Add new patch number below this line */
+ /**/
+ 1488,
/**/

--
SECOND SOLDIER: It could be carried by an African swallow!
FIRST SOLDIER: Oh yes! An African swallow maybe ... but not a European
swallow. that's my point.
"Monty Python and the Holy Grail" PYTHON (MONTY) PICTURES LTD

/// Bram Moolenaar -- Br...@Moolenaar.net -- http://www.Moolenaar.net \\\
/// \\\
\\\ sponsor Vim, vote for features -- http://www.Vim.org/sponsor/ ///
\\\ help me help AIDS victims -- http://ICCF-Holland.org ///