2020-07-24 18:40:46 +00:00
< !DOCTYPE html PUBLIC ""
"">
2022-07-18 07:25:29 +00:00
< html > < head > < meta charset = "UTF-8" / > < title > taoensso.nippy.crypto documentation< / title > < link rel = "stylesheet" type = "text/css" href = "css/default.css" / > < link rel = "stylesheet" type = "text/css" href = "css/highlight.css" / > < script type = "text/javascript" src = "js/highlight.min.js" > < / script > < script type = "text/javascript" src = "js/jquery.min.js" > < / script > < script type = "text/javascript" src = "js/page_effects.js" > < / script > < script > hljs . initHighlightingOnLoad ( ) ; < / script > < / head > < body > < div id = "header" > < h2 > Generated by < a href = "https://github.com/weavejester/codox" > Codox< / a > < / h2 > < h1 > < a href = "index.html" > < span class = "project-title" > < span class = "project-name" > Nippy< / span > < span class = "project-version" > 3.2.0< / span > < / span > < / a > < / h1 > < / div > < div class = "sidebar primary" > < h3 class = "no-link" > < span class = "inner" > Project< / span > < / h3 > < ul class = "index-link" > < li class = "depth-1 " > < a href = "index.html" > < div class = "inner" > Index< / div > < / a > < / li > < / ul > < h3 class = "no-link" > < span class = "inner" > Namespaces< / span > < / h3 > < ul > < li class = "depth-1" > < div class = "no-link" > < div class = "inner" > < span class = "tree" > < span class = "top" > < / span > < span class = "bottom" > < / span > < / span > < span > taoensso< / span > < / div > < / div > < / li > < li class = "depth-2" > < a href = "taoensso.nippy.html" > < div class = "inner" > < span class = "tree" > < span class = "top" > < / span > < span class = "bottom" > < / span > < / span > < span > nippy< / span > < / div > < / a > < / li > < li class = "depth-3 branch" > < a href = "taoensso.nippy.benchmarks.html" > < div class = "inner" > < span class = "tree" > < span class = "top" > < / span > < span class = "bottom" > < / span > < / span > < span > benchmarks< / span > < / div > < / a > < / li > < li class = "depth-3 branch" > < a href = "taoensso.nippy.compression.html" > < div class = "inner" > < span class = "tree" > < span class = "top" > < / span > < span class = "bottom" > < / span > < / span > < span > compression< / span > < / div > < / a > < / li > < li class = "depth-3 branch current" > < a href = "taoensso.nippy.crypto.html" > < div class = "inner" > < span class = "tree" > < span class = "top" > < / span > < span class = "bottom" > < / span > < / span > < span > crypto< / span > < / div > < / a > < / li > < li class = "depth-3 branch" > < a href = "taoensso.nippy.encryption.html" > < div class = "inner" > < span class = "tree" > < span class = "top" > < / span > < span class = "bottom" > < / span > < / span > < span > encryption< / span > < / div > < / a > < / li > < li class = "depth-3 branch" > < a href = "taoensso.nippy.tools.html" > < div class = "inner" > < span class = "tree" > < span class = "top" > < / span > < span class = "bottom" > < / span > < / span > < span > tools< / span > < / div > < / a > < / li > < li class = "depth-3" > < a href = "taoensso.nippy.utils.html" > < div class = "inner" > < span class = "tree" > < span class = "top" > < / span > < span class = "bottom" > < / span > < / span > < span > utils< / span > < / div > < / a > < / li > < / ul > < / div > < div class = "sidebar secondary" > < h3 > < a href = "#top" > < span class = "inner" > Public Vars< / span > < / a > < / h3 > < ul > < li class = "depth-1" > < a href = "taoensso.nippy.crypto.html#var-cbc-cipher" > < div class = "inner" > < span > cbc-cipher< / span > < / div > < / a > < / li > < li class = "depth-1" > < a href = "taoensso.nippy.crypto.html#var-cipher-kit-aes-cbc" > < div class = "inner" > < span > cipher-kit-aes-cbc< / span > < / div > < / a > < / li > < li class = "depth-1" > < a href = "taoensso.nippy.crypto.html#var-cipher-kit-aes-gcm" > < div class = "inner" > < span > cipher-kit-aes-gcm< / span > < / div > < / a > < / li > < li class = "depth-1" > < a href = "taoensso.nippy.crypto.html#var-decrypt" > < div class = "inner" > < span > decrypt< / span > < / div > < / a > < / li > < li class = "depth-1" > < a href = "taoensso.nippy.crypto.html#var-encrypt" > < div class = "inner" > < span > encrypt< / span > < / div > < / a > < / li > < li class = "depth-1" > < a href = "taoensso.nippy.crypto.html#var-gcm-cipher" > < div class = "inner" > < span > gcm-cipher< / span > < / div > < / a > < / li > < li class = "depth-1" > < a href = "taoensso.nippy.crypto.html#var-ICipherKit" > < div class = "inner" > < span > ICipherKit< / span > < / div > < / a > < / li > < li class = "depth-2 branch" > < a href = "taoensso.nippy.crypto.html#var-get-cipher" > < div class = "inner" > < span class = "tree" > < span class = "top" > < / span > < span class = "bottom" > < / span > < / span > < span > get-cipher< / span > < / div > < / a > < / li > < li class = "depth-2 branch" > < a href = "taoensso.nippy.crypto.html#var-get-iv-size" > < div class = "inner" > < span class = "tree" > < span class = "top" > < / span > < span class = "bottom" > < / span > < / span > < span > get-iv-size< / span > < / div > < / a > < / li > < li class = "depth-2 branch" > < a href = "taoensso.nippy.crypto.html#var-get-key-spec" > < div
2020-09-10 09:56:10 +00:00
Private & alpha, very likely to change!< / pre > < / div > < div class = "public anchor" id = "var-cbc-cipher" > < h3 > cbc-cipher< / h3 > < div class = "usage" > < code > (cbc-cipher)< / code > < / div > < div class = "doc" > < pre class = "plaintext" > < / pre > < / div > < / div > < div class = "public anchor" id = "var-cipher-kit-aes-cbc" > < h3 > cipher-kit-aes-cbc< / h3 > < div class = "usage" > < / div > < div class = "doc" > < pre class = "plaintext" > Default CipherKit for AES CBC
< / pre > < / div > < / div > < div class = "public anchor" id = "var-cipher-kit-aes-gcm" > < h3 > cipher-kit-aes-gcm< / h3 > < div class = "usage" > < / div > < div class = "doc" > < pre class = "plaintext" > Default CipherKit for AES GCM
< / pre > < / div > < / div > < div class = "public anchor" id = "var-decrypt" > < h3 > decrypt< / h3 > < div class = "usage" > < code > (decrypt {:keys [cipher-kit salt-size salt-> key-fn enc-ba], :or {cipher-kit cipher-kit-aes-gcm}})< / code > < / div > < div class = "doc" > < pre class = "plaintext" > < / pre > < / div > < / div > < div class = "public anchor" id = "var-encrypt" > < h3 > encrypt< / h3 > < div class = "usage" > < code > (encrypt {:keys [cipher-kit ?salt-ba key-ba plain-ba rand-bytes-fn], :or {cipher-kit cipher-kit-aes-gcm, rand-bytes-fn rand-bytes}})< / code > < / div > < div class = "doc" > < pre class = "plaintext" > < / pre > < / div > < / div > < div class = "public anchor" id = "var-gcm-cipher" > < h3 > gcm-cipher< / h3 > < div class = "usage" > < code > (gcm-cipher)< / code > < / div > < div class = "doc" > < pre class = "plaintext" > < / pre > < / div > < / div > < div class = "public anchor" id = "var-ICipherKit" > < h3 > ICipherKit< / h3 > < h4 class = "type" > protocol< / h4 > < div class = "usage" > < / div > < div class = "doc" > < pre class = "plaintext" > < / pre > < / div > < div class = "members" > < h4 > members< / h4 > < div class = "inner" > < div class = "public anchor" id = "var-get-cipher" > < h3 > get-cipher< / h3 > < div class = "usage" > < code > (get-cipher _)< / code > < / div > < div class = "doc" > < pre class = "plaintext" > Returns a thread-safe `javax.crypto.Cipher` instance.
2020-07-24 18:40:46 +00:00
< / pre > < / div > < / div > < div class = "public anchor" id = "var-get-iv-size" > < h3 > get-iv-size< / h3 > < div class = "usage" > < code > (get-iv-size _)< / code > < / div > < div class = "doc" > < pre class = "plaintext" > Returns necessary iv-ba length.
< / pre > < / div > < / div > < div class = "public anchor" id = "var-get-key-spec" > < h3 > get-key-spec< / h3 > < div class = "usage" > < code > (get-key-spec _ ba)< / code > < / div > < div class = "doc" > < pre class = "plaintext" > Returns a `javax.crypto.spec.SecretKeySpec`.
< / pre > < / div > < / div > < div class = "public anchor" id = "var-get-param-spec" > < h3 > get-param-spec< / h3 > < div class = "usage" > < code > (get-param-spec _ iv-ba)< / code > < / div > < div class = "doc" > < pre class = "plaintext" > Returns a `java.security.spec.AlgorithmParameters`.
2020-09-10 09:56:10 +00:00
< / pre > < / div > < / div > < / div > < / div > < / div > < div class = "public anchor" id = "var-murmur3" > < h3 > murmur3< / h3 > < div class = "usage" > < code > (murmur3 s)< / code > < / div > < div class = "doc" > < pre class = "plaintext" > < / pre > < / div > < / div > < div class = "public anchor" id = "var-pwd-as-ba" > < h3 > pwd-as-ba< / h3 > < div class = "usage" > < code > (pwd-as-ba utf8-or-ba)< / code > < / div > < div class = "doc" > < pre class = "plaintext" > < / pre > < / div > < / div > < div class = "public anchor" id = "var-rand-bool" > < h3 > rand-bool< / h3 > < div class = "usage" > < code > (rand-bool)< / code > < / div > < div class = "doc" > < pre class = "plaintext" > < / pre > < / div > < / div > < div class = "public anchor" id = "var-rand-bytes" > < h3 > rand-bytes< / h3 > < div class = "usage" > < code > (rand-bytes size)< / code > < / div > < div class = "doc" > < pre class = "plaintext" > < / pre > < / div > < / div > < div class = "public anchor" id = "var-rand-double" > < h3 > rand-double< / h3 > < div class = "usage" > < code > (rand-double)< / code > < / div > < div class = "doc" > < pre class = "plaintext" > < / pre > < / div > < / div > < div class = "public anchor" id = "var-rand-gauss" > < h3 > rand-gauss< / h3 > < div class = "usage" > < code > (rand-gauss)< / code > < / div > < div class = "doc" > < pre class = "plaintext" > < / pre > < / div > < / div > < div class = "public anchor" id = "var-rand-long" > < h3 > rand-long< / h3 > < div class = "usage" > < code > (rand-long)< / code > < code > (rand-long n)< / code > < / div > < div class = "doc" > < pre class = "plaintext" > < / pre > < / div > < / div > < div class = "public anchor" id = "var-rand-nth" > < h3 > rand-nth< / h3 > < div class = "usage" > < code > (rand-nth coll)< / code > < / div > < div class = "doc" > < pre class = "plaintext" > < / pre > < / div > < / div > < div class = "public anchor" id = "var-sha256-ba" > < h3 > sha256-ba< / h3 > < div class = "usage" > < code > (sha256-ba ba)< / code > < / div > < div class = "doc" > < pre class = "plaintext" > < / pre > < / div > < / div > < div class = "public anchor" id = "var-sha256-md" > < h3 > sha256-md< / h3 > < div class = "usage" > < code > (sha256-md)< / code > < / div > < div class = "doc" > < pre class = "plaintext" > < / pre > < / div > < / div > < div class = "public anchor" id = "var-sha512-ba" > < h3 > sha512-ba< / h3 > < div class = "usage" > < code > (sha512-ba ba)< / code > < / div > < div class = "doc" > < pre class = "plaintext" > < / pre > < / div > < / div > < div class = "public anchor" id = "var-sha512-key-ba" > < h3 > sha512-key-ba< / h3 > < div class = "usage" > < code > (sha512-key-ba ?salt-ba utf8-or-ba)< / code > < code > (sha512-key-ba ?salt-ba utf8-or-ba n-rounds)< / code > < / div > < div class = "doc" > < pre class = "plaintext" > SHA512-based key generator. Good JVM availability without extra dependencies
(PBKDF2, bcrypt, scrypt, etc.). Decent security when using many rounds.< / pre > < / div > < / div > < div class = "public anchor" id = "var-sha512-md" > < h3 > sha512-md< / h3 > < div class = "usage" > < code > (sha512-md)< / code > < / div > < div class = "doc" > < pre class = "plaintext" > < / pre > < / div > < / div > < div class = "public anchor" id = "var-take-ba" > < h3 > take-ba< / h3 > < div class = "usage" > < code > (take-ba n ba)< / code > < / div > < div class = "doc" > < pre class = "plaintext" > < / pre > < / div > < / div > < div class = "public anchor" id = "var-utf8-.3Eba" > < h3 > utf8-> ba< / h3 > < div class = "usage" > < code > (utf8-> ba s)< / code > < / div > < div class = "doc" > < pre class = "plaintext" > < / pre > < / div > < / div > < / div > < / body > < / html >
