Dotnet/Encrypter
Dotnet/Encrypter
1
0
Fork 0
Code Issues 2 Pull Requests Actions Packages Projects Releases Wiki Activity

Update

Browse Source
This commit is contained in:
Thorsten Sommer 2020-01-05 21:35:41 +01:00
parent f7527eb34a
commit 9640c7579f
1 changed files with 34 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
Encrypter/Encrypter.xml
View File

@ -85,7 +85,7 @@
<param name="iterations">The used iterations.</param> <param name="iterations">The used iterations.</param>
<returns>The re-encrypted data.</returns> <returns>The re-encrypted data.</returns>
</member> </member>
<member name="M:Encrypter.Extensions.Encrypt(System.String,System.String)"> <member name="M:Encrypter.Extensions.Encrypt(System.String,System.String,System.Int32)">
<summary> <summary>
Encrypts this string by means of AES. The result gets base64 encoded. Encrypts this string by means of AES. The result gets base64 encoded.
Due to the necessary millions of SHA512 iterations, the methods runs at least several seconds in the year 2020 (approx. 5-7s). Due to the necessary millions of SHA512 iterations, the methods runs at least several seconds in the year 2020 (approx. 5-7s).
@ -95,9 +95,25 @@
</summary> </summary>
<param name="data">This UTF8 encoded string to encrypt.</param> <param name="data">This UTF8 encoded string to encrypt.</param>
<param name="password">The password. Must consists of 6 chars or more.</param> <param name="password">The password. Must consists of 6 chars or more.</param>
<param name="iterations">The number of iterations to derive the key. Should not be adjusted. The default is secure for the current time.</param>
<returns>The base64 encoded and encrypted string. The string is ASCII encoding.</returns> <returns>The base64 encoded and encrypted string. The string is ASCII encoding.</returns>
</member> </member>
<member name="M:Encrypter.Extensions.Decrypt(System.String,System.String)"> <member name="M:Encrypter.Extensions.Encrypt(System.IO.Stream,System.IO.Stream,System.String,System.Int32)">
<summary>
Encrypts a given input stream and writes the encrypted data to the provided output stream. A buffer stream
gets used in front of the output stream. This method expects, that both streams are read-to-use e.g. the
input stream is at the desired position and the output stream is writable, etc. This method disposes the
internal crypto streams. Thus, the input and output streams might get disposed as well. Please note, that
this method writes binary data without e.g. base64 encoding.
When the task finished, the entire encryption of the input stream is done.
</summary>
<param name="inputStream">The desired input stream. The encryption starts at the current position.</param>
<param name="outputStream">The desired output stream. The encrypted data gets written to the current position.</param>
<param name="password">The encryption password.</param>
<param name="iterations">The number of iterations to derive the key. Should not be adjusted. The default is secure for the current time.</param>
</member>
<member name="M:Encrypter.Extensions.Decrypt(System.String,System.String,System.Int32)">
<summary> <summary>
Decrypts an base64 encoded and encrypted string. Due to the necessary millions of SHA512 iterations, Decrypts an base64 encoded and encrypted string. Due to the necessary millions of SHA512 iterations,
the methods runs at least several seconds in the year 2020 (approx. 5-7s). the methods runs at least several seconds in the year 2020 (approx. 5-7s).
@ -107,7 +123,23 @@
</summary> </summary>
<param name="data">The base64 encoded and AES encrypted string. This string must be ASCII encoded.</param> <param name="data">The base64 encoded and AES encrypted string. This string must be ASCII encoded.</param>
<param name="password">The password. Must consists of 6 chars or more.</param> <param name="password">The password. Must consists of 6 chars or more.</param>
<param name="iterations">The number of iterations to derive the key. Should not be adjusted. The default is secure for the current time.</param>
<returns>The decrypted UTF8 encoded string.</returns> <returns>The decrypted UTF8 encoded string.</returns>
</member> </member>
<member name="M:Encrypter.Extensions.Decrypt(System.IO.Stream,System.IO.Stream,System.String,System.Int32)">
<summary>
Decrypts a given input stream and writes the decrypted data to the provided output stream. A buffer stream
gets used in front of the output stream. This method expects, that both streams are read-to-use e.g. the
input stream is at the desired position and the output stream is writable, etc. This method disposes the
internal crypto streams. Thus, the input and output streams might get disposed as well. Please note, that
this method writes binary data without e.g. base64 encoding.
When the task finished, the entire decryption of the input stream is done.
</summary>
<param name="inputStream">The desired input stream. The decryption starts at the current position.</param>
<param name="outputStream">The desired output stream. The decrypted data gets written to the current position.</param>
<param name="password">The encryption password.</param>
<param name="iterations">The number of iterations to derive the key. Should not be adjusted. The default is secure for the current time.</param>
</member>
</members> </members>
</doc> </doc>