Skip to content
Browse files

Add a password utility, improve documentation,

add a LICENSE file (Apache)
  • Loading branch information...
1 parent 2a13f01 commit 5aa7ddaec9ca2eafa2f2dada06d2b660e9c3a8ff @theatrus committed Aug 20, 2012
View
202 LICENSE
@@ -0,0 +1,202 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
View
2 project/Dependencies.scala
@@ -21,5 +21,7 @@ object Dependencies {
val sprayServer = "cc.spray" % "spray-server" % V.spray
val specs2 = "org.specs2" %% "specs2" % "1.11"
val akkaActor = "com.typesafe.akka" % "akka-actor" % V.akka
+ val bcprov = "org.bouncycastle" % "bcprov-jdk16" % "1.46"
+
}
View
33 src/main/scala/us/theatr/spray/nozzle/CookieCrypter.scala
@@ -1,5 +1,21 @@
package us.theatr.spray.nozzle
+/*
+Copyright 2012 Yann Ramin
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
import javax.crypto.spec.{IvParameterSpec, SecretKeySpec}
import sun.misc.{BASE64Encoder, BASE64Decoder}
import javax.crypto.{Mac, Cipher}
@@ -24,6 +40,12 @@ trait CookieCrypter {
protected lazy val cipherKeySpec = new SecretKeySpec(cipherKey, keyType)
protected lazy val hmacKeySpec = new SecretKeySpec(hmacKey, macAlgo)
+ /**
+ * Verify an input String (base64 encoded)
+ * @param inp Input string
+ * @param extra Any extra information to add to the verification (host name, browser, etc)
+ * @return
+ */
def verify(inp: String, extra: String = "") : Option[String] = {
val decoder = new BASE64Decoder()
val now = System.currentTimeMillis() / 1000
@@ -37,6 +59,7 @@ trait CookieCrypter {
val clear = cipher.doFinal(ciphertext)
val (rest, msg_time_bytes) = clear.splitAt(clear.size - 4)
+ // Unpack msgtime from its by array
val msg_time = ((msg_time_bytes(0) << 24) & 0xFF000000) | ((msg_time_bytes(1) << 16) & 0xFF0000) | ((msg_time_bytes(2) << 8) & 0xFF00) | (msg_time_bytes(3) & 0xFF)
val mac = Mac.getInstance(macAlgo)
@@ -53,6 +76,16 @@ trait CookieCrypter {
}
+ /**
+ * Generate a signed and encrypted output file, which has a specified time to live given in milliseconds
+ * @param inp Raw input string to sign and encrypt. This will be converted to UTF-8 before either operation.
+ * @param extra Extra information to include in the signature but NOT in the output data -
+ * this same (exact) information must be provided to the verify function. For instance,
+ * the browser client string can be used to obfuscate non-SSL cookie-snooping attacks.
+ * @param expires Expire after this number of milliseconds. Intervals of less than 1 second are not supported.
+ * @return A base64 encoded string containing the encrypted and signed input string to be given to the client
+ * and verified with the verify function.
+ */
def output(inp: String, extra: String = "", expires: Long = defaultExpires) : String = {
val encoder = new BASE64Encoder()
View
16 src/main/scala/us/theatr/spray/nozzle/HeaderFilterDirectives.scala
@@ -1,5 +1,21 @@
package us.theatr.spray.nozzle
+/*
+Copyright 2012 Yann Ramin
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
import cc.spray.{MissingCookieRejection, Reject, Directives, Pass}
import cc.spray.directives.{SprayRoute2, SprayRoute1}
import cc.spray.http.{HttpHeaders, HttpCookie}
View
90 src/main/scala/us/theatr/spray/nozzle/PasswordUtil.scala
@@ -0,0 +1,90 @@
+package us.theatr.spray.nozzle
+
+/*
+Copyright 2012 Yann Ramin
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+import sun.misc.{BASE64Encoder, BASE64Decoder}
+import javax.crypto.SecretKeyFactory
+import javax.crypto.spec.PBEKeySpec
+import java.security.{Security, SecureRandom}
+import org.bouncycastle.jce.provider.BouncyCastleProvider
+
+/**
+ * A standard/boring way to store passwords safely using PBKDF#2
+ * and a random salt. All parameters are encoded into the salt text string
+ * to allow porting of the default algorithms and iterations at a later date.
+ */
+object PasswordUtil {
+
+ /**
+ * The default iterations parameter - this is the number of rounds of PBKDF#2 to run
+ */
+ val iterations = 200000
+ /**
+ * The default algorithm for hashing. Certain algorithms require GnuCrypto,
+ * such as HmacSHA256
+ */
+ val default_algo = "PBKDF2WithHmacSHA1"
+
+ /**
+ * This must match the expected output of the algorithm in question.
+ */
+ val hash_length = 160
+
+ /**
+ * Given a user password, the hashed password from the datastore, and the stored salt, check
+ * if the password matches.
+ * @param password User supplied password
+ * @param dbpassword Data-store password - previously generated by securePassword
+ * @param salt Data-store salt - previously generated by securePassword
+ * @return
+ */
+ def checkPassword(password: String, dbpassword: String, salt: String) : Boolean = {
+ val spl = salt.split(':')
+
+ val saltarray = new BASE64Decoder().decodeBuffer(spl(2))
+ val algo = spl(0)
+ val iter = spl(1).toInt
+ securePassword(password, saltarray, iter, algo)._1 == dbpassword
+ }
+
+ /**
+ * Secure a password given in password. All other parameters are default.
+ * @param password User supplied password
+ * @param salt (optional)
+ * @param iter (optional) Number of iterations
+ * @param algo (optional) Algorithm
+ * @param hash_len (optional) Hash length output
+ * @return A tuple of Strings containing: (Base64(password_hash), Salt)
+ */
+ def securePassword(password: String, salt: Array[Byte] = generateSalt, iter: Int = iterations, algo: String = default_algo, hash_len: Int = hash_length) : (String, String) = {
+ val fac = SecretKeyFactory.getInstance(algo)
+
+ val pbks = new PBEKeySpec(password.toCharArray, salt, iterations, hash_len)
+ (new BASE64Encoder().encode(fac.generateSecret(pbks).getEncoded),
+ algo + ":" + iterations.toString + ":" + new BASE64Encoder().encode(salt))
+ }
+
+ /**
+ * Generate a salt (random array of bytes)
+ * @return Array of random bytes
+ */
+ def generateSalt : Array[Byte] = {
+ val bytes = Array.fill(128) {0.toByte}
+ new SecureRandom().nextBytes(bytes)
+ bytes
+ }
+}
View
16 src/test/scala/us/theatr/spray/nozzle/CookieCrypter$Test.scala
@@ -1,5 +1,21 @@
package us.theatr.spray.nozzle
+/*
+Copyright 2012 Yann Ramin
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
import org.specs2.mutable.Specification
class CookieCrypter$Test extends Specification {
View
50 src/test/scala/us/theatr/spray/nozzle/PasswordUtilSpec.scala
@@ -0,0 +1,50 @@
+package us.theatr.spray.nozzle
+
+/*
+Copyright 2012 Yann Ramin
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+import org.specs2.mutable.Specification
+
+
+class PasswordUtilSpec extends Specification {
+ "Passwords" should {
+ "encrypt" in {
+ PasswordUtil.securePassword("Hello")._1.length must be_>(2)
+ }
+
+ "verify" in {
+ val (pw, salt) = PasswordUtil.securePassword("Hello")
+ PasswordUtil.checkPassword("Hello", pw, salt) must beTrue
+ PasswordUtil.checkPassword("Hi", pw, salt) must beFalse
+ }
+
+ "support long passwords" in {
+ PasswordUtil.securePassword("HelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHello")._1.length must be_>(2)
+ }
+
+
+ }
+
+ "Salt" should {
+ "be different" in {
+ val s1 = PasswordUtil.generateSalt.toSeq
+ val s2 = PasswordUtil.generateSalt.toSeq
+ s1 must not be equalTo(s2)
+ s1 must beEqualTo(s1)
+ }
+ }
+}
+

0 comments on commit 5aa7dda

Please sign in to comment.
Something went wrong with that request. Please try again.