-
Notifications
You must be signed in to change notification settings - Fork 0
/
readme.txt
83 lines (56 loc) · 2.03 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
=== Fernet Encryption ===
Contributors: bhubbard, hubbardlabs
Donate link: https://hubbardlabs.com
Tags: fernet, encryption, security
Requires at least: 6.0
Tested up to: 6.4
Requires PHP: 8.0
Stable tag: 1.0.9
License: GPLv3 or later
License URI: https://www.gnu.org/licenses/gpl-3.0.html
Fernet Encryption is a plugin that can be used to encrypt and decrypt data in WordPress using fernet.
== Description ==
Fernet Encryption is a plugin that can be used to encrypt and decrypt data in WordPress using fernet.
Development was originally sponsered by Access Networks.
=== Setup your Key ===
To setup your key, you need to add the following line to your wp-config file.
```
define( 'FERNET_KEY', 'YOUR_FERNET_KEY' );
```
If you choose not to setup your key, you will need to save a copy of the one provided upon activation of the plugin.
*IMPORTANT: Changing your WordPress salts will invalidate the default Fernet key provided.*
=== How to Use ===
To encrypt data simply use `$token = fernet_encrypt( 'YOUR MESSAGE' )` in your code.
To decrypt the data simply use `fernet_decrypt( $token )` in your code.
You can use the following shortcode to encrypt:
`[fernet-encrypt]YOUR MESSAGE[/fernet-encrypt]`
You can use the following shortcode to decrypt:
`[fernet-decrypt]YOUR-FERNET-TOKEN[/fernet-decrypt]`
We have also added useful helper functions:
* fernet_get_post_meta
* fernet_add_post_meta
* fernet_update_post_meta
* fernet_get_user_meta
* fernet_add_user_meta
* fernet_update_user_meta
* fernet_add_option
* fernet_get_option
* fernet_update_option
=== Credit ===
- Illustrations provided by undraw.co
- Fernent PHP modified from Kelvin Mo - Fernet-PHP
== Changelog ==
= 1.0.7 =
* Readme improvements
= 1.0.6 =
* Add support for WordPress Rest API.
* Add support for WordPress CLI.
= 1.0.5 =
* Added Helper Functions.
= 1.0.4 =
* Updated Readme
= 1.0.3 =
* Updated Readme.
* Provided shortcodes for encrypting and decrypting.
= 1.0.0 =
* First release.