1/*
2 * Copyright (c) 2002-2004,2011,2014 Apple Inc. All Rights Reserved.
3 *
4 * @APPLE_LICENSE_HEADER_START@
5 *
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. Please obtain a copy of the License at
10 * http://www.opensource.apple.com/apsl/ and read it before using this
11 * file.
12 *
13 * The Original Code and all software distributed under the License are
14 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
15 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
16 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
18 * Please see the License for the specific language governing rights and
19 * limitations under the License.
20 *
21 * @APPLE_LICENSE_HEADER_END@
22 */
23
24/*
25 * ExtendedAttribute.h - Extended Keychain Item Attribute class.
26 *
27 */
28
29#ifndef _SECURITY_EXTENDED_ATTRIBUTE_H_
30#define _SECURITY_EXTENDED_ATTRIBUTE_H_
31
32#include <security_keychain/Item.h>
33#include <security_cdsa_utilities/cssmdata.h>
34
35/* this is not public */
36typedef struct OpaqueSecExtendedAttributeRef *SecKeychainItemExtendedAttributeRef;
37
38namespace Security
39{
40
41namespace KeychainCore
42{
43
44class ExtendedAttribute : public ItemImpl
45{
46	NOCOPY(ExtendedAttribute)
47public:
48	SECCFFUNCTIONS(ExtendedAttribute, SecKeychainItemExtendedAttributeRef,
49		errSecInvalidItemRef, gTypes().ExtendedAttribute)
50
51	/* construct new ExtendedAttr from API */
52	ExtendedAttribute(CSSM_DB_RECORDTYPE recordType,
53		const CssmData &itemID,
54		const CssmData attrName,
55		const CssmData attrValue);
56
57private:
58	// db item contstructor
59    ExtendedAttribute(const Keychain &keychain,
60		const PrimaryKey &primaryKey,
61		const CssmClient::DbUniqueRecord &uniqueId);
62
63	// PrimaryKey item contstructor
64    ExtendedAttribute(const Keychain &keychain, const PrimaryKey &primaryKey);
65
66public:
67	static ExtendedAttribute* make(const Keychain &keychain, const PrimaryKey &primaryKey, const CssmClient::DbUniqueRecord &uniqueId);
68	static ExtendedAttribute* make(const Keychain &keychain, const PrimaryKey &primaryKey);
69
70	ExtendedAttribute(ExtendedAttribute &extendedAttribute);
71
72    virtual ~ExtendedAttribute() throw();
73
74	virtual PrimaryKey add(Keychain &keychain);
75	bool operator == (const ExtendedAttribute &other) const;
76private:
77	/* set up DB attrs based on member vars */
78	void setupAttrs();
79
80	CSSM_DB_RECORDTYPE		mRecordType;
81	CssmAutoData			mItemID;
82	CssmAutoData			mAttrName;
83	CssmAutoData			mAttrValue;
84};
85
86} // end namespace KeychainCore
87
88} // end namespace Security
89
90#endif /* _SECURITY_EXTENDED_ATTRIBUTES_H_ */
91