@onekeyfe/react-native-pbkdf2 3.0.179-alpha.303 → 3.0.179-alpha.306

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +14 -2
  3. package/package.json +1 -1
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2014 Daniel Cousens
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -34,13 +34,25 @@ key bytes are needed. The package does not store keys or choose parameters.
34
34
  See [src/NativePbkdf2.ts](src/NativePbkdf2.ts) for the native interface and the
35
35
  platform sources for encoding and derivation behavior.
36
36
 
37
+ ## Matching an existing derived-key format
38
+
39
+ The method argument order is password, salt, rounds, output-byte length and
40
+ hash name. The encoded password and salt are byte sequences, so do not pass
41
+ an unencoded user password in place of Base64 or reinterpret a textual salt
42
+ without the application's format rules.
43
+
44
+ The default export exposes `derive`; this package does not export the AES
45
+ module's differently shaped `pbkdf2` helper. `Pbkdf2Spec` can be imported as a
46
+ type when adapting this method. A derived key must still be decoded, stored or
47
+ used by the caller; resolving the promise does not persist it.
48
+
37
49
  ## Upstream attribution
38
50
 
39
51
  First, a sincere thank-you to the
40
52
  `react-native-pbkdf2` maintainers for their excellent work 🙏
41
53
 
42
54
  This package is built on, and inspired by,
43
- [nicola/react-native-pbkdf2](https://github.com/nicola/react-native-pbkdf2).
55
+ [PublicaIO/react-native-pbkdf2](https://github.com/PublicaIO/react-native-pbkdf2).
44
56
 
45
57
  Our original plan was to keep our customizations as patches on top of upstream
46
58
  `react-native-pbkdf2`.
@@ -54,7 +66,7 @@ development and delivery stable.
54
66
 
55
67
  ## Upstream Project
56
68
 
57
- - Repository: [nicola/react-native-pbkdf2](https://github.com/nicola/react-native-pbkdf2)
69
+ - Repository: [PublicaIO/react-native-pbkdf2](https://github.com/PublicaIO/react-native-pbkdf2)
58
70
  - License: MIT
59
71
 
60
72
  ## Notes
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@onekeyfe/react-native-pbkdf2",
3
- "version": "3.0.179-alpha.303",
3
+ "version": "3.0.179-alpha.306",
4
4
  "description": "react-native-pbkdf2",
5
5
  "main": "./lib/module/index.js",
6
6
  "types": "./lib/typescript/src/index.d.ts",