xref: /haiku/headers/os/app/KeyStore.h (revision dc1acef865f290e8d565f078fc78be69991b5c10)

/*
 * Copyright 2011, Haiku, Inc.
 * Distributed under the terms of the MIT License.
 */
#ifndef _KEY_STORE_H
#define _KEY_STORE_H


#include <Key.h>


class BKeyStore {
public:
								BKeyStore();
	virtual						~BKeyStore();

// TODO: -> GetNextPassword() - there can always be more than one key
// with the same identifier/secondaryIdentifier (ie. different username)
			status_t			GetKey(BKeyType type, BKeyPurpose purpose,
									const char* identifier, BKey& key);
			status_t			GetKey(BKeyType type, BKeyPurpose purpose,
									const char* identifier,
									const char* secondaryIdentifier, BKey& key);
			status_t			GetKey(BKeyType type, BKeyPurpose purpose,
									const char* identifier,
									const char* secondaryIdentifier,
									bool secondaryIdentifierOptional,
									BKey& key);

			status_t			GetKey(const char* keyring,
									BKeyType type, BKeyPurpose purpose,
									const char* identifier, BKey& key);
			status_t			GetKey(const char* keyring,
									BKeyType type, BKeyPurpose purpose,
									const char* identifier,
									const char* secondaryIdentifier, BKey& key);
			status_t			GetKey(const char* keyring,
									BKeyType type, BKeyPurpose purpose,
									const char* identifier,
									const char* secondaryIdentifier,
									bool secondaryIdentifierOptional,
									BKey& key);

			status_t			RegisterKey(const BKey& key);
			status_t			RegisterKey(const char* keyring,
									const BKey& key);
			status_t			UnregisterKey(const BKey& key);
			status_t			UnregisterKey(const char* keyring,
									const BKey& key);

			status_t			GetNextKey(uint32& cookie, BKey& key);
			status_t			GetNextKey(BKeyType type, BKeyPurpose purpose,
									uint32& cookie, BKey& key);
			status_t			GetNextKey(const char* keyring,
									uint32& cookie, BKey& key);
			status_t			GetNextKey(const char* keyring,
									BKeyType type, BKeyPurpose purpose,
									uint32& cookie, BKey& key);

			// Keyrings

			status_t			RegisterKeyring(const char* keyring,
									const BKey& key);
			status_t			UnregisterKeyring(const char* keyring);

			status_t			GetNextKeyring(uint32& cookie,
									BString& keyring);

			// Master key

			status_t			SetMasterKey(const BKey& key);
			status_t			RemoveMasterKey();

			status_t			AddKeyringToMaster(const char* keyring);
			status_t			RemoveKeyringFromMaster(const char* keyring);

			status_t			GetNextMasterKeyring(uint32& cookie,
									BString& keyring);

			// Access

			bool				IsKeyringAccessible(const char* keyring);
			status_t			RevokeAccess(const char* keyring);
			status_t			RevokeMasterAccess();

			// Applications

			status_t			GetNextApplication(const BKey& key,
									uint32& cookie, BString& signature) const;
			status_t			RemoveApplication(const BKey& key,
									const char* signature);

			// Service functions

			status_t			GeneratePassword(BPasswordKey& password,
									size_t length, uint32 flags);
			float				PasswordStrength(const char* password);
};


#endif	// _KEY_STORE_H