Update class documentation
This commit is contained in:
parent
eb8ca96286
commit
13b6c20e7b
@ -88,7 +88,7 @@ That's complicated and specific to the application. Some examples:
|
|||||||
Not secrets:
|
Not secrets:
|
||||||
|
|
||||||
* Digest output. Except when used for key derivation, then it's a Secret, including the Digest state
|
* Digest output. Except when used for key derivation, then it's a Secret, including the Digest state
|
||||||
* IO::Memory or writing a file. Except when the file is a password vault, cryptocurrency wallet, encrypted mail/messages, goat porn, maybe "normal" porn, sometimes scat porn, occassionally furry, not vanilla porn
|
* IO::Memory or writing a file. Except when the file is a password vault, cryptocurrency wallet, encrypted mail/messages, goat porn, maybe "normal" porn, sometimes scat porn, occassionally furry, not people porn
|
||||||
|
|
||||||
## Why?
|
## Why?
|
||||||
|
|
||||||
|
@ -1,11 +1,11 @@
|
|||||||
require "./stateless"
|
require "./stateless"
|
||||||
|
|
||||||
|
module Crypto::Secret
|
||||||
# Leaves less sh** around if you forget to wipe. A safer default for large secrets that may stress mlock limits or low confidentiality secrets.
|
# Leaves less sh** around if you forget to wipe. A safer default for large secrets that may stress mlock limits or low confidentiality secrets.
|
||||||
#
|
#
|
||||||
# * Not locked in memory
|
# * Not locked in memory
|
||||||
# * Not access protected
|
# * Not access protected
|
||||||
# * No guard pages
|
# * No guard pages
|
||||||
module Crypto::Secret
|
|
||||||
class Bidet
|
class Bidet
|
||||||
include Stateless
|
include Stateless
|
||||||
|
|
||||||
|
@ -1,13 +1,13 @@
|
|||||||
require "./stateless"
|
require "./stateless"
|
||||||
|
|
||||||
# A not very secret secret, but fast
|
module Crypto::Secret
|
||||||
|
# A not very secret `Secret`, but fast
|
||||||
#
|
#
|
||||||
# * 0 overhead
|
# * 0 overhead
|
||||||
# * Not locked in memory
|
# * Not locked in memory
|
||||||
# * Not access protected
|
# * Not access protected
|
||||||
# * No guard pages
|
# * No guard pages
|
||||||
# * No wiping
|
# * No wiping
|
||||||
module Crypto::Secret
|
|
||||||
struct Not
|
struct Not
|
||||||
include Stateless
|
include Stateless
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user