Maintainership takeover

Updates various project meta-data

.gitignore

@@ -1,168 +1,4 @@
-#################
-## Eclipse
-#################
-
-*.pydevproject
-.project
-.metadata
-bin/
-tmp/
-*.tmp
-*.bak
-*.swp
-*~.nib
-local.properties
-.classpath
-.settings/
-.loadpath
-
-# External tool builders
-.externalToolBuilders/
-
-# Locally stored "Eclipse launch configurations"
-*.launch
-
-# CDT-specific
-.cproject
-
-# PDT-specific
-.buildpath
-
-
-#################
-## Visual Studio
-#################
-
-## Ignore Visual Studio temporary files, build results, and
-## files generated by popular Visual Studio add-ons.
-
-# User-specific files
-*.suo
-*.user
-*.sln.docstates
-
-# Build results
-[Dd]ebug/
-[Rr]elease/
-*_i.c
-*_p.c
-*.ilk
-*.meta
-*.obj
-*.pch
-*.pdb
-*.pgc
-*.pgd
-*.rsp
-*.sbr
-*.tlb
-*.tli
-*.tlh
-*.tmp
-*.vspscc
-.builds
-*.dotCover
-
-## TODO: If you have NuGet Package Restore enabled, uncomment this
-#packages/
-
-# Visual C++ cache files
-ipch/
-*.aps
-*.ncb
-*.opensdf
-*.sdf
-
-# Visual Studio profiler
-*.psess
-*.vsp
-
-# ReSharper is a .NET coding add-in
-_ReSharper*
-
-# Installshield output folder
-[Ee]xpress
-
-# DocProject is a documentation generator add-in
-DocProject/buildhelp/
-DocProject/Help/*.HxT
-DocProject/Help/*.HxC
-DocProject/Help/*.hhc
-DocProject/Help/*.hhk
-DocProject/Help/*.hhp
-DocProject/Help/Html2
-DocProject/Help/html
-
-# Click-Once directory
-publish
-
-# Others
-[Bb]in
-[Oo]bj
-sql
-TestResults
-*.Cache
-ClientBin
-stylecop.*
-~$*
-*.dbmdl
-Generated_Code #added for RIA/Silverlight projects
-
-# Backup & report files from converting an old project file to a newer
-# Visual Studio version. Backup files are not needed, because we have git ;-)
-_UpgradeReport_Files/
-Backup*/
-UpgradeLog*.XML
-
-
-
-############
-## Windows
-############
-
-# Windows image file caches
-Thumbs.db
-
-# Folder config file
-Desktop.ini
-
-
-#############
-## Python
-#############
-
-*.py[co]
-
-# Packages
-*.egg
-*.egg-info
-dist
-build
-eggs
-parts
-bin
-var
-sdist
-develop-eggs
-.installed.cfg
-
-# Installer logs
-pip-log.txt
-
-# Unit test / coverage reports
-.coverage
-.tox
-
-#Translations
-*.mo
-
-#Mr Developer
-.mr.developer.cfg
-
-# Mac crap
-.DS_Store
-TAGS
-.cabal-sandbox
-cabal.sandbox.config
-.stack-work
-stack.yaml
+/dist/
+/dist-newstyle/
+/.ghc.environment.*
+*~

CHANGELOG.md

@@ -1,18 +1,8 @@
-# CHANGELOG
+## 0.1.0.0
 
-## 2.0.0
-### Changed
-* Change versioning to semver
-* Use `cryptonite` instead of deprecated `cryptohash` (broken backwards
-  compatibility)
+* Major API rewrite ([#3](https://github.com/hvr/OTP/pull/3))
+* Add support for more hash functions besides SHA-1 ([#1](https://github.com/hvr/OTP/pull/1))
 
-## 1.0.0.1
+## 0.0.0.1
 
-* Documentation typos fixed
-
-## 1.0.0.0
-
-* Forked from OTP (https://github.com/matshch/OTP)
-* Rewrote with `cryptohash`
-* Add multiple hash functions support
-* Tests improoved: all RFC test verctors passed
+Initial version of `OTP`

LICENSE

@@ -1,4 +1,6 @@
 Copyright (c) 2012 Artem Leshchev
+              2016 Aleksey Uimanov,
+              2018 Herbert Valerio Riedel
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

OTP.cabal

@@ -0,0 +1,69 @@
+cabal-version: 1.12
+name:          OTP
+version:       0.1.0.0
+synopsis:      HMAC-Based and Time-Based One-Time Passwords (HOTP & TOTP)
+
+description:   Implements the /HMAC-Based One-Time Password Algorithm/ (HOTP) as
+               defined in [RFC 4226](https://tools.ietf.org/html/rfc4226)
+               and the /Time-Based One-Time Password Algorithm/ (TOTP) as defined
+               in [RFC 6238](https://tools.ietf.org/html/rfc6238).
+
+license:       MIT
+license-file:  LICENSE
+copyright:     2012 Artem Leshchev,
+               2016 Aleksey Uimanov,
+               2018 Herbert Valerio Riedel
+author:        Artem Leshchev,
+               Aleksey Uimanov,
+               Herbert Valerio Riedel
+maintainer:    [email protected]
+homepage:      https://github.com/hvr/OTP
+bug-reports:   https://github.com/hvr/OTP/issues
+category:      Cryptography
+build-type:    Simple
+
+extra-source-files:
+  CHANGELOG.md
+  README.md
+
+source-repository head
+  type:     git
+  location: https://github.com/hvr/OTP.git
+
+library
+  hs-source-dirs:     src
+  exposed-modules:    Data.OTP
+
+  default-language:   Haskell2010
+  default-extensions: OverloadedStrings
+                    , ScopedTypeVariables
+  build-depends:      base >= 4.3 && < 4.12
+                    , bytestring
+                    , cereal
+                    , cryptonite
+                    , memory
+                    , time >= 1.1
+
+  ghc-options:        -Wall
+
+
+test-suite tests
+  type:               exitcode-stdio-1.0
+
+  hs-source-dirs:     test
+  main-is:            Test.hs
+
+  default-language:   Haskell2010
+  default-extensions: ExistentialQuantification
+                      OverloadedStrings
+                      RankNTypes
+
+  build-depends:      base >= 3 && < 5
+                    , bytestring
+                    , cryptonite
+                    , OTP
+                    , tasty
+                    , tasty-hunit
+                    , time >= 1.1
+
+  ghc-options:        -Wall

README.md

@@ -1,9 +1,10 @@
-# What
+# `OTP`: HMAC-Based and Time-Based One-Time Passwords (HOTP & TOTP)  [![Hackage](https://img.shields.io/hackage/v/OTP.svg)](https://hackage.haskell.org/package/OTP) [![Build Status](https://travis-ci.org/hvr/OTP.svg)](https://travis-ci.org/hvr/OTP)
 
-One time password implementation according to RFC4226 and RFC6238 in
-Haskell.
+**Please refer to the [package description](https://hackage.haskell.org/package/OTP#description) for an overview of `OTP`.**
 
-# Generation passwords
+## Usage examples
+
+### Generation passwords
 
 If you need to generate HOTP password described in RFC4226, then use
 
@@ -24,7 +25,7 @@ Or
 
 to generate TOTP password described in RFC6238.
 
-# Checking passwords
+### Checking passwords
 
 ```haskell
 hotpCheck :: (HashAlgorithm a)

src/Data/OTP.hs

@@ -1,4 +1,6 @@
--- |Implements HMAC-Based One-Time Password Algorithm as defined in RFC 4226 and
+-- | SPDX-License-Identifier: MIT
+--
+-- Implements HMAC-Based One-Time Password Algorithm as defined in RFC 4226 and
 -- Time-Based One-Time Password Algorithm as defined in RFC 6238.
 module Data.OTP
        ( -- * HOTP