Skip to content

Commit 8c68745

Browse files
committed
Update ext/sodium parameter names
Closes GH-6279.
1 parent 872787c commit 8c68745

File tree

4 files changed

+138
-119
lines changed

4 files changed

+138
-119
lines changed

ext/sodium/libsodium.stub.php

Lines changed: 50 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -5,87 +5,87 @@
55
function sodium_crypto_aead_aes256gcm_is_available(): bool {}
66

77
#ifdef HAVE_AESGCM
8-
function sodium_crypto_aead_aes256gcm_decrypt(string $string, string $ad, string $nonce, string $key): string|false {}
8+
function sodium_crypto_aead_aes256gcm_decrypt(string $ciphertext, string $additional_data, string $nonce, string $key): string|false {}
99

10-
function sodium_crypto_aead_aes256gcm_encrypt(string $string, string $ad, string $nonce, string $key): string {}
10+
function sodium_crypto_aead_aes256gcm_encrypt(string $message, string $additional_data, string $nonce, string $key): string {}
1111

1212
function sodium_crypto_aead_aes256gcm_keygen(): string {}
1313
#endif
1414

15-
function sodium_crypto_aead_chacha20poly1305_decrypt(string $string, string $ad, string $nonce, string $key): string|false {}
15+
function sodium_crypto_aead_chacha20poly1305_decrypt(string $ciphertext, string $additional_data, string $nonce, string $key): string|false {}
1616

17-
function sodium_crypto_aead_chacha20poly1305_encrypt(string $string, string $ad, string $nonce, string $key): string {}
17+
function sodium_crypto_aead_chacha20poly1305_encrypt(string $message, string $additional_data, string $nonce, string $key): string {}
1818

1919
function sodium_crypto_aead_chacha20poly1305_keygen(): string {}
2020

21-
function sodium_crypto_aead_chacha20poly1305_ietf_decrypt(string $string, string $ad, string $nonce, string $key): string|false {}
21+
function sodium_crypto_aead_chacha20poly1305_ietf_decrypt(string $ciphertext, string $additional_data, string $nonce, string $key): string|false {}
2222

23-
function sodium_crypto_aead_chacha20poly1305_ietf_encrypt(string $string, string $ad, string $nonce, string $key): string {}
23+
function sodium_crypto_aead_chacha20poly1305_ietf_encrypt(string $message, string $additional_data, string $nonce, string $key): string {}
2424

2525
function sodium_crypto_aead_chacha20poly1305_ietf_keygen(): string {}
2626

2727
#ifdef crypto_aead_xchacha20poly1305_IETF_NPUBBYTES
28-
function sodium_crypto_aead_xchacha20poly1305_ietf_decrypt(string $string, string $ad, string $nonce, string $key): string|false {}
28+
function sodium_crypto_aead_xchacha20poly1305_ietf_decrypt(string $ciphertext, string $additional_data, string $nonce, string $key): string|false {}
2929

3030
function sodium_crypto_aead_xchacha20poly1305_ietf_keygen(): string {}
3131

32-
function sodium_crypto_aead_xchacha20poly1305_ietf_encrypt(string $string, string $ad, string $nonce, string $key): string {}
32+
function sodium_crypto_aead_xchacha20poly1305_ietf_encrypt(string $message, string $additional_data, string $nonce, string $key): string {}
3333
#endif
3434

35-
function sodium_crypto_auth(string $string, string $key): string {}
35+
function sodium_crypto_auth(string $message, string $key): string {}
3636

3737
function sodium_crypto_auth_keygen(): string {}
3838

39-
function sodium_crypto_auth_verify(string $signature, string $string, string $key): bool {}
39+
function sodium_crypto_auth_verify(string $mac, string $message, string $key): bool {}
4040

41-
function sodium_crypto_box(string $string, string $nonce, string $key): string {}
41+
function sodium_crypto_box(string $message, string $nonce, string $key_pair): string {}
4242

4343
function sodium_crypto_box_keypair(): string {}
4444

45-
function sodium_crypto_box_seed_keypair(string $key): string {}
45+
function sodium_crypto_box_seed_keypair(string $seed): string {}
4646

4747
function sodium_crypto_box_keypair_from_secretkey_and_publickey(string $secret_key, string $public_key): string {}
4848

49-
function sodium_crypto_box_open(string $string, string $nonce, string $key): string|false {}
49+
function sodium_crypto_box_open(string $ciphertext, string $nonce, string $key_pair): string|false {}
5050

51-
function sodium_crypto_box_publickey(string $key): string {}
51+
function sodium_crypto_box_publickey(string $key_pair): string {}
5252

53-
function sodium_crypto_box_publickey_from_secretkey(string $key): string {}
53+
function sodium_crypto_box_publickey_from_secretkey(string $secret_key): string {}
5454

55-
function sodium_crypto_box_seal(string $string, string $key): string {}
55+
function sodium_crypto_box_seal(string $message, string $key_pair): string {}
5656

57-
function sodium_crypto_box_seal_open(string $string, string $key): string|false {}
57+
function sodium_crypto_box_seal_open(string $ciphertext, string $key_pair): string|false {}
5858

59-
function sodium_crypto_box_secretkey(string $key): string {}
59+
function sodium_crypto_box_secretkey(string $key_pair): string {}
6060

6161
function sodium_crypto_kx_keypair(): string {}
6262

63-
function sodium_crypto_kx_publickey(string $key): string {}
63+
function sodium_crypto_kx_publickey(string $key_pair): string {}
6464

65-
function sodium_crypto_kx_secretkey(string $key): string {}
65+
function sodium_crypto_kx_secretkey(string $key_pair): string {}
6666

67-
function sodium_crypto_kx_seed_keypair(string $string): string {}
67+
function sodium_crypto_kx_seed_keypair(string $seed): string {}
6868

69-
function sodium_crypto_kx_client_session_keys(string $client_keypair, string $server_key): array {}
69+
function sodium_crypto_kx_client_session_keys(string $client_key_pair, string $server_key): array {}
7070

71-
function sodium_crypto_kx_server_session_keys(string $server_keypair, string $client_key): array {}
71+
function sodium_crypto_kx_server_session_keys(string $server_key_pair, string $client_key): array {}
7272

73-
function sodium_crypto_generichash(string $string, string $key = "", int $length = SODIUM_CRYPTO_GENERICHASH_BYTES): string {}
73+
function sodium_crypto_generichash(string $message, string $key = "", int $length = SODIUM_CRYPTO_GENERICHASH_BYTES): string {}
7474

7575
function sodium_crypto_generichash_keygen(): string {}
7676

7777
function sodium_crypto_generichash_init(string $key = "", int $length = SODIUM_CRYPTO_GENERICHASH_BYTES): string {}
7878

79-
function sodium_crypto_generichash_update(string &$state, string $string): bool {}
79+
function sodium_crypto_generichash_update(string &$state, string $message): bool {}
8080

8181
function sodium_crypto_generichash_final(string &$state, int $length = SODIUM_CRYPTO_GENERICHASH_BYTES): string {}
8282

83-
function sodium_crypto_kdf_derive_from_key(int $subkey_len, int $subkey_id, string $context, string $key): string {}
83+
function sodium_crypto_kdf_derive_from_key(int $subkey_length, int $subkey_id, string $context, string $key): string {}
8484

8585
function sodium_crypto_kdf_keygen(): string {}
8686

8787
#ifdef crypto_pwhash_SALTBYTES
88-
function sodium_crypto_pwhash(int $length, string $password, string $salt, int $opslimit, int $memlimit, int $alg = SODIUM_CRYPTO_PWHASH_ALG_DEFAULT): string {}
88+
function sodium_crypto_pwhash(int $length, string $password, string $salt, int $opslimit, int $memlimit, int $algo = SODIUM_CRYPTO_PWHASH_ALG_DEFAULT): string {}
8989

9090
function sodium_crypto_pwhash_str(string $password, int $opslimit, int $memlimit): string {}
9191

@@ -104,71 +104,71 @@ function sodium_crypto_pwhash_scryptsalsa208sha256_str(string $password, int $op
104104
function sodium_crypto_pwhash_scryptsalsa208sha256_str_verify(string $hash, string $password): bool {}
105105
#endif
106106

107-
function sodium_crypto_scalarmult(string $string_1, string $string_2): string {}
107+
function sodium_crypto_scalarmult(string $n, string $p): string {}
108108

109-
function sodium_crypto_secretbox(string $string, string $nonce, string $key): string {}
109+
function sodium_crypto_secretbox(string $message, string $nonce, string $key): string {}
110110

111111
function sodium_crypto_secretbox_keygen(): string {}
112112

113-
function sodium_crypto_secretbox_open(string $string, string $nonce, string $key): string|false {}
113+
function sodium_crypto_secretbox_open(string $ciphertext, string $nonce, string $key): string|false {}
114114

115115
#ifdef crypto_secretstream_xchacha20poly1305_ABYTES
116116
function sodium_crypto_secretstream_xchacha20poly1305_keygen(): string {}
117117

118118
function sodium_crypto_secretstream_xchacha20poly1305_init_push(string $key): array {}
119119

120-
function sodium_crypto_secretstream_xchacha20poly1305_push(string &$state, string $msg, string $ad = "", int $tag = SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_MESSAGE): string {}
120+
function sodium_crypto_secretstream_xchacha20poly1305_push(string &$state, string $message, string $additional_data = "", int $tag = SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_MESSAGE): string {}
121121

122-
function sodium_crypto_secretstream_xchacha20poly1305_init_pull(string $string, string $key): string {}
122+
function sodium_crypto_secretstream_xchacha20poly1305_init_pull(string $header, string $key): string {}
123123

124-
function sodium_crypto_secretstream_xchacha20poly1305_pull(string &$state, string $c, string $ad = ""): array|false {}
124+
function sodium_crypto_secretstream_xchacha20poly1305_pull(string &$state, string $ciphertext, string $additional_data = ""): array|false {}
125125

126126
function sodium_crypto_secretstream_xchacha20poly1305_rekey(string &$state): void {}
127127
#endif
128128

129-
function sodium_crypto_shorthash(string $string, string $key): string {}
129+
function sodium_crypto_shorthash(string $message, string $key): string {}
130130

131131
function sodium_crypto_shorthash_keygen(): string {}
132132

133-
function sodium_crypto_sign(string $string, string $keypair): string {}
133+
function sodium_crypto_sign(string $message, string $secret_key): string {}
134134

135-
function sodium_crypto_sign_detached(string $string, string $keypair): string {}
135+
function sodium_crypto_sign_detached(string $message, string $secret_key): string {}
136136

137-
function sodium_crypto_sign_ed25519_pk_to_curve25519(string $key): string {}
137+
function sodium_crypto_sign_ed25519_pk_to_curve25519(string $public_key): string {}
138138

139-
function sodium_crypto_sign_ed25519_sk_to_curve25519(string $key): string {}
139+
function sodium_crypto_sign_ed25519_sk_to_curve25519(string $secret_key): string {}
140140

141141
function sodium_crypto_sign_keypair(): string {}
142142

143143
function sodium_crypto_sign_keypair_from_secretkey_and_publickey(string $secret_key, string $public_key): string {}
144144

145-
function sodium_crypto_sign_open(string $string, string $keypair): string|false {}
145+
function sodium_crypto_sign_open(string $ciphertext, string $public_key): string|false {}
146146

147-
function sodium_crypto_sign_publickey(string $key): string {}
147+
function sodium_crypto_sign_publickey(string $key_pair): string {}
148148

149-
function sodium_crypto_sign_secretkey(string $key): string {}
149+
function sodium_crypto_sign_secretkey(string $key_pair): string {}
150150

151-
function sodium_crypto_sign_publickey_from_secretkey(string $key): string {}
151+
function sodium_crypto_sign_publickey_from_secretkey(string $secret_key): string {}
152152

153-
function sodium_crypto_sign_seed_keypair(string $key): string {}
153+
function sodium_crypto_sign_seed_keypair(string $seed): string {}
154154

155-
function sodium_crypto_sign_verify_detached(string $signature, string $string, string $key): bool {}
155+
function sodium_crypto_sign_verify_detached(string $signature, string $message, string $public_key): bool {}
156156

157157
function sodium_crypto_stream(int $length, string $nonce, string $key): string {}
158158

159159
function sodium_crypto_stream_keygen(): string {}
160160

161-
function sodium_crypto_stream_xor(string $string, string $nonce, string $key): string {}
161+
function sodium_crypto_stream_xor(string $message, string $nonce, string $key): string {}
162162

163-
function sodium_add(string &$string_1, string $string_2): void {}
163+
function sodium_add(string &$string1, string $string2): void {}
164164

165-
function sodium_compare(string $string_1, string $string_2): int {}
165+
function sodium_compare(string $string1, string $string2): int {}
166166

167167
function sodium_increment(string &$string): void {}
168168

169-
function sodium_memcmp(string $string_1, string $string_2): int {}
169+
function sodium_memcmp(string $string1, string $string2): int {}
170170

171-
function sodium_memzero(string &$reference): void {}
171+
function sodium_memzero(string &$string): void {}
172172

173173
function sodium_pad(string $string, int $length): string {}
174174

@@ -185,4 +185,4 @@ function sodium_base642bin(string $string, int $id, string $ignore = ""): strin
185185
#endif
186186

187187
/** @alias sodium_crypto_box_publickey_from_secretkey */
188-
function sodium_crypto_scalarmult_base(string $key): string {}
188+
function sodium_crypto_scalarmult_base(string $secret_key): string {}

0 commit comments

Comments
 (0)