keyring: Keyring access

[ library, mit, system ] [ Propose Tags ]

keyring provides access to the system's keyring to securely store passwords.

Currently this library supports the following keyring implementations:

  • Keychain on OS X

  • KWallet on KDE

The System.Keyring module provides the high-level functions getPassword and setPassword to easily get and set passwords in the keyring of the current user. The appropriate backend is chosen automatically.


[Skip to Readme]

Modules

[Last Documentation]

  • System
    • System.Keyring
      • System.Keyring.Darwin
      • System.Keyring.Unix
        • System.Keyring.Unix.KDE

Flags

Manual Flags

NameDescriptionDefault
allbackends

Try to build as many backends as possible

Disabled
example

Build an example executable

Disabled

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Candidates

  • No Candidates
Versions [RSS] 0.1.0.0, 0.1.0.1, 0.1.0.2, 0.1.0.3, 0.1.0.4, 0.1.0.5
Change log CHANGES.md
Dependencies base (>=4.6 && <4.10), bytestring (>=0.10 && <0.11), keyring, udbus (>=0.2 && <0.3), utf8-string (>=1 && <1.1) [details]
License MIT
Copyright (C) 2014, 2015 Sebastian Wiesner
Author Sebastian Wiesner
Maintainer swiesner@lunaryorn.com
Category System
Home page https://github.com/lunaryorn/haskell-keyring
Bug tracker https://github.com/lunaryorn/haskell-keyring/issues
Source repo head: git clone https://github.com/lunaryorn/haskell-keyring.git -b master
this: git clone https://github.com/lunaryorn/haskell-keyring.git(tag 0.1.0.5)
Uploaded by lunaryorn at 2017-02-20T09:46:02Z
Distributions
Reverse Dependencies 1 direct, 0 indirect [details]
Executables keyring-example
Downloads 4719 total (15 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs not available [build log]
All reported builds failed as of 2017-02-20 [all 3 reports]

Readme for keyring-0.1.0.5

[back to package description]

haskell-keyring

Unmaintained Available on Hackage License MIT Build Status

Haskell library to access the system's keyring to securely store passwords.

Supported keyring backends:

  • Keychain on OS X
  • KWallet on KDE

The library automatically chooses the appropriate backend for the current system and environment.

Installation

From Hackage:

$ cabal install keyring

Usage

See Example.hs for a complete example.

Getting passwords

import System.Keyring

main = do
  password <- getPassword (Service "my-application")
                          (Username "Joe")
  case password of
    (Just (Password pw)) ->
      putStrLn ("Your password is " ++ pw)
    Nothing ->
    putStrLn "No password found"

Setting passwords

import System.Keyring

main = setPassword (Service "my-application")
                   (Username "Joe")
                   (Password "my-secret-password")

Support

Contribute

Credits

License

Copyright (c) 2014 Sebastian Wiesner swiesner@lunaryorn.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.