]> git.saurik.com Git - apple/security.git/blob - securityd/src/agentquery.cpp
afacd8b3ce09d2a2e75b7c4c8c6060cbc2e5bb15
[apple/security.git] / securityd / src / agentquery.cpp
1 /*
2 * Copyright (c) 2000-2015 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 // passphrases - canonical code to obtain passphrases
26 //
27 #define __STDC_WANT_LIB_EXT1__ 1
28 #include <string.h>
29
30 #include "agentquery.h"
31 #include "ccaudit_extensions.h"
32
33 #include <Security/AuthorizationTags.h>
34 #include <Security/AuthorizationTagsPriv.h>
35 #include <Security/checkpw.h>
36 #include <Security/Security.h>
37 #include <System/sys/fileport.h>
38 #include <bsm/audit.h>
39 #include <bsm/audit_uevents.h> // AUE_ssauthint
40 #include <membership.h>
41 #include <membershipPriv.h>
42 #include <security_utilities/logging.h>
43 #include <security_utilities/mach++.h>
44 #include <stdlib.h>
45 #include <xpc/xpc.h>
46 #include <xpc/private.h>
47 #include "securityd_service/securityd_service/securityd_service_client.h"
48
49 // Includes for <rdar://problem/34677969> Always require the user's password on keychain approval dialogs
50 #include "server.h"
51
52 #define SECURITYAGENT_BOOTSTRAP_NAME_BASE "com.apple.security.agent"
53 #define SECURITYAGENT_LOGINWINDOW_BOOTSTRAP_NAME_BASE "com.apple.security.agent.login"
54
55 #define AUTH_XPC_ITEM_NAME "_item_name"
56 #define AUTH_XPC_ITEM_FLAGS "_item_flags"
57 #define AUTH_XPC_ITEM_VALUE "_item_value"
58 #define AUTH_XPC_ITEM_TYPE "_item_type"
59 #define AUTH_XPC_ITEM_SENSITIVE_VALUE_LENGTH "_item_sensitive_value_length"
60
61 #define AUTH_XPC_REQUEST_METHOD_KEY "_agent_request_key"
62 #define AUTH_XPC_REQUEST_METHOD_CREATE "_agent_request_create"
63 #define AUTH_XPC_REQUEST_METHOD_INVOKE "_agent_request_invoke"
64 #define AUTH_XPC_REQUEST_METHOD_DEACTIVATE "_agent_request_deactivate"
65 #define AUTH_XPC_REQUEST_METHOD_DESTROY "_agent_request_destroy"
66 #define AUTH_XPC_REPLY_METHOD_KEY "_agent_reply_key"
67 #define AUTH_XPC_REPLY_METHOD_RESULT "_agent_reply_result"
68 #define AUTH_XPC_REPLY_METHOD_INTERRUPT "_agent_reply_interrupt"
69 #define AUTH_XPC_REPLY_METHOD_CREATE "_agent_reply_create"
70 #define AUTH_XPC_REPLY_METHOD_DEACTIVATE "_agent_reply_deactivate"
71 #define AUTH_XPC_PLUGIN_NAME "_agent_plugin"
72 #define AUTH_XPC_MECHANISM_NAME "_agent_mechanism"
73 #define AUTH_XPC_HINTS_NAME "_agent_hints"
74 #define AUTH_XPC_CONTEXT_NAME "_agent_context"
75 #define AUTH_XPC_IMMUTABLE_HINTS_NAME "_agent_immutable_hints"
76 #define AUTH_XPC_REQUEST_INSTANCE "_agent_instance"
77 #define AUTH_XPC_REPLY_RESULT_VALUE "_agent_reply_result_value"
78 #define AUTH_XPC_AUDIT_SESSION_PORT "_agent_audit_session_port"
79 #define AUTH_XPC_BOOTSTRAP_PORT "_agent_bootstrap_port"
80
81 #define UUID_INITIALIZER_FROM_SESSIONID(sessionid) \
82 { 0,0,0,0, 0,0,0,0, 0,0,0,0, (unsigned char)((0xff000000 & (sessionid))>>24), (unsigned char)((0x00ff0000 & (sessionid))>>16), (unsigned char)((0x0000ff00 & (sessionid))>>8), (unsigned char)((0x000000ff & (sessionid))) }
83
84
85 // SecurityAgentXPCConnection
86
87 SecurityAgentXPCConnection::SecurityAgentXPCConnection(Session &session)
88 : mHostInstance(session.authhost()),
89 mSession(session),
90 mConnection(&Server::connection()),
91 mAuditToken(Server::connection().auditToken())
92 {
93 // this may take a while
94 Server::active().longTermActivity();
95 secnotice("SecurityAgentConnection", "new SecurityAgentConnection(%p)", this);
96 mXPCConnection = NULL;
97 mNobodyUID = -2;
98 struct passwd *pw = getpwnam("nobody");
99 if (NULL != pw) {
100 mNobodyUID = pw->pw_uid;
101 }
102 }
103
104 SecurityAgentXPCConnection::~SecurityAgentXPCConnection()
105 {
106 secnotice("SecurityAgentConnection", "SecurityAgentConnection(%p) dying", this);
107 mConnection->useAgent(NULL);
108
109 // If a connection has been established, we need to tear it down.
110 if (NULL != mXPCConnection) {
111 // Tearing this down is a multi-step process. First, request a cancellation.
112 // This is safe even if the connection is already in the canceled state.
113 xpc_connection_cancel(mXPCConnection);
114
115 // Then release the XPC connection
116 xpc_release(mXPCConnection);
117 mXPCConnection = NULL;
118 }
119 }
120
121 bool SecurityAgentXPCConnection::inDarkWake()
122 {
123 return mSession.server().inDarkWake();
124 }
125
126 void
127 SecurityAgentXPCConnection::activate(bool ignoreUid)
128 {
129 secnotice("SecurityAgentConnection", "activate(%p)", this);
130
131 mConnection->useAgent(this);
132 if (mXPCConnection != NULL) {
133 // If we already have an XPC connection, there's nothing to do.
134 return;
135 }
136
137 try {
138 uuid_t sessionUUID = UUID_INITIALIZER_FROM_SESSIONID(mSession.sessionId());
139
140 // Yes, these need to be throws, as we're still in securityd, and thus still have to do flow control with exceptions.
141 if (!(mSession.attributes() & sessionHasGraphicAccess))
142 CssmError::throwMe(CSSM_ERRCODE_NO_USER_INTERACTION);
143 if (inDarkWake())
144 CssmError::throwMe(CSSM_ERRCODE_IN_DARK_WAKE);
145 uid_t targetUid = mHostInstance->session().originatorUid();
146
147 secnotice("SecurityAgentXPCConnection","Retrieved UID %d for this session", targetUid);
148 if (!ignoreUid && targetUid != 0 && targetUid != mNobodyUID) {
149 mXPCConnection = xpc_connection_create_mach_service(SECURITYAGENT_BOOTSTRAP_NAME_BASE, NULL, 0);
150 xpc_connection_set_target_uid(mXPCConnection, targetUid);
151 secnotice("SecurityAgentXPCConnection", "Creating a standard security agent");
152 } else {
153 mXPCConnection = xpc_connection_create_mach_service(SECURITYAGENT_LOGINWINDOW_BOOTSTRAP_NAME_BASE, NULL, 0);
154 xpc_connection_set_instance(mXPCConnection, sessionUUID);
155 secnotice("SecurityAgentXPCConnection", "Creating a loginwindow security agent");
156 }
157
158 xpc_connection_set_event_handler(mXPCConnection, ^(xpc_object_t object) {
159 if (xpc_get_type(object) == XPC_TYPE_ERROR) {
160 secnotice("SecurityAgentXPCConnection", "error during xpc: %s", xpc_dictionary_get_string(object, XPC_ERROR_KEY_DESCRIPTION));
161 }
162 });
163 xpc_connection_resume(mXPCConnection);
164 secnotice("SecurityAgentXPCConnection", "%p activated", this);
165 }
166 catch (MacOSError &err) {
167 mConnection->useAgent(NULL); // guess not
168 Syslog::error("SecurityAgentConnection: error activating SecurityAgent instance %p", this);
169 throw;
170 }
171
172 secnotice("SecurityAgentXPCConnection", "contact didn't throw (%p)", this);
173 }
174
175 void
176 SecurityAgentXPCConnection::terminate()
177 {
178 activate(false);
179
180 // @@@ This happens already in the destructor; presumably we do this to tear things down orderly
181 mConnection->useAgent(NULL);
182 }
183
184
185 using SecurityAgent::Reason;
186 using namespace Authorization;
187
188 ModuleNexus<RecursiveMutex> gAllXPCClientsMutex;
189 ModuleNexus<set<SecurityAgentXPCQuery*> > allXPCClients;
190
191 void
192 SecurityAgentXPCQuery::killAllXPCClients()
193 {
194 // grab the lock for the client list -- we need to make sure no one modifies the structure while we are iterating it.
195 StLock<Mutex> _(gAllXPCClientsMutex());
196
197 set<SecurityAgentXPCQuery*>::iterator clientIterator = allXPCClients().begin();
198 while (clientIterator != allXPCClients().end())
199 {
200 set<SecurityAgentXPCQuery*>::iterator thisClient = clientIterator++;
201 if ((*thisClient)->getTerminateOnSleep())
202 {
203 (*thisClient)->terminate();
204 }
205 }
206 }
207
208
209 SecurityAgentXPCQuery::SecurityAgentXPCQuery(Session &session)
210 : SecurityAgentXPCConnection(session), mAgentConnected(false), mTerminateOnSleep(false)
211 {
212 secnotice("SecurityAgentXPCQuery", "new SecurityAgentXPCQuery(%p)", this);
213 }
214
215 SecurityAgentXPCQuery::~SecurityAgentXPCQuery()
216 {
217 secnotice("SecurityAgentXPCQuery", "SecurityAgentXPCQuery(%p) dying", this);
218 if (mAgentConnected) {
219 this->disconnect();
220 }
221 }
222
223 void
224 SecurityAgentXPCQuery::inferHints(Process &thisProcess)
225 {
226 AuthItemSet clientHints;
227 SecurityAgent::RequestorType type = SecurityAgent::bundle;
228 pid_t clientPid = thisProcess.pid();
229 uid_t clientUid = thisProcess.uid();
230 string guestPath = thisProcess.getPath();
231 Boolean ignoreSession = TRUE;
232
233 clientHints.insert(AuthItemRef(AGENT_HINT_CLIENT_TYPE, AuthValueOverlay(sizeof(type), &type)));
234 clientHints.insert(AuthItemRef(AGENT_HINT_CLIENT_PATH, AuthValueOverlay(guestPath)));
235 clientHints.insert(AuthItemRef(AGENT_HINT_CLIENT_PID, AuthValueOverlay(sizeof(clientPid), &clientPid)));
236 clientHints.insert(AuthItemRef(AGENT_HINT_CLIENT_UID, AuthValueOverlay(sizeof(clientUid), &clientUid)));
237
238 /*
239 * If its loginwindow that's asking, override the loginwindow shield detection
240 * up front so that it can trigger SecurityAgent dialogs (like password change)
241 * for when the OD password and keychain password is out of sync.
242 */
243
244 if (guestPath == "/System/Library/CoreServices/loginwindow.app") {
245 clientHints.insert(AuthItemRef(AGENT_HINT_IGNORE_SESSION, AuthValueOverlay(sizeof(ignoreSession), &ignoreSession)));
246 }
247
248 mClientHints.insert(clientHints.begin(), clientHints.end());
249
250 bool validSignature = thisProcess.checkAppleSigned();
251 AuthItemSet clientImmutableHints;
252
253 clientImmutableHints.insert(AuthItemRef(AGENT_HINT_CLIENT_SIGNED, AuthValueOverlay(sizeof(validSignature), &validSignature)));
254
255 mImmutableHints.insert(clientImmutableHints.begin(), clientImmutableHints.end());
256 }
257
258 void SecurityAgentXPCQuery::addHint(const char *name, const void *value, UInt32 valueLen, UInt32 flags)
259 {
260 AuthorizationItem item = { name, valueLen, const_cast<void *>(value), flags };
261 mClientHints.insert(AuthItemRef(item));
262 }
263
264
265 void
266 SecurityAgentXPCQuery::readChoice()
267 {
268 allow = false;
269 remember = false;
270
271 AuthItem *allowAction = mOutContext.find(AGENT_CONTEXT_ALLOW);
272 if (allowAction)
273 {
274 string allowString;
275 if (allowAction->getString(allowString)
276 && (allowString == "YES"))
277 allow = true;
278 }
279
280 AuthItem *rememberAction = mOutContext.find(AGENT_CONTEXT_REMEMBER_ACTION);
281 if (rememberAction)
282 {
283 string rememberString;
284 if (rememberAction->getString(rememberString)
285 && (rememberString == "YES"))
286 remember = true;
287 }
288 }
289
290 void
291 SecurityAgentXPCQuery::disconnect()
292 {
293 if (NULL != mXPCConnection) {
294 xpc_object_t requestObject = xpc_dictionary_create(NULL, NULL, 0);
295 xpc_dictionary_set_string(requestObject, AUTH_XPC_REQUEST_METHOD_KEY, AUTH_XPC_REQUEST_METHOD_DESTROY);
296 xpc_connection_send_message(mXPCConnection, requestObject);
297 xpc_release(requestObject);
298 }
299
300 StLock<Mutex> _(gAllXPCClientsMutex());
301 allXPCClients().erase(this);
302 }
303
304 void
305 SecurityAgentXPCQuery::terminate()
306 {
307 this->disconnect();
308 }
309
310 static void xpcArrayToAuthItemSet(AuthItemSet *setToBuild, xpc_object_t input) {
311 setToBuild->clear();
312
313 xpc_array_apply(input, ^bool(size_t index, xpc_object_t item) {
314 const char *name = xpc_dictionary_get_string(item, AUTH_XPC_ITEM_NAME);
315
316 size_t length;
317 const void *data = xpc_dictionary_get_data(item, AUTH_XPC_ITEM_VALUE, &length);
318 void *dataCopy = 0;
319
320 // <rdar://problem/13033889> authd is holding on to multiple copies of my password in the clear
321 bool sensitive = xpc_dictionary_get_value(item, AUTH_XPC_ITEM_SENSITIVE_VALUE_LENGTH);
322 if (sensitive) {
323 size_t sensitiveLength = (size_t)xpc_dictionary_get_uint64(item, AUTH_XPC_ITEM_SENSITIVE_VALUE_LENGTH);
324 dataCopy = malloc(sensitiveLength);
325 memcpy(dataCopy, data, sensitiveLength);
326 memset_s((void *)data, length, 0, sensitiveLength); // clear the sensitive data, memset_s is never optimized away
327 length = sensitiveLength;
328 } else {
329 dataCopy = malloc(length);
330 memcpy(dataCopy, data, length);
331 }
332
333 uint64_t flags = xpc_dictionary_get_uint64(item, AUTH_XPC_ITEM_FLAGS);
334 AuthItemRef nextItem(name, AuthValueOverlay((uint32_t)length, dataCopy), (uint32_t)flags);
335 setToBuild->insert(nextItem);
336 memset(dataCopy, 0, length); // The authorization items contain things like passwords, so wiping clean is important.
337 free(dataCopy);
338 return true;
339 });
340 }
341
342 void
343 SecurityAgentXPCQuery::create(const char *pluginId, const char *mechanismId)
344 {
345 bool ignoreUid = false;
346
347 do {
348 activate(ignoreUid);
349
350 mAgentConnected = false;
351
352 xpc_object_t requestObject = xpc_dictionary_create(NULL, NULL, 0);
353 xpc_dictionary_set_string(requestObject, AUTH_XPC_REQUEST_METHOD_KEY, AUTH_XPC_REQUEST_METHOD_CREATE);
354 xpc_dictionary_set_string(requestObject, AUTH_XPC_PLUGIN_NAME, pluginId);
355 xpc_dictionary_set_string(requestObject, AUTH_XPC_MECHANISM_NAME, mechanismId);
356
357 uid_t targetUid = Server::process().uid();
358 bool doSwitchAudit = (ignoreUid || targetUid == 0 || targetUid == mNobodyUID);
359 bool doSwitchBootstrap = (ignoreUid || targetUid == 0 || targetUid == mNobodyUID);
360
361 if (doSwitchAudit) {
362 mach_port_name_t jobPort;
363 if (0 == audit_session_port(mSession.sessionId(), &jobPort)) {
364 secnotice("SecurityAgentXPCQuery", "attaching an audit session port because the uid was %d", targetUid);
365 xpc_dictionary_set_mach_send(requestObject, AUTH_XPC_AUDIT_SESSION_PORT, jobPort);
366 if (mach_port_mod_refs(mach_task_self(), jobPort, MACH_PORT_RIGHT_SEND, -1) != KERN_SUCCESS) {
367 secnotice("SecurityAgentXPCQuery", "unable to release send right for audit session, leaking");
368 }
369 }
370 }
371
372 if (doSwitchBootstrap) {
373 secnotice("SecurityAgentXPCQuery", "attaching a bootstrap port because the uid was %d", targetUid);
374 MachPlusPlus::Bootstrap processBootstrap = Server::process().taskPort().bootstrap();
375 xpc_dictionary_set_mach_send(requestObject, AUTH_XPC_BOOTSTRAP_PORT, processBootstrap);
376 }
377
378 xpc_object_t object = xpc_connection_send_message_with_reply_sync(mXPCConnection, requestObject);
379 if (xpc_get_type(object) == XPC_TYPE_DICTIONARY) {
380 const char *replyType = xpc_dictionary_get_string(object, AUTH_XPC_REPLY_METHOD_KEY);
381 if (0 == strcmp(replyType, AUTH_XPC_REPLY_METHOD_CREATE)) {
382 uint64_t status = xpc_dictionary_get_uint64(object, AUTH_XPC_REPLY_RESULT_VALUE);
383 if (status == kAuthorizationResultAllow) {
384 mAgentConnected = true;
385 } else {
386 secnotice("SecurityAgentXPCQuery", "plugin create failed in SecurityAgent");
387 MacOSError::throwMe(errAuthorizationInternal);
388 }
389 }
390 } else if (xpc_get_type(object) == XPC_TYPE_ERROR) {
391 if (XPC_ERROR_CONNECTION_INVALID == object) {
392 // If we get an error before getting the create response, try again without the UID
393 if (ignoreUid) {
394 secnotice("SecurityAgentXPCQuery", "failed to establish connection, no retries left");
395 xpc_release(object);
396 MacOSError::throwMe(errAuthorizationInternal);
397 } else {
398 secnotice("SecurityAgentXPCQuery", "failed to establish connection, retrying with no UID");
399 ignoreUid = true;
400 xpc_release(mXPCConnection);
401 mXPCConnection = NULL;
402 }
403 } else if (XPC_ERROR_CONNECTION_INTERRUPTED == object) {
404 // If we get an error before getting the create response, try again
405 }
406 }
407 xpc_release(object);
408 xpc_release(requestObject);
409 } while (!mAgentConnected);
410
411 StLock<Mutex> _(gAllXPCClientsMutex());
412 allXPCClients().insert(this);
413 }
414
415 static xpc_object_t authItemSetToXPCArray(AuthItemSet input) {
416 xpc_object_t outputArray = xpc_array_create(NULL, 0);
417 for (AuthItemSet::iterator i = input.begin(); i != input.end(); i++) {
418 AuthItemRef item = *i;
419
420 xpc_object_t xpc_data = xpc_dictionary_create(NULL, NULL, 0);
421 xpc_dictionary_set_string(xpc_data, AUTH_XPC_ITEM_NAME, item->name());
422 AuthorizationValue value = item->value();
423 if (value.data != NULL) {
424 xpc_dictionary_set_data(xpc_data, AUTH_XPC_ITEM_VALUE, value.data, value.length);
425 }
426 xpc_dictionary_set_uint64(xpc_data, AUTH_XPC_ITEM_FLAGS, item->flags());
427 xpc_array_append_value(outputArray, xpc_data);
428 xpc_release(xpc_data);
429 }
430 return outputArray;
431 }
432
433 void
434 SecurityAgentXPCQuery::invoke() {
435 xpc_object_t hintsArray = authItemSetToXPCArray(mInHints);
436 xpc_object_t contextArray = authItemSetToXPCArray(mInContext);
437 xpc_object_t immutableHintsArray = authItemSetToXPCArray(mImmutableHints);
438
439 xpc_object_t requestObject = xpc_dictionary_create(NULL, NULL, 0);
440 xpc_dictionary_set_string(requestObject, AUTH_XPC_REQUEST_METHOD_KEY, AUTH_XPC_REQUEST_METHOD_INVOKE);
441 xpc_dictionary_set_value(requestObject, AUTH_XPC_HINTS_NAME, hintsArray);
442 xpc_dictionary_set_value(requestObject, AUTH_XPC_CONTEXT_NAME, contextArray);
443 xpc_dictionary_set_value(requestObject, AUTH_XPC_IMMUTABLE_HINTS_NAME, immutableHintsArray);
444
445 xpc_object_t object = xpc_connection_send_message_with_reply_sync(mXPCConnection, requestObject);
446 if (xpc_get_type(object) == XPC_TYPE_DICTIONARY) {
447 const char *replyType = xpc_dictionary_get_string(object, AUTH_XPC_REPLY_METHOD_KEY);
448 if (0 == strcmp(replyType, AUTH_XPC_REPLY_METHOD_RESULT)) {
449 xpc_object_t xpcHints = xpc_dictionary_get_value(object, AUTH_XPC_HINTS_NAME);
450 xpc_object_t xpcContext = xpc_dictionary_get_value(object, AUTH_XPC_CONTEXT_NAME);
451 AuthItemSet tempHints, tempContext;
452 xpcArrayToAuthItemSet(&tempHints, xpcHints);
453 xpcArrayToAuthItemSet(&tempContext, xpcContext);
454 mOutHints = tempHints;
455 mOutContext = tempContext;
456 mLastResult = xpc_dictionary_get_uint64(object, AUTH_XPC_REPLY_RESULT_VALUE);
457 }
458 } else if (xpc_get_type(object) == XPC_TYPE_ERROR) {
459 if (XPC_ERROR_CONNECTION_INVALID == object) {
460 // If the connection drops, return an "auth undefined" result, because we cannot continue
461 } else if (XPC_ERROR_CONNECTION_INTERRUPTED == object) {
462 // If the agent dies, return an "auth undefined" result, because we cannot continue
463 }
464 }
465 xpc_release(object);
466
467 xpc_release(hintsArray);
468 xpc_release(contextArray);
469 xpc_release(immutableHintsArray);
470 xpc_release(requestObject);
471 }
472
473 void SecurityAgentXPCQuery::checkResult()
474 {
475 // now check the OSStatus return from the server side
476 switch (mLastResult) {
477 case kAuthorizationResultAllow: return;
478 case kAuthorizationResultDeny:
479 case kAuthorizationResultUserCanceled: CssmError::throwMe(CSSM_ERRCODE_USER_CANCELED);
480 default: MacOSError::throwMe(errAuthorizationInternal);
481 }
482 }
483
484 //
485 // Perform the "rogue app" access query dialog
486 //
487 QueryKeychainUse::QueryKeychainUse(bool needPass, const Database *db)
488 : mPassphraseCheck(NULL)
489 {
490 // if passphrase checking requested, save KeychainDatabase reference
491 // (will quietly disable check if db isn't a keychain)
492
493 // Always require password, <rdar://problem/34677969> Always require the user's password on keychain approval dialogs
494 // if (needPass)
495 mPassphraseCheck = dynamic_cast<const KeychainDatabase *>(db);
496
497 setTerminateOnSleep(true);
498 }
499
500 Reason QueryKeychainUse::queryUser (const char *database, const char *description, AclAuthorization action)
501 {
502 Reason reason = SecurityAgent::noReason;
503 uint32_t retryCount = 0;
504 AuthItemSet hints, context;
505
506 // prepopulate with client hints
507 hints.insert(mClientHints.begin(), mClientHints.end());
508
509 // put action/operation (sint32) into hints
510 hints.insert(AuthItemRef(AGENT_HINT_ACL_TAG, AuthValueOverlay(sizeof(action), static_cast<sint32*>(&action))));
511
512 // item name into hints
513
514 hints.insert(AuthItemRef(AGENT_HINT_KEYCHAIN_ITEM_NAME, AuthValueOverlay(description ? (uint32_t)strlen(description) : 0, const_cast<char*>(description))));
515
516 // keychain name into hints
517 hints.insert(AuthItemRef(AGENT_HINT_KEYCHAIN_PATH, AuthValueOverlay(database ? (uint32_t)strlen(database) : 0, const_cast<char*>(database))));
518
519 if (mPassphraseCheck)
520 {
521 create("builtin", "confirm-access-password");
522
523 CssmAutoData data(Allocator::standard(Allocator::sensitive));
524
525 do
526 {
527
528 AuthItemRef triesHint(AGENT_HINT_TRIES, AuthValueOverlay(sizeof(retryCount), &retryCount));
529 hints.erase(triesHint); hints.insert(triesHint); // replace
530
531 if (retryCount++ > kMaximumAuthorizationTries)
532 {
533 reason = SecurityAgent::tooManyTries;
534 }
535
536 AuthItemRef retryHint(AGENT_HINT_RETRY_REASON, AuthValueOverlay(sizeof(reason), &reason));
537 hints.erase(retryHint); hints.insert(retryHint); // replace
538
539 setInput(hints, context);
540 invoke();
541
542 if (retryCount > kMaximumAuthorizationTries)
543 {
544 return reason;
545 }
546
547 checkResult();
548
549 AuthItem *passwordItem = mOutContext.find(kAuthorizationEnvironmentPassword);
550 if (!passwordItem)
551 continue;
552
553 passwordItem->getCssmData(data);
554 }
555 while ((reason = (const_cast<KeychainDatabase*>(mPassphraseCheck)->decode(data) ? SecurityAgent::noReason : SecurityAgent::invalidPassphrase)));
556
557 readChoice();
558 }
559 else
560 {
561 // create("builtin", "confirm-access");
562 // setInput(hints, context);
563 // invoke();
564
565 // This is a hack to support <rdar://problem/34677969>, we can never simply prompt for confirmation
566 secerror("ACL validation fallback case! Must ask user for account password because we have no database");
567 Session &session = Server::session();
568 try{
569 session.verifyKeyStorePassphrase(1, true, description);
570 } catch (...) {
571 return SecurityAgent::invalidPassphrase;
572 }
573 SecurityAgentXPCQuery::allow = true;
574 }
575
576 return reason;
577 }
578
579 //
580 // Obtain passphrases and submit them to the accept() method until it is accepted
581 // or we can't get another passphrase. Accept() should consume the passphrase
582 // if it is accepted. If no passphrase is acceptable, throw out of here.
583 //
584 Reason QueryOld::query()
585 {
586 Reason reason = SecurityAgent::noReason;
587 AuthItemSet hints, context;
588 CssmAutoData passphrase(Allocator::standard(Allocator::sensitive));
589 int retryCount = 0;
590
591 // prepopulate with client hints
592
593 const char *keychainPath = database.dbName();
594 hints.insert(AuthItemRef(AGENT_HINT_KEYCHAIN_PATH, AuthValueOverlay((uint32_t)strlen(keychainPath), const_cast<char*>(keychainPath))));
595
596 hints.insert(mClientHints.begin(), mClientHints.end());
597
598 create("builtin", "unlock-keychain");
599
600 do
601 {
602 AuthItemRef triesHint(AGENT_HINT_TRIES, AuthValueOverlay(sizeof(retryCount), &retryCount));
603 hints.erase(triesHint); hints.insert(triesHint); // replace
604
605 ++retryCount;
606
607 if (retryCount > maxTries)
608 {
609 reason = SecurityAgent::tooManyTries;
610 }
611
612 AuthItemRef retryHint(AGENT_HINT_RETRY_REASON, AuthValueOverlay(sizeof(reason), &reason));
613 hints.erase(retryHint); hints.insert(retryHint); // replace
614
615 setInput(hints, context);
616 invoke();
617
618 if (retryCount > maxTries)
619 {
620 return reason;
621 }
622
623 checkResult();
624
625 AuthItem *passwordItem = mOutContext.find(kAuthorizationEnvironmentPassword);
626 if (!passwordItem)
627 continue;
628
629 passwordItem->getCssmData(passphrase);
630
631 }
632 while ((reason = accept(passphrase)));
633
634 return SecurityAgent::noReason;
635 }
636
637
638 //
639 // Get existing passphrase (unlock) Query
640 //
641 Reason QueryOld::operator () ()
642 {
643 return query();
644 }
645
646
647 //
648 // End-classes for old secrets
649 //
650 Reason QueryUnlock::accept(CssmManagedData &passphrase)
651 {
652 if (safer_cast<KeychainDatabase &>(database).decode(passphrase))
653 return SecurityAgent::noReason;
654 else
655 return SecurityAgent::invalidPassphrase;
656 }
657
658 Reason QueryUnlock::retrievePassword(CssmOwnedData &passphrase) {
659 CssmAutoData pass(Allocator::standard(Allocator::sensitive));
660
661 AuthItem *passwordItem = mOutContext.find(kAuthorizationEnvironmentPassword);
662 if (!passwordItem)
663 return SecurityAgent::invalidPassphrase;
664
665 passwordItem->getCssmData(pass);
666
667 passphrase = pass;
668
669 return SecurityAgent::noReason;
670 }
671
672 QueryKeybagPassphrase::QueryKeybagPassphrase(Session & session, int32_t tries) : mSession(session), mContext(), mRetries(tries)
673 {
674 setTerminateOnSleep(true);
675 mContext = mSession.get_current_service_context();
676 }
677
678 Reason QueryKeybagPassphrase::query()
679 {
680 Reason reason = SecurityAgent::noReason;
681 AuthItemSet hints, context;
682 CssmAutoData passphrase(Allocator::standard(Allocator::sensitive));
683 int retryCount = 0;
684
685 // prepopulate with client hints
686
687 const char *keychainPath = "iCloud";
688 hints.insert(AuthItemRef(AGENT_HINT_KEYCHAIN_PATH, AuthValueOverlay((uint32_t)strlen(keychainPath), const_cast<char*>(keychainPath))));
689
690 hints.insert(mClientHints.begin(), mClientHints.end());
691
692 create("builtin", "unlock-keychain");
693
694 int currentTry = 0;
695 do
696 {
697 currentTry = retryCount;
698 if (retryCount > mRetries)
699 {
700 return SecurityAgent::tooManyTries;
701 }
702 retryCount++;
703
704 AuthItemRef triesHint(AGENT_HINT_TRIES, AuthValueOverlay(sizeof(currentTry), &currentTry));
705 hints.erase(triesHint); hints.insert(triesHint); // replace
706
707 AuthItemRef retryHint(AGENT_HINT_RETRY_REASON, AuthValueOverlay(sizeof(reason), &reason));
708 hints.erase(retryHint); hints.insert(retryHint); // replace
709
710 setInput(hints, context);
711 invoke();
712
713 checkResult();
714
715 AuthItem *passwordItem = mOutContext.find(kAuthorizationEnvironmentPassword);
716 if (!passwordItem)
717 continue;
718
719 passwordItem->getCssmData(passphrase);
720 }
721 while ((reason = accept(passphrase)));
722
723 return SecurityAgent::noReason;
724 }
725
726 Reason QueryKeybagPassphrase::accept(Security::CssmManagedData & password)
727 {
728 if (service_client_kb_unlock(&mContext, password.data(), (int)password.length()) == 0) {
729 mSession.keybagSetState(session_keybag_unlocked);
730 return SecurityAgent::noReason;
731 } else
732 return SecurityAgent::invalidPassphrase;
733 }
734
735 QueryKeybagNewPassphrase::QueryKeybagNewPassphrase(Session & session) : QueryKeybagPassphrase(session) {}
736
737 Reason QueryKeybagNewPassphrase::query(CssmOwnedData &oldPassphrase, CssmOwnedData &passphrase)
738 {
739 CssmAutoData pass(Allocator::standard(Allocator::sensitive));
740 CssmAutoData oldPass(Allocator::standard(Allocator::sensitive));
741 Reason reason = SecurityAgent::noReason;
742 AuthItemSet hints, context;
743 int retryCount = 0;
744
745 // prepopulate with client hints
746
747 const char *keychainPath = "iCloud";
748 hints.insert(AuthItemRef(AGENT_HINT_KEYCHAIN_PATH, AuthValueOverlay((uint32_t)strlen(keychainPath), const_cast<char*>(keychainPath))));
749
750 const char *showResetString = "YES";
751 hints.insert(AuthItemRef(AGENT_HINT_SHOW_RESET, AuthValueOverlay((uint32_t)strlen(showResetString), const_cast<char*>(showResetString))));
752
753 hints.insert(mClientHints.begin(), mClientHints.end());
754
755 create("builtin", "change-passphrase");
756
757 int currentTry = 0;
758 AuthItem *resetPassword = NULL;
759 do
760 {
761 currentTry = retryCount;
762 if (retryCount > mRetries)
763 {
764 return SecurityAgent::tooManyTries;
765 }
766 retryCount++;
767
768 AuthItemRef triesHint(AGENT_HINT_TRIES, AuthValueOverlay(sizeof(currentTry), &currentTry));
769 hints.erase(triesHint); hints.insert(triesHint); // replace
770
771 AuthItemRef retryHint(AGENT_HINT_RETRY_REASON, AuthValueOverlay(sizeof(reason), &reason));
772 hints.erase(retryHint); hints.insert(retryHint); // replace
773
774 setInput(hints, context);
775 invoke();
776
777 checkResult();
778
779 resetPassword = mOutContext.find(AGENT_CONTEXT_RESET_PASSWORD);
780 if (resetPassword != NULL) {
781 return SecurityAgent::resettingPassword;
782 }
783
784 AuthItem *oldPasswordItem = mOutContext.find(AGENT_PASSWORD);
785 if (!oldPasswordItem)
786 continue;
787
788 oldPasswordItem->getCssmData(oldPass);
789 }
790 while ((reason = accept(oldPass)));
791
792 if (reason == SecurityAgent::noReason) {
793 AuthItem *passwordItem = mOutContext.find(AGENT_CONTEXT_NEW_PASSWORD);
794 if (!passwordItem)
795 return SecurityAgent::invalidPassphrase;
796
797 passwordItem->getCssmData(pass);
798
799 oldPassphrase = oldPass;
800 passphrase = pass;
801 }
802
803 return SecurityAgent::noReason;
804 }
805
806 QueryPIN::QueryPIN(Database &db)
807 : QueryOld(db), mPin(Allocator::standard())
808 {
809 this->inferHints(Server::process());
810 }
811
812
813 Reason QueryPIN::accept(CssmManagedData &pin)
814 {
815 // no retries for now
816 mPin = pin;
817 return SecurityAgent::noReason;
818 }
819
820
821 //
822 // Obtain passphrases and submit them to the accept() method until it is accepted
823 // or we can't get another passphrase. Accept() should consume the passphrase
824 // if it is accepted. If no passphrase is acceptable, throw out of here.
825 //
826 Reason QueryNewPassphrase::query()
827 {
828 Reason reason = initialReason;
829 CssmAutoData passphrase(Allocator::standard(Allocator::sensitive));
830 CssmAutoData oldPassphrase(Allocator::standard(Allocator::sensitive));
831
832 AuthItemSet hints, context;
833
834 int retryCount = 0;
835
836 // prepopulate with client hints
837 hints.insert(mClientHints.begin(), mClientHints.end());
838
839 // keychain name into hints
840 hints.insert(AuthItemRef(AGENT_HINT_KEYCHAIN_PATH, AuthValueOverlay(database.dbName())));
841
842 switch (initialReason)
843 {
844 case SecurityAgent::newDatabase:
845 create("builtin", "new-passphrase");
846 break;
847 case SecurityAgent::changePassphrase:
848 create("builtin", "change-passphrase");
849 break;
850 default:
851 assert(false);
852 }
853
854 do
855 {
856 AuthItemRef triesHint(AGENT_HINT_TRIES, AuthValueOverlay(sizeof(retryCount), &retryCount));
857 hints.erase(triesHint); hints.insert(triesHint); // replace
858
859 if (++retryCount > maxTries)
860 {
861 reason = SecurityAgent::tooManyTries;
862 }
863
864 AuthItemRef retryHint(AGENT_HINT_RETRY_REASON, AuthValueOverlay(sizeof(reason), &reason));
865 hints.erase(retryHint); hints.insert(retryHint); // replace
866
867 setInput(hints, context);
868 invoke();
869
870 if (retryCount > maxTries)
871 {
872 return reason;
873 }
874
875 checkResult();
876
877 if (SecurityAgent::changePassphrase == initialReason)
878 {
879 AuthItem *oldPasswordItem = mOutContext.find(AGENT_PASSWORD);
880 if (!oldPasswordItem)
881 continue;
882
883 oldPasswordItem->getCssmData(oldPassphrase);
884 }
885
886 AuthItem *passwordItem = mOutContext.find(AGENT_CONTEXT_NEW_PASSWORD);
887 if (!passwordItem)
888 continue;
889
890 passwordItem->getCssmData(passphrase);
891
892 }
893 while ((reason = accept(passphrase, (initialReason == SecurityAgent::changePassphrase) ? &oldPassphrase.get() : NULL)));
894
895 return SecurityAgent::noReason;
896 }
897
898
899 //
900 // Get new passphrase Query
901 //
902 Reason QueryNewPassphrase::operator () (CssmOwnedData &oldPassphrase, CssmOwnedData &passphrase)
903 {
904 if (Reason result = query())
905 return result; // failed
906 passphrase = mPassphrase;
907 oldPassphrase = mOldPassphrase;
908 return SecurityAgent::noReason; // success
909 }
910
911 Reason QueryNewPassphrase::accept(CssmManagedData &passphrase, CssmData *oldPassphrase)
912 {
913 //@@@ acceptance criteria are currently hardwired here
914 //@@@ This validation presumes ASCII - UTF8 might be more lenient
915
916 // if we have an old passphrase, check it
917 if (oldPassphrase && !safer_cast<KeychainDatabase&>(database).validatePassphrase(*oldPassphrase))
918 return SecurityAgent::oldPassphraseWrong;
919
920 // sanity check the new passphrase (but allow user override)
921 if (!(mPassphraseValid && passphrase.get() == mPassphrase)) {
922 mPassphrase = passphrase;
923 if (oldPassphrase) mOldPassphrase = *oldPassphrase;
924 mPassphraseValid = true;
925 if (mPassphrase.length() == 0)
926 return SecurityAgent::passphraseIsNull;
927 if (mPassphrase.length() < 6)
928 return SecurityAgent::passphraseTooSimple;
929 }
930
931 // accept this
932 return SecurityAgent::noReason;
933 }
934
935 //
936 // Get a passphrase for unspecified use
937 //
938 Reason QueryGenericPassphrase::operator () (const CssmData *prompt, bool verify,
939 string &passphrase)
940 {
941 return query(prompt, verify, passphrase);
942 }
943
944 Reason QueryGenericPassphrase::query(const CssmData *prompt, bool verify,
945 string &passphrase)
946 {
947 Reason reason = SecurityAgent::noReason;
948 AuthItemSet hints, context;
949
950 hints.insert(mClientHints.begin(), mClientHints.end());
951 hints.insert(AuthItemRef(AGENT_HINT_CUSTOM_PROMPT, AuthValueOverlay(prompt ? (UInt32)prompt->length() : 0, prompt ? prompt->data() : NULL)));
952 // XXX/gh defined by dmitch but no analogous hint in
953 // AuthorizationTagsPriv.h:
954 // CSSM_ATTRIBUTE_ALERT_TITLE (optional alert panel title)
955
956 if (false == verify) { // import
957 create("builtin", "generic-unlock");
958 } else { // verify passphrase (export)
959 create("builtin", "generic-new-passphrase");
960 }
961
962 AuthItem *passwordItem;
963
964 do {
965 setInput(hints, context);
966 invoke();
967 checkResult();
968 passwordItem = mOutContext.find(AGENT_PASSWORD);
969
970 } while (!passwordItem);
971
972 passwordItem->getString(passphrase);
973
974 return reason;
975 }
976
977
978 //
979 // Get a DB blob's passphrase--keychain synchronization
980 //
981 Reason QueryDBBlobSecret::operator () (DbHandle *dbHandleArray, uint8 dbHandleArrayCount, DbHandle *dbHandleAuthenticated)
982 {
983 return query(dbHandleArray, dbHandleArrayCount, dbHandleAuthenticated);
984 }
985
986 Reason QueryDBBlobSecret::query(DbHandle *dbHandleArray, uint8 dbHandleArrayCount, DbHandle *dbHandleAuthenticated)
987 {
988 Reason reason = SecurityAgent::noReason;
989 CssmAutoData passphrase(Allocator::standard(Allocator::sensitive));
990 AuthItemSet hints/*NUKEME*/, context;
991
992 hints.insert(mClientHints.begin(), mClientHints.end());
993 create("builtin", "generic-unlock-kcblob");
994
995 AuthItem *secretItem;
996
997 int retryCount = 0;
998
999 do {
1000 AuthItemRef triesHint(AGENT_HINT_TRIES, AuthValueOverlay(sizeof(retryCount), &retryCount));
1001 hints.erase(triesHint); hints.insert(triesHint); // replace
1002
1003 if (++retryCount > maxTries)
1004 {
1005 reason = SecurityAgent::tooManyTries;
1006 }
1007
1008 AuthItemRef retryHint(AGENT_HINT_RETRY_REASON, AuthValueOverlay(sizeof(reason), &reason));
1009 hints.erase(retryHint); hints.insert(retryHint); // replace
1010
1011 setInput(hints, context);
1012 invoke();
1013 checkResult();
1014 secretItem = mOutContext.find(AGENT_PASSWORD);
1015 if (!secretItem)
1016 continue;
1017 secretItem->getCssmData(passphrase);
1018
1019 } while ((reason = accept(passphrase, dbHandleArray, dbHandleArrayCount, dbHandleAuthenticated)));
1020
1021 return reason;
1022 }
1023
1024 Reason QueryDBBlobSecret::accept(CssmManagedData &passphrase,
1025 DbHandle *dbHandlesToAuthenticate, uint8 dbHandleCount, DbHandle *dbHandleAuthenticated)
1026 {
1027 DbHandle *currHdl = dbHandlesToAuthenticate;
1028 short index;
1029 Boolean authenticated = false;
1030 for (index=0; index < dbHandleCount && !authenticated; index++)
1031 {
1032 try
1033 {
1034 RefPointer<KeychainDatabase> dbToUnlock = Server::keychain(*currHdl);
1035 dbToUnlock->unlockDb(passphrase, false);
1036 authenticated = true;
1037 *dbHandleAuthenticated = *currHdl; // return the DbHandle that 'passphrase' authenticated with.
1038 }
1039 catch (const CommonError &err)
1040 {
1041 currHdl++; // we failed to authenticate with this one, onto the next one.
1042 }
1043 }
1044 if ( !authenticated )
1045 return SecurityAgent::invalidPassphrase;
1046
1047 return SecurityAgent::noReason;
1048 }
1049
1050 // @@@ no pluggable authentication possible!
1051 Reason
1052 QueryKeychainAuth::operator () (const char *database, const char *description, AclAuthorization action, const char *prompt)
1053 {
1054 Reason reason = SecurityAgent::noReason;
1055 AuthItemSet hints, context;
1056 int retryCount = 0;
1057 string username;
1058 string password;
1059
1060 using CommonCriteria::Securityd::KeychainAuthLogger;
1061 KeychainAuthLogger logger(mAuditToken, (short)AUE_ssauthint, database, description);
1062
1063 hints.insert(mClientHints.begin(), mClientHints.end());
1064
1065 // put action/operation (sint32) into hints
1066 hints.insert(AuthItemRef(AGENT_HINT_ACL_TAG, AuthValueOverlay(sizeof(action), static_cast<sint32*>(&action))));
1067
1068 hints.insert(AuthItemRef(AGENT_HINT_CUSTOM_PROMPT, AuthValueOverlay(prompt ? (uint32_t)strlen(prompt) : 0, const_cast<char*>(prompt))));
1069
1070 // item name into hints
1071 hints.insert(AuthItemRef(AGENT_HINT_KEYCHAIN_ITEM_NAME, AuthValueOverlay(description ? (uint32_t)strlen(description) : 0, const_cast<char*>(description))));
1072
1073 // keychain name into hints
1074 hints.insert(AuthItemRef(AGENT_HINT_KEYCHAIN_PATH, AuthValueOverlay(database ? (uint32_t)strlen(database) : 0, const_cast<char*>(database))));
1075
1076 create("builtin", "confirm-access-user-password");
1077
1078 AuthItem *usernameItem;
1079 AuthItem *passwordItem;
1080
1081 do {
1082
1083 AuthItemRef triesHint(AGENT_HINT_TRIES, AuthValueOverlay(sizeof(retryCount), &retryCount));
1084 hints.erase(triesHint); hints.insert(triesHint); // replace
1085
1086 if (++retryCount > maxTries)
1087 reason = SecurityAgent::tooManyTries;
1088
1089 if (SecurityAgent::noReason != reason)
1090 {
1091 if (SecurityAgent::tooManyTries == reason)
1092 logger.logFailure(NULL, CommonCriteria::errTooManyTries);
1093 else
1094 logger.logFailure();
1095 }
1096
1097 AuthItemRef retryHint(AGENT_HINT_RETRY_REASON, AuthValueOverlay(sizeof(reason), &reason));
1098 hints.erase(retryHint); hints.insert(retryHint); // replace
1099
1100 setInput(hints, context);
1101 try
1102 {
1103 invoke();
1104 checkResult();
1105 }
1106 catch (...) // user probably clicked "deny"
1107 {
1108 logger.logFailure();
1109 throw;
1110 }
1111 usernameItem = mOutContext.find(AGENT_USERNAME);
1112 passwordItem = mOutContext.find(AGENT_PASSWORD);
1113 if (!usernameItem || !passwordItem)
1114 continue;
1115 usernameItem->getString(username);
1116 passwordItem->getString(password);
1117 } while ((reason = accept(username, password)));
1118
1119 if (SecurityAgent::noReason == reason)
1120 logger.logSuccess();
1121 // else we logged the denial in the loop
1122
1123 return reason;
1124 }
1125
1126 Reason
1127 QueryKeychainAuth::accept(string &username, string &passphrase)
1128 {
1129 // Note: QueryKeychainAuth currently requires that the
1130 // specified user be in the admin group. If this requirement
1131 // ever needs to change, the group name should be passed as
1132 // a separate argument to this method.
1133
1134 const char *user = username.c_str();
1135 const char *passwd = passphrase.c_str();
1136 int checkpw_status = checkpw(user, passwd);
1137
1138 if (checkpw_status != CHECKPW_SUCCESS) {
1139 return SecurityAgent::invalidPassphrase;
1140 }
1141
1142 const char *group = "admin";
1143 if (group) {
1144 int rc, ismember;
1145 uuid_t group_uuid, user_uuid;
1146 rc = mbr_group_name_to_uuid(group, group_uuid);
1147 if (rc) { return SecurityAgent::userNotInGroup; }
1148
1149 rc = mbr_user_name_to_uuid(user, user_uuid);
1150 if (rc) { return SecurityAgent::userNotInGroup; }
1151
1152 rc = mbr_check_membership(user_uuid, group_uuid, &ismember);
1153 if (rc || !ismember) { return SecurityAgent::userNotInGroup; }
1154 }
1155
1156 return SecurityAgent::noReason;
1157 }
1158