1/*
2 * Copyright (c) 2004 Apple Computer, 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#ifndef _H_TOKENKEY
24#define _H_TOKENKEY
25
26
27//
28// tokenkey - remote reference key on an attached hardware token
29//
30#include "key.h"
31#include "tokenacl.h"
32
33class TokenDatabase;
34
35
36//
37// The token-specific instance of a Key
38//
39class TokenKey : public Key, public TokenAcl {
40public:
41	TokenKey(TokenDatabase &db, KeyHandle hKey, const CssmKey::Header &hdr);
42	~TokenKey();
43
44	TokenDatabase &database() const;
45	Token &token();
46	const CssmKey::Header &header() const { return mHeader; }
47	KeyHandle tokenHandle() const;
48
49	CSSM_KEYATTR_FLAGS attributes();
50	void returnKey(Handle &h, CssmKey::Header &hdr);
51	const CssmData &canonicalDigest();
52
53	SecurityServerAcl &acl();
54	Database *relatedDatabase();
55
56public:
57	// SecurityServerAcl personality
58	AclKind aclKind() const;
59
60private:
61	KeyHandle mKey;			// tokend reference handle
62	CssmKey::Header mHeader; // key header as maintained by tokend
63};
64
65#endif //_H_TOKENKEY
66