1/*
2 * Copyright (c) 2000-2004,2006,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//
26// acl_prompted - password-based validation with out-of-band prompting.
27//
28// This implements simple password-based subject types with out-of-band
29// prompting (via SecurityAgent), somewhat as per the CSSM standard.
30//
31#ifndef _ACL_PROMPTED
32#define _ACL_PROMPTED
33
34#include <security_cdsa_utilities/acl_secret.h>
35
36
37namespace Security {
38
39
40//
41// A PromptedAclSubject obtains its sample by prompting the user interactively
42// through some prompting mechanism defined in the environment.
43//
44class PromptedAclSubject : public SecretAclSubject {
45public:
46    CssmList toList(Allocator &alloc) const;
47
48    PromptedAclSubject(Allocator &alloc,
49		const CssmData &prompt, const CssmData &password);
50    PromptedAclSubject(Allocator &alloc,
51		CssmManagedData &prompt, CssmManagedData &password);
52	PromptedAclSubject(Allocator &alloc, const CssmData &prompt, bool cache = false);
53
54    void exportBlob(Writer::Counter &pub, Writer::Counter &priv);
55    void exportBlob(Writer &pub, Writer &priv);
56
57	IFDUMP(void debugDump() const);
58
59public:
60	class Environment : virtual public AclValidationEnvironment {
61	public:
62		virtual bool getSecret(CssmOwnedData &secret,
63			const CssmData &prompt) const = 0;
64	};
65
66public:
67    class Maker : public SecretAclSubject::Maker {
68    public:
69    	Maker() : SecretAclSubject::Maker(CSSM_ACL_SUBJECT_TYPE_PROMPTED_PASSWORD) { }
70    	PromptedAclSubject *make(const TypedList &list) const;
71    	PromptedAclSubject *make(Version, Reader &pub, Reader &priv) const;
72    };
73
74protected:
75	bool getSecret(const AclValidationContext &context,
76		const TypedList &subject, CssmOwnedData &secret) const;
77
78private:
79	CssmAutoData mPrompt;		// transparently handled prompt data
80};
81
82} // end namespace Security
83
84
85#endif //_ACL_PROMPTED
86