Password

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this program. If not, see https://www.gnu.org/licenses/.

Data Types

type PWDatabase = Map String PWData

a mapping of service names to password data

data PWData

data necessary to construct a password

Constructors

PWData

Fields

• _pwPolicy :: PWPolicy

  the password policy

• _pwSalt :: PWSalt

  random data used to generate the password

Instances

Eq PWData

Defined in Password

Methods

(==) :: PWData -> PWData -> Bool

(/=) :: PWData -> PWData -> Bool

Show PWData

Defined in Password

Methods

showsPrec :: Int -> PWData -> ShowS

show :: PWData -> String

showList :: [PWData] -> ShowS

ToJSON PWData

Defined in Password

Methods

toJSON :: PWData -> Value

toEncoding :: PWData -> Encoding

toJSONList :: [PWData] -> Value

toEncodingList :: [PWData] -> Encoding

FromJSON PWData

Defined in Password

Methods

parseJSON :: Value -> Parser PWData

parseJSONList :: Value -> Parser [PWData]

data PWPolicy

defines a password policy

Constructors

PWPolicy

Fields

• _pwLength :: Int

  password length

• _pwUpper :: Int

  the minimum number of upper case characters

• _pwLower :: Int

  the minimum number of lower case characters

• _pwDigits :: Int

  the minimum number of digits

• _pwSpecial :: Maybe Int

  the minimum number of non-alphanumeric characters (not allowed if Nothing)

Instances

Eq PWPolicy

Defined in Password

Methods

(==) :: PWPolicy -> PWPolicy -> Bool

(/=) :: PWPolicy -> PWPolicy -> Bool

Show PWPolicy

Defined in Password

Methods

showsPrec :: Int -> PWPolicy -> ShowS

show :: PWPolicy -> String

showList :: [PWPolicy] -> ShowS

ToJSON PWPolicy

Defined in Password

Methods

toJSON :: PWPolicy -> Value

toEncoding :: PWPolicy -> Encoding

toJSONList :: [PWPolicy] -> Value

toEncodingList :: [PWPolicy] -> Encoding

FromJSON PWPolicy

Defined in Password

Methods

parseJSON :: Value -> Parser PWPolicy

parseJSONList :: Value -> Parser [PWPolicy]

type PWSalt = ByteString

the "salt" used to generate a password

Lenses

The following functions are automatically generated by makeLenses. See the lens package for further details.

pwPolicy :: Lens' PWData PWPolicy

pwSalt :: Lens' PWData PWSalt

PWPolicy

pwLength :: Lens' PWPolicy Int

pwUpper :: Lens' PWPolicy Int

pwLower :: Lens' PWPolicy Int

pwDigits :: Lens' PWPolicy Int

pwSpecial :: Lens' PWPolicy (Maybe Int)

Default Instances

newPWDatabase :: PWDatabase

default (empty) password database

newPWData

Arguments

:: RandomGen g

=> g

the random generator to use

-> (PWData, g)

the result and new random generator

builds a new PWData

newPWPolicy :: PWPolicy

default password policy

newPWSalt

Arguments

:: RandomGen g

=> g

the random generator to use

-> (PWSalt, g)

the result and new random generator

builds a new salt

Validations

validatePWDatabase

Arguments

:: PWDatabase

the database to be validated

-> Bool

True if valid; False otherwise

validates a password database

validatePWData

Arguments

:: PWData

the data to be validated

-> Bool

True if valid; False otherwise

validates password data

validatePWPolicy

Arguments

:: PWPolicy

the policy being validated

-> Bool

indicates whether or not the policy is valid

validates a password policy

Functions

Password Generator

pwGenerate

Arguments

:: String

the master password

-> PWData

the password parameters

-> Maybe String

the resulting password, if possible; Nothing if the data is invalid

generates a password

Password Checkers

pwCountUpper

Arguments

:: String

the password

-> Int

the count

counts upper case characters in a password

pwCountLower

Arguments

:: String

the password

-> Int

the count

counts lower case characters in a password

pwCountDigits

Arguments

:: String

the password

-> Int

the count

counts digits in a password

pwCountSpecial

Arguments

:: String

the password

-> Int

the count

counts special characters in a password

pwCount

Arguments

:: (Char -> Bool)

the constraint

-> String

the string being checked

-> Int

the count

counts characters matching a specific constraint

Database Functions

pwHasService

Arguments

:: String

the service name

-> PWDatabase

the database to check

-> Bool

returns True if found; False otherwise

checks to see if a service is in the database

pwSetService

Arguments

:: String

the service name

-> PWData

the password data for the service

-> PWDatabase

the database to add to

-> PWDatabase

the resulting database

adds a service to the database, or overwrites an existing one

pwGetService

Arguments

:: String

the service name

-> PWDatabase

the database to check

-> Maybe PWData

the service's password data, or Nothing if the service is not found

attempts to get a service from the database

pwRemoveService

Arguments

:: String

the service being removed

-> PWDatabase

the database the service is being removed from

-> PWDatabase

the resulting database

removes a service from the database

pwSearch

Arguments

:: String

the search string

-> PWDatabase

the database to search

-> [String]

the matching service names

searches for a service

Orphan instances

ToJSON ByteString

Methods

toJSON :: ByteString -> Value

toEncoding :: ByteString -> Encoding

toJSONList :: [ByteString] -> Value

toEncodingList :: [ByteString] -> Encoding

FromJSON ByteString

Methods

parseJSON :: Value -> Parser ByteString

parseJSONList :: Value -> Parser [ByteString]