forked from ESAPI/esapi-java-legacy
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathEncryptor.java
More file actions
228 lines (213 loc) · 8.58 KB
/
Copy pathEncryptor.java
File metadata and controls
228 lines (213 loc) · 8.58 KB
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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
/**
* OWASP Enterprise Security API (ESAPI)
*
* This file is part of the Open Web Application Security Project (OWASP)
* Enterprise Security API (ESAPI) project. For details, please see
* <a href="http://www.owasp.org/index.php/ESAPI">http://www.owasp.org/index.php/ESAPI</a>.
*
* Copyright (c) 2007 - The OWASP Foundation
*
* The ESAPI is published by OWASP under the BSD license. You should read and accept the
* LICENSE before you use, modify, and/or redistribute this software.
*
* @author Jeff Williams <a href="http://www.aspectsecurity.com">Aspect Security</a>
* @created 2007
*/
package org.owasp.esapi;
import org.owasp.esapi.errors.EncryptionException;
import org.owasp.esapi.errors.IntegrityException;
/**
* The Encryptor interface provides a set of methods for performing common
* encryption, random number, and hashing operations. Implementations should
* rely on a strong cryptographic implementation, such as JCE or BouncyCastle.
* Implementors should take care to ensure that they initialize their
* implementation with a strong "master key", and that they protect this secret
* as much as possible.
* <P>
* <img src="doc-files/Encryptor.jpg">
* <P>
* Possible future enhancements (depending on feedback) might include:
* <UL>
* <LI>encryptFile</LI>
* </UL>
*
* @author Jeff Williams (jeff.williams .at. aspectsecurity.com) <a
* href="http://www.aspectsecurity.com">Aspect Security</a>
* @since June 1, 2007
*/
public interface Encryptor {
/**
* Returns a string representation of the hash of the provided plaintext and
* salt. The salt helps to protect against a rainbow table attack by mixing
* in some extra data with the plaintext. Some good choices for a salt might
* be an account name or some other string that is known to the application
* but not to an attacker.
* See <a href="http://www.matasano.com/log/958/enough-with-the-rainbow-tables-what-you-need-to-know-about-secure-password-schemes/">
* this article</a> for more information about hashing as it pertains to password schemes.
*
* @param plaintext
* the plaintext String to encrypt
* @param salt
* the salt to add to the plaintext String before hashing
*
* @return
* the encrypted hash of 'plaintext' stored as a String
*
* @throws EncryptionException
* if the specified hash algorithm could not be found or another problem exists with
* the hashing of 'plaintext'
*/
String hash(String plaintext, String salt) throws EncryptionException;
/**
* @deprecated Why this method is deprecated? Most cryptographers strongly suggest
* that if you are creating crypto functionality for general-purpose use,
* at a minimum you should ensure that it provides authenticity, integrity,
* and confidentiality. This method only provides confidentiality, but not
* authenticity or integrity. Therefore, you are encouraged to use
* one of the other encryption methods referenced below. Because this
* method provides neither authenticity nor integrity, it may be
* removed in some future ESAPI Java release. Note: there are some cases
* where authenticity / integrity are not that important. For instance, consider
* a case where the encrypted data is never out of your application's control. For
* example, if you receive data that your application is encrypting itself and then
* storing the encrypted data in its own database for later use (and no other
* applications can query or update that column of the database), providing
* confidentiality alone might be sufficient. However, if there are cases
* where your application will be sending or receiving already encrypted data
* over an insecure, unauthenticated channel, in such cases authenticity and
* integrity of the encrypted data likely is important
*
* Encrypts the provided plaintext and returns a ciphertext string.
*
* @param plaintext
* the plaintext String to encrypt
*
* @return
* the encrypted String representation of 'plaintext'
*
* @throws EncryptionException
* if the specified encryption algorithm could not be found or another problem exists with
* the encryption of 'plaintext'
*/
String encrypt(String plaintext) throws EncryptionException;
/**
* @deprecated Why this method is deprecated? Most cryptographers strongly suggest
* that if you are creating crypto functionality for general-purpose use,
* at a minimum you should ensure that it provides authenticity, integrity,
* and confidentiality. This method only provides confidentiality, but not
* authenticity or integrity. Therefore, you are encouraged to use
* one of the other encryption methods referenced below. Because this
* method provides neither authenticity nor integrity, it may be
* removed in some future ESAPI Java release. Note: there are some cases
* where authenticity / integrity are not that important. For instance, consider
* a case where the encrypted data is never out of your application's control. For
* example, if you receive data that your application is encrypting itself and then
* storing the encrypted data in its own database for later use (and no other
* applications can query or update that column of the database), providing
* confidentiality alone might be sufficient. However, if there are cases
* where your application will be sending or receiving already encrypted data
* over an insecure, unauthenticated channel, in such cases authenticity and
* integrity of the encrypted data likely is important
*
* Decrypts the provided ciphertext string (encrypted with the encrypt
* method) and returns a plaintext string.
*
* @param ciphertext
* the ciphertext (encrypted plaintext)
*
* @return
* the decrypted ciphertext
*
* @throws EncryptionException
* if the specified encryption algorithm could not be found or another problem exists with
* the encryption of 'plaintext'
*/
String decrypt(String ciphertext) throws EncryptionException;
/**
* Create a digital signature for the provided data and return it in a
* string.
*
* @param data
* the data to sign
*
* @return
* the digital signature stored as a String
*
* @throws EncryptionException
* if the specified signature algorithm cannot be found
*/
String sign(String data) throws EncryptionException;
/**
* Verifies a digital signature (created with the sign method) and returns
* the boolean result.
*
* @param signature
* the signature to verify against 'data'
* @param data
* the data to verify against 'signature'
*
* @return
* true, if the signature is verified, false otherwise
*
*/
boolean verifySignature(String signature, String data);
/**
* Creates a seal that binds a set of data and includes an expiration timestamp.
*
* @param data
* the data to seal
* @param timestamp
* the absolute expiration date of the data, expressed as seconds since the epoch
*
* @return
* the seal
*
*/
String seal(String data, long timestamp) throws IntegrityException;
/**
* Unseals data (created with the seal method) and throws an exception
* describing any of the various problems that could exist with a seal, such
* as an invalid seal format, expired timestamp, or decryption error.
*
* @param seal
* the sealed data
*
* @return
* the original (unsealed) data
*
* @throws EncryptionException
* if the unsealed data cannot be retrieved for any reason
*/
String unseal( String seal ) throws EncryptionException;
/**
* Verifies a seal (created with the seal method) and throws an exception
* describing any of the various problems that could exist with a seal, such
* as an invalid seal format, expired timestamp, or data mismatch.
*
* @param seal
* the seal to verify
*
* @return
* true, if the seal is valid. False otherwise
*/
boolean verifySeal(String seal);
/**
* Gets an absolute timestamp representing an offset from the current time to be used by
* other functions in the library.
*
* @param offset
* the offset to add to the current time
*
* @return
* the absolute timestamp
*/
public long getRelativeTimeStamp( long offset );
/**
* Gets a timestamp representing the current date and time to be used by
* other functions in the library.
*
* @return
* a timestamp representing the current time
*/
long getTimeStamp();
}