System.CredentialStore

Cross-platform library to access system-specific credential store.

Uses Windows CredReadCredWriteCredDelete API on Windows, DBus Secret Store API with gnome-keyring or kwallet as backends on Unix. MacOS is not supported yet.

Example usage:

withCredentialStore $ store -> do
    putCredential store credentialName credentialValue
    v <- getCredential store credentialName
    deleteCredential store credentialName

Types

data CredentialStore

Abstract context for credential store communications.

Functions

getCredential :: ByteArray ba => CredentialStore -> String -> IO (Maybe ba)

Read named credential from store. Returns Nothing if credential was not found.

putCredential :: ByteArray ba => CredentialStore -> String -> ba -> IO ()

Write named credential to store, overwriting existing one.

deleteCredential :: CredentialStore -> String -> IO ()

Delete named credential from store.

withCredentialStore :: (CredentialStore -> IO a) -> IO a

Open credential store and execute function passing it as parameter. Store is closed even in presence of exceptions.