Key.h File Reference

Provides BKey and BPasswordKey classes, as well as BKeyPurpose and BKeyType enums. More...

Classes
class	BKey
	Class that represents a generic key for or from the Haiku key store. More...
class	BPasswordKey
	Class that represents a password for or from the Haiku key store. More...

Enumerations
enum	BKeyPurpose {   B_KEY_PURPOSE_ANY ,   B_KEY_PURPOSE_GENERIC ,   B_KEY_PURPOSE_KEYRING ,   B_KEY_PURPOSE_WEB ,   B_KEY_PURPOSE_NETWORK ,   B_KEY_PURPOSE_VOLUME }
enum	BKeyType {   B_KEY_TYPE_ANY ,   B_KEY_TYPE_GENERIC ,   B_KEY_TYPE_PASSWORD ,   B_KEY_TYPE_CERTIFICATE }

Detailed Description

Provides BKey and BPasswordKey classes, as well as BKeyPurpose and BKeyType enums.

See the overview to the Password and Key Storage API for an introduction to the API.

Enumeration Type Documentation

BKeyPurpose

enum BKeyPurpose

Enumerator
B_KEY_PURPOSE_ANY	Query the key store for keys with any purpose. This constant does not represent a key purpose by itself, but rather is used in querying the key store where you do not know or care about the purpose of key you are looking for. Since Haiku R1
B_KEY_PURPOSE_GENERIC	Generic key purpose. This type identifies keys that are not for a specific purpose. Since Haiku R1
B_KEY_PURPOSE_KEYRING	Keyring key purpose. This is a key purpose that is internal to the keystore_server. It represents the internals of a keyring. You cannot directly access and manipulate keys with this purpose. Instead you can use the methods on BKeyStore to access keys within keyrings. Since Haiku R1
B_KEY_PURPOSE_WEB	Web key purpose. This type refers to keys that are used on the web, such as username and passwords for HTTP authentication, as well as for stored usernames and passwords for form-based authentication. Since Haiku R1
B_KEY_PURPOSE_NETWORK	Network key purpose. This type refers to keys that are used in the networking stack, such as WEP/WPA keys. Since Haiku R1
B_KEY_PURPOSE_VOLUME	Volume key purpose. This type refers to keys that are used to lock volumes, like password for encryption. Since Haiku R1

BKeyType

enum BKeyType

Enumerator
B_KEY_TYPE_ANY	Query the key store for keys of any type. This constant does not represent a key type by itself, but rather is used in querying the key store where you do not know or care about the type of key you are looking for. Since Haiku R1
B_KEY_TYPE_GENERIC	Generic key type. This constant describes the type of key that does not have any particular content or format. They are represented by the BKey class. Since Haiku R1
B_KEY_TYPE_PASSWORD	The key is a password. This key type is represented by the BPasswordKey class. Since Haiku R1
B_KEY_TYPE_CERTIFICATE	The key is a certificate. Not in use. This key type is for future expansion. It is currently not in use. Since Haiku R1