OSXKeychain Class Reference

#include <qosxkeychain.h>

Inherited by KWallet::Wallet::WalletPrivate.

Public Types
enum	EntryType { Unknown ='K\?\?\?', Password ='KPWD', Map ='KMAP', Stream ='KSTR' }

Public Member Functions
	OSXKeychain ()
	OSXKeychain (const QString &name)
virtual	~OSXKeychain ()
void	close ()
QStringList	folderList ()
bool	hasItem (const QString &key, OSStatus *errReturn, SecKeychainItemRef *itemRef=NULL)
bool	isDefault ()
bool	isOpen ()
OSStatus	itemList (QStringList &keyList)
OSStatus	itemType (const QString &key, EntryType *entryType)
OSStatus	lock ()
QString &	path ()
OSStatus	readItem (const QString &key, QByteArray *value, SecKeychainItemRef *itemRef=NULL)
SecKeychainRef	reference ()
OSStatus	removeItem (const QString &key)
OSStatus	renameItem (const QString &currentKey, const QString &newKey)
OSStatus	unLock ()
OSStatus	writeItem (const QString &key, const QByteArray &value, EntryType *entryType=NULL)
OSStatus	writeItem (const QString &key, const QByteArray &value, const QString &comment, EntryType *entryType=NULL)

Static Public Member Functions
static OSStatus	Destroy (SecKeychainRef *keychain)
static OSStatus	Destroy (const QString &walletName)
static bool	HasItem (const QString &key, const SecKeychainRef keychain, OSStatus *errReturn, SecKeychainItemRef *itemRef)
static bool	IsOpen (const SecKeychainRef keychain)
static bool	IsOpen (const QString &name)
static OSStatus	ItemList (const SecKeychainRef keychain, QStringList &keyList, OSXKeychain *osxKeyChain=NULL)
static OSStatus	ItemType (const QString &key, EntryType *entryType, const SecKeychainRef keychain)
static OSStatus	KeychainList (QStringList &theList)
static OSStatus	Lock (const SecKeychainRef keychain)
static OSStatus	Lock (const QString &walletName)
static QString	Path (const SecKeychainRef keychain)
static OSStatus	ReadItem (const QString &key, QByteArray *value, const SecKeychainRef keychain, SecKeychainItemRef *itemRef=NULL, OSXKeychain *osxKeyChain=NULL)
static OSStatus	RemoveItem (const QString &key, const SecKeychainRef keychain)
static OSStatus	UnLock (const SecKeychainRef keychain)
static OSStatus	WriteItem (const QString &key, const QByteArray &value, const SecKeychainRef keychain, SecKeychainItemRef *itemRef=NULL, EntryType *entryType=NULL, OSXKeychain *osxKeyChain=NULL)
static OSStatus	WriteItem (const QString &key, const QByteArray &value, const QString &comment, const SecKeychainRef keychain, EntryType *entryType, OSXKeychain *osxKeyChain=NULL)

Public Attributes
QString	currentService
bool	isKDEChain
QString	lastReadService
QString	name
QStringList	serviceList

Detailed Description

Definition at line 90 of file qosxkeychain.h.

Member Enumeration Documentation

enum OSXKeychain::EntryType

Enumerator
Unknown
Password
Map
Stream

Definition at line 98 of file qosxkeychain.h.

Constructor & Destructor Documentation

OSXKeychain::OSXKeychain

(

)

Definition at line 147 of file qosxkeychain.cpp.

OSXKeychain::OSXKeychain

(

const QString &

name

)

Definition at line 164 of file qosxkeychain.cpp.

OSXKeychain::~OSXKeychain ( )

virtual

Definition at line 205 of file qosxkeychain.cpp.

Member Function Documentation

void OSXKeychain::close

(

)

Definition at line 197 of file qosxkeychain.cpp.

OSStatus OSXKeychain::Destroy ( SecKeychainRef *  keychain )

static

Definition at line 700 of file qosxkeychain.cpp.

OSStatus OSXKeychain::Destroy ( const QString &  walletName )

static

Definition at line 716 of file qosxkeychain.cpp.

QStringList OSXKeychain::folderList ( )

inline

Definition at line 163 of file qosxkeychain.h.

bool OSXKeychain::hasItem ( const QString &  key, OSStatus *  errReturn, SecKeychainItemRef *  itemRef = NULL  )

inline

Definition at line 133 of file qosxkeychain.h.

bool OSXKeychain::HasItem ( const QString &  key, const SecKeychainRef  keychain, OSStatus *  errReturn, SecKeychainItemRef *  itemRef  )

static

use the keychain search functions to find the first matching item, if any, returning True if found.

use the keychain search functions to find the first matching item, if any,

The OS X error code is returned through errReturn when not NULL, the item itself through itemRef. This reference will have to be released with CFRelease() when done with it (when itemRef==NULL the function does this release itself).

Returns

returning True if found. The OS X error code is returned through errReturn when not NULL, the item itself through itemRef. This reference will have to be released with CFRelease() when done with it (when itemRef==NULL the function does this release itself).

Definition at line 343 of file qosxkeychain.cpp.

bool OSXKeychain::isDefault ( )

inline

Definition at line 116 of file qosxkeychain.h.

bool OSXKeychain::isOpen ( )

inline

Definition at line 120 of file qosxkeychain.h.

bool OSXKeychain::IsOpen ( const SecKeychainRef  keychain )

static

Definition at line 261 of file qosxkeychain.cpp.

bool OSXKeychain::IsOpen ( const QString &  name )

static

Definition at line 284 of file qosxkeychain.cpp.

OSStatus OSXKeychain::itemList ( QStringList &  keyList )

inline

Definition at line 159 of file qosxkeychain.h.

OSStatus OSXKeychain::ItemList ( const SecKeychainRef  keychain, QStringList &  keyList, OSXKeychain *  osxKeyChain = NULL  )

static

Definition at line 613 of file qosxkeychain.cpp.

OSStatus OSXKeychain::itemType ( const QString &  key, EntryType *  entryType  )

inline

Definition at line 142 of file qosxkeychain.h.

OSStatus OSXKeychain::ItemType ( const QString &  key, EntryType *  entryType, const SecKeychainRef  keychain  )

static

Definition at line 443 of file qosxkeychain.cpp.

OSStatus OSXKeychain::KeychainList ( QStringList &  theList )

static

Definition at line 232 of file qosxkeychain.cpp.

OSStatus OSXKeychain::lock ( )

inline

Definition at line 124 of file qosxkeychain.h.

OSStatus OSXKeychain::Lock ( const SecKeychainRef  keychain )

static

Definition at line 310 of file qosxkeychain.cpp.

OSStatus OSXKeychain::Lock ( const QString &  walletName )

static

Definition at line 328 of file qosxkeychain.cpp.

QString& OSXKeychain::path ( )

inline

Definition at line 112 of file qosxkeychain.h.

QString OSXKeychain::Path ( const SecKeychainRef  keychain )

static

Definition at line 250 of file qosxkeychain.cpp.

OSStatus OSXKeychain::readItem ( const QString &  key, QByteArray *  value, SecKeychainItemRef *  itemRef = NULL  )

inline

Definition at line 138 of file qosxkeychain.h.

OSStatus OSXKeychain::ReadItem ( const QString &  key, QByteArray *  value, const SecKeychainRef  keychain, SecKeychainItemRef *  itemRef = NULL, OSXKeychain *  osxKeyChain = NULL  )

static

Definition at line 384 of file qosxkeychain.cpp.

SecKeychainRef OSXKeychain::reference ( )

inline

Definition at line 108 of file qosxkeychain.h.

OSStatus OSXKeychain::removeItem ( const QString &  key )

inline

Definition at line 146 of file qosxkeychain.h.

OSStatus OSXKeychain::RemoveItem ( const QString &  key, const SecKeychainRef  keychain  )

static

Definition at line 506 of file qosxkeychain.cpp.

OSStatus OSXKeychain::renameItem	(	const QString &	currentKey,
		const QString &	newKey
	)

Definition at line 210 of file qosxkeychain.cpp.

OSStatus OSXKeychain::unLock ( )

inline

Definition at line 128 of file qosxkeychain.h.

OSStatus OSXKeychain::UnLock ( const SecKeychainRef  keychain )

static

Definition at line 295 of file qosxkeychain.cpp.

OSStatus OSXKeychain::writeItem ( const QString &  key, const QByteArray &  value, EntryType *  entryType = NULL  )

inline

Definition at line 150 of file qosxkeychain.h.

OSStatus OSXKeychain::writeItem ( const QString &  key, const QByteArray &  value, const QString &  comment, EntryType *  entryType = NULL  )

inline

Definition at line 154 of file qosxkeychain.h.

OSStatus OSXKeychain::WriteItem ( const QString &  key, const QByteArray &  value, const SecKeychainRef  keychain, SecKeychainItemRef *  itemRef = NULL, EntryType *  entryType = NULL, OSXKeychain *  osxKeyChain = NULL  )

static

Definition at line 525 of file qosxkeychain.cpp.

OSStatus OSXKeychain::WriteItem ( const QString &  key, const QByteArray &  value, const QString &  comment, const SecKeychainRef  keychain, EntryType *  entryType, OSXKeychain *  osxKeyChain = NULL  )

static

Definition at line 592 of file qosxkeychain.cpp.

Member Data Documentation

QString OSXKeychain::currentService

Definition at line 100 of file qosxkeychain.h.

bool OSXKeychain::isKDEChain

Definition at line 102 of file qosxkeychain.h.

QString OSXKeychain::lastReadService

Definition at line 100 of file qosxkeychain.h.

QString OSXKeychain::name

Definition at line 99 of file qosxkeychain.h.

QStringList OSXKeychain::serviceList

Definition at line 101 of file qosxkeychain.h.

---

The documentation for this class was generated from the following files:

• qosxkeychain.h
• qosxkeychain.cpp