Document recommended KDF use

master
Didactic Drunk 2021-03-26 13:56:26 -07:00
parent 67a1a655ef
commit b271192465
1 changed files with 13 additions and 0 deletions

View File

@ -15,6 +15,19 @@ module Sodium
# Memory for this class is held in a sodium guarded page with noaccess. # Memory for this class is held in a sodium guarded page with noaccess.
# Readonly access is temporarily enabled when deriving keys. # Readonly access is temporarily enabled when deriving keys.
# Calling #to_slice marks the page readonly permanently. # Calling #to_slice marks the page readonly permanently.
#
# It's recommended to use a #wipe block to erase the master key when no longer needed
# ```
# kdf = Kdf.new
# ...
# kdf.wipe do
# ### Warning: abnormal exit may not wipe
# # encrypt/decrypt data
# end # key erased
# # main application logic
# ```
#
# ``` # ```
class Kdf class Kdf
include Wipe include Wipe