1/* 2 * Copyright 2019 Haiku, Inc. All rights reserved. 3 * Distributed under the terms of the MIT License. 4 * 5 * Authors: 6 * Niels Sascha Reedijk, niels.reedijk@gmail.com 7 * 8 * Corresponds to: 9 * headers/os/app/KeyStore.h hrev45434 10 * src/kits/app/KeyStore.cpp hrev45434 11 */ 12 13 14 /*! 15 \file KeyStore.h 16 \ingroup app 17 \ingroup libbe 18 \brief Provides BKeyStore class. 19*/ 20 21 22/*! 23 \class BKeyStore 24 \ingroup app 25 \ingroup libbe 26 \brief Undocumented 27 28 \since Haiku R1 29*/ 30 31 32/*! 33 \fn BKeyStore::BKeyStore() 34 \brief undocumented 35 36 \since Haiku R1 37*/ 38 39 40/*! 41 \fn virtual BKeyStore::~BKeyStore() 42 \brief undocumented 43 44 \since Haiku R1 45*/ 46 47/*! 48 \name Key Management 49*/ 50 51 52//! @{ 53 54 55/*! 56 \fn status_t BKeyStore::GetKey(BKeyType type, const char* identifier, 57 BKey& key) 58 \brief Undocumented 59 60 \since Haiku R1 61*/ 62 63 64/*! 65 \fn status_t BKeyStore::GetKey(BKeyType type, const char* identifier, 66 const char* secondaryIdentifier, BKey& key) 67 \brief Undocumented 68 69 \since Haiku R1 70*/ 71 72 73/*! 74 \fn status_t BKeyStore::GetKey(BKeyType type, const char* identifier, 75 const char* secondaryIdentifier, bool secondaryIdentifierOptional, 76 BKey& key) 77 \brief Undocumented 78 79 \since Haiku R1 80*/ 81 82 83/*! 84 \fn status_t BKeyStore::GetKey(const char* keyring, BKeyType type, 85 const char* identifier, BKey& key) 86 \brief Undocumented 87 88 \since Haiku R1 89*/ 90 91 92/*! 93 \fn status_t BKeyStore::GetKey(const char* keyring, BKeyType type, 94 const char* identifier, const char* secondaryIdentifier, BKey& key) 95 \brief Undocumented 96 97 \since Haiku R1 98*/ 99 100 101/*! 102 \fn status_t BKeyStore::GetKey(const char* keyring, BKeyType type, 103 const char* identifier, const char* secondaryIdentifier, 104 bool secondaryIdentifierOptional, BKey& key) 105 \brief Undocumented 106 107 \since Haiku R1 108*/ 109 110 111/*! 112 \fn status_t BKeyStore::AddKey(const BKey& key) 113 \brief Undocumented 114 115 \since Haiku R1 116*/ 117 118 119/*! 120 \fn status_t BKeyStore::AddKey(const char* keyring, const BKey& key) 121 \brief Undocumented 122 123 \since Haiku R1 124*/ 125 126 127/*! 128 \fn status_t BKeyStore::RemoveKey(const BKey& key) 129 \brief Undocumented 130 131 \since Haiku R1 132*/ 133 134 135/*! 136 \fn status_t BKeyStore::RemoveKey(const char* keyring, const BKey& key) 137 \brief Undocumented 138 139 \since Haiku R1 140*/ 141 142 143/*! 144 \fn status_t BKeyStore::GetNextKey(uint32& cookie, BKey& key); 145 \brief Undocumented 146 147 \since Haiku R1 148*/ 149 150 151/*! 152 \fn status_t BKeyStore::GetNextKey(BKeyType type, BKeyPurpose purpose, 153 uint32& cookie, BKey& key) 154 \brief Undocumented 155 156 \since Haiku R1 157*/ 158 159 160/*! 161 \fn status_t BKeyStore::GetNextKey(const char* keyring, uint32& cookie, 162 BKey& key) 163 \brief Undocumented 164 165 \since Haiku R1 166*/ 167 168 169/*! 170 \fn status_t BKeyStore::GetNextKey(const char* keyring, BKeyType type, 171 BKeyPurpose purpose, uint32& cookie, BKey& key) 172 \brief Undocumented 173 174 \since Haiku R1 175*/ 176 177 178//! @} 179 180 181/*! 182 \name Keyrings 183*/ 184 185 186//! @{ 187 188 189/*! 190 \fn status_t BKeyStore::AddKeyring(const char* keyring) 191 \brief Undocumented 192 193 \since Haiku R1 194*/ 195 196 197/*! 198 \fn status_t BKeyStore::RemoveKeyring(const char* keyring) 199 \brief Undocumented 200 201 \since Haiku R1 202*/ 203 204 205/*! 206 \fn status_t BKeyStore::GetNextKeyring(uint32& cookie, BString& keyring) 207 \brief Undocumented 208 209 \since Haiku R1 210*/ 211 212 213/*! 214 \fn status_t BKeyStore::SetUnlockKey(const char* keyring, const BKey& key) 215 \brief Undocumented 216 217 \since Haiku R1 218*/ 219 220 221/*! 222 \fn status_t BKeyStore::RemoveUnlockKey(const char* keyring) 223 \brief Undocumented 224 225 \since Haiku R1 226*/ 227 228 229//! @} 230 231 232/*! 233 \name Master keyring 234*/ 235 236 237//! @{ 238 239 240/*! 241 \fn status_t BKeyStore::SetMasterUnlockKey(const BKey& key) 242 \brief Undocumented 243 244 \since Haiku R1 245*/ 246 247 248/*! 249 \fn status_t BKeyStore::RemoveMasterUnlockKey() 250 \brief Undocumented 251 252 \since Haiku R1 253*/ 254 255 256/*! 257 \fn status_t BKeyStore::AddKeyringToMaster(const char* keyring) 258 \brief Undocumented 259 260 \since Haiku R1 261*/ 262 263 264/*! 265 \fn status_t BKeyStore::RemoveKeyringFromMaster(const char* keyring) 266 \brief Undocumented 267 268 \since Haiku R1 269*/ 270 271 272/*! 273 \fn status_t BKeyStore::GetNextMasterKeyring(uint32& cookie, 274 BString& keyring) 275 \brief Undocumented 276 277 \since Haiku R1 278*/ 279 280 281//! @} 282 283 284/*! 285 \name Locking 286*/ 287 288 289//! @{ 290 291 292/*! 293 \fn bool BKeyStore::IsKeyringUnlocked(const char* keyring) 294 \brief Undocumented 295 296 \since Haiku R1 297*/ 298 299 300/*! 301 \fn status_t BKeyStore::LockKeyring(const char* keyring) 302 \brief Undocumented 303 304 \since Haiku R1 305*/ 306 307 308/*! 309 \fn status_t BKeyStore::LockMasterKeyring() 310 \brief Undocumented 311 312 \since Haiku R1 313*/ 314 315 316//! @} 317 318 319/*! 320 \name Applications 321*/ 322 323 324//! @{ 325 326 327/*! 328 \fn status_t BKeyStore::GetNextApplication(uint32& cookie, 329 BString& signature) const 330 \brief Undocumented 331 332 \since Haiku R1 333*/ 334 335 336/*! 337 \fn status_t BKeyStore::GetNextApplication(const char* keyring, 338 uint32& cookie, BString& signature) const 339 \brief Undocumented 340 341 \since Haiku R1 342*/ 343 344 345/*! 346 \fn status_t BKeyStore::RemoveApplication(const char* signature) 347 \brief Undocumented 348 349 \since Haiku R1 350*/ 351 352 353/*! 354 \fn status_t BKeyStore::RemoveApplication(const char* keyring, 355 const char* signature) 356 \brief Undocumented 357 358 \since Haiku R1 359*/ 360 361 362//! @} 363 364 365/*! 366 \name Service Functions 367*/ 368 369 370//! @{ 371 372 373/*! 374 \fn status_t BKeyStore::GeneratePassword(BPasswordKey& password, 375 size_t length, uint32 flags) 376 \brief Undocumented 377 378 \since Haiku R1 379*/ 380 381 382/*! 383 \fn float BKeyStore::PasswordStrength(const char* password) 384 \brief Undocumented 385 386 \since Haiku R1 387*/ 388 389 390//! @} 391