Update project version and documentation

This adds some more up-to-date docs, in case we want to take over
Hackage maintenance for this particular library.

It also bumps the version, to help clarify when we're relying on our own
custom release on scrypt in other projects, and in case we want to take
over Hackage maintenance.

Author: ivanbakel

CHANGELOG.markdown

@@ -0,0 +1,8 @@
+# Changelog for `scrypt`
+
+## 0.5.0.1
+
+ * Changed backing C bindings to link to
+   [`libscrypt-kdf`](https://www.tarsnap.com/scrypt.html), a multi-platform
+   implementation of scrypt, to allow for using the library on M1 Macs and
+   other systems.

DEVELOPING.markdown

@@ -0,0 +1,45 @@
+# Development
+
+This repository is a [Nix flake](https://nixos.wiki/wiki/Flakes).
+
+The supported way to start developing is to drop into the development shell,
+with `nix develop`. Make sure you have Nix installed for this, and that
+the necessary Nix features for using flakes are enabled.
+
+Inside the development shell, you should be able to use `cabal` commands as
+normal i.e.
+
+  * `cabal v2-build` to compile the library - this will call `c2hs` automatically
+  * `cabal test` to compile and run the tests
+
+## cabal2nix
+
+Because of issues with using `callCabal2nix` in the flake overlay, this project
+relies on a manually-generated Nix derivation to define the Haskell package.
+This file is still generated with `cabal2nix`, but it is simply tracked in the
+git history.
+
+It should be regenerated every time `scrypt.cabal` is edited. To regenerate the
+file after editing `scrypt.cabal`, run this in the development shell:
+
+```
+cabal2nix . > cabal2nix-scrypt.nix
+```
+
+## c2hs
+
+Because of a peculiarity with how the `scrypt` C library defines its public
+function API, we rely on `c2hs` to do some preprocessing of our Haskell files.
+
+If you use the development approach supported above, this should be handled
+automatically for you. Otherwise, you will have to generate the Haskell code
+yourself manually.
+
+## libscrypt-kdf
+
+Generating the Haskell bindings for this library requires a copy of the
+`libscrypt-kdf` library that includes the development header.
+
+This header is provided by the Nix flake automatically. If you aren't using Nix,
+you will probably have to install it manually - look for `libscrypt-kdf` in your
+package manager.

LICENSE

@@ -1,4 +1,5 @@
 Copyright (c)2011, Falko Peters
+          (c)2023, Supercede Ltd.
 
 All rights reserved.
 

README.markdown

@@ -4,18 +4,21 @@ This is a Haskell library providing bindings to [Colin Percival's scrypt impleme
 
 Details of the scrypt key derivation function are given in a paper by Colin Percival, Stronger Key Derivation via Sequential Memory-Hard Functions: [PDF](http://www.tarsnap.com/scrypt/scrypt-slides.pdf).
 
+Unlike earlier versions of the `scrypt` library, this version is compatible with multiple OSes and architectures.
+
 # Join in!
 
 We are happy to receive bug reports, fixes, documentation enhancements, and other improvements.
 
-Please report bugs via the [github issue tracker](http://github.com/informatikr/scrypt/issues).
+Please report bugs via the [github issue tracker](http://github.com/SupercedeTech/scrypt/issues).
 
-Master [git repository](http://github.com/informatikr/scrypt):
+Master [git repository](http://github.com/SupercedeTech/scrypt):
 
-    git clone git://github.com/informatikr/scrypt.git
+    git clone git://github.com/SupercedeTech/scrypt.git
 
 # Authors
 
-This library is written and maintained by Falko Peters, <falko.peters@gmail.com>.
+This library was originally written by Falko Peters, <falko.peters@gmail.com>, with thanks to Thomas DuBuisson.
+
+This library is maintained by Supercede Ltd., <support@supercede.com>.
 
-Thanks to Thomas DuBuisson for suggesting the changes to make this package windows-compatible.

cabal2nix-scrypt.nix

@@ -4,7 +4,7 @@
 }:
 mkDerivation {
   pname = "scrypt";
-  version = "0.5.0";
+  version = "0.5.0.1";
   src = ./.;
   libraryHaskellDepends = [
     base base64-bytestring bytestring entropy
@@ -15,7 +15,7 @@ mkDerivation {
     base bytestring HUnit QuickCheck test-framework
     test-framework-hunit test-framework-quickcheck2
   ];
-  homepage = "http://github.com/informatikr/scrypt";
+  homepage = "http://github.com/SupercedeTech/scrypt";
   description = "Stronger password hashing via sequential memory-hard functions";
   license = lib.licenses.bsd3;
 }

flake.nix

@@ -31,6 +31,7 @@
           withHoogle = false;
           buildInputs = with haskellPackages; [
             cabal-install
+            cabal2nix
             c2hs
           ];
         });

scrypt.cabal

@@ -1,15 +1,15 @@
 name:           scrypt
-version:        0.5.0
+version:        0.5.0.1
 license:        BSD3
 license-file:   LICENSE
 category:       Cryptography
-copyright:      Copyright 2011 Falko Peters
+copyright:      Copyright 2011 Falko Peters, 2023 Supercede Ltd.
 author:         Falko Peters <falko.peters@gmail.com>
-maintainer:     Falko Peters <falko.peters@gmail.com>
+maintainer:     Supercede Ltd. <support@supercede.com>
 stability:      experimental
 cabal-version:  >= 1.8
-homepage:       http://github.com/informatikr/scrypt
-bug-reports:    http://github.com/informatikr/scrypt/issues
+homepage:       http://github.com/SupercedeTech/scrypt
+bug-reports:    http://github.com/SupercedeTech/scrypt/issues
 build-type:     Simple
 synopsis:
     Stronger password hashing via sequential memory-hard functions.
@@ -25,10 +25,11 @@ description:
 
 extra-source-files:
     README.markdown
+    CHANGELOG.markdown
 
 source-repository head
     type:     git
-    location: http://github.com/informatikr/scrypt
+    location: http://github.com/SupercedeTech/scrypt
 
 library
     exposed-modules: Crypto.Scrypt