1/*
2 * Copyright (c) 2005, PADL Software Pty Ltd.
3 * All rights reserved.
4 *
5 * Portions Copyright (c) 2009 Apple Inc. All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 *
11 * 1. Redistributions of source code must retain the above copyright
12 *    notice, this list of conditions and the following disclaimer.
13 *
14 * 2. Redistributions in binary form must reproduce the above copyright
15 *    notice, this list of conditions and the following disclaimer in the
16 *    documentation and/or other materials provided with the distribution.
17 *
18 * 3. Neither the name of PADL Software nor the names of its contributors
19 *    may be used to endorse or promote products derived from this software
20 *    without specific prior written permission.
21 *
22 * THIS SOFTWARE IS PROVIDED BY PADL SOFTWARE AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED.  IN NO EVENT SHALL PADL SOFTWARE OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 * SUCH DAMAGE.
33 */
34
35#ifndef __KCM_H__
36#define __KCM_H__
37
38/*
39 * KCM protocol definitions
40 */
41
42#define KCM_PROTOCOL_VERSION_MAJOR	2
43#define KCM_PROTOCOL_VERSION_MINOR	0
44
45typedef unsigned char kcmuuid_t[16];
46
47typedef enum kcm_operation {
48    KCM_OP_NOOP,
49    KCM_OP_GET_NAME,
50    KCM_OP_RESOLVE,
51    KCM_OP_DEPRECATED_GEN_NEW,
52    KCM_OP_INITIALIZE,
53    KCM_OP_DESTROY,
54    KCM_OP_STORE,
55    KCM_OP_RETRIEVE,
56    KCM_OP_GET_PRINCIPAL,
57    KCM_OP_GET_CRED_UUID_LIST,
58    KCM_OP_GET_CRED_BY_UUID,
59    KCM_OP_REMOVE_CRED,
60    KCM_OP_SET_FLAGS,
61    KCM_OP_CHOWN,
62    KCM_OP_CHMOD,
63    KCM_OP_GET_INITIAL_TICKET,
64    KCM_OP_GET_TICKET,
65    KCM_OP_MOVE_CACHE,
66    KCM_OP_GET_CACHE_UUID_LIST,
67    KCM_OP_GET_CACHE_BY_UUID,
68    KCM_OP_GET_DEFAULT_CACHE,
69    KCM_OP_SET_DEFAULT_CACHE,
70    KCM_OP_GET_KDC_OFFSET,
71    KCM_OP_SET_KDC_OFFSET,
72    KCM_OP_RETAIN_KCRED,
73    KCM_OP_RELEASE_KCRED,
74    KCM_OP_GET_UUID,
75    /* NTLM operations */
76    KCM_OP_ADD_NTLM_CRED,
77    KCM_OP_HAVE_NTLM_CRED,
78    KCM_OP_ADD_NTLM_CHALLENGE,
79    KCM_OP_DO_NTLM_AUTH,
80    KCM_OP_GET_NTLM_USER_LIST,
81    /* SCRAM */
82    KCM_OP_ADD_SCRAM_CRED,
83    KCM_OP_HAVE_SCRAM_CRED,
84    KCM_OP_DEL_SCRAM_CRED,
85    KCM_OP_DO_SCRAM_AUTH,
86    KCM_OP_GET_SCRAM_USER_LIST,
87    /* GENERIC */
88    KCM_OP_DESTROY_CRED,
89    KCM_OP_RETAIN_CRED,
90    KCM_OP_RELEASE_CRED,
91    KCM_OP_CRED_LABEL_GET,
92    KCM_OP_CRED_LABEL_SET,
93    KCM_OP_MAX
94} kcm_operation;
95
96#define _PATH_KCM_SOCKET      "/var/run/.kcm_socket"
97#define _PATH_KCM_DOOR      "/var/run/.kcm_door"
98
99#define KRB5_KCM_NOTIFY_CACHE_CHANGED "com.apple.Kerberos.cache.changed"
100
101/* notification name used on MacOS X */
102#define kCCAPICacheCollectionChangedNotification "CCAPICacheCollectionChangedNotification"
103#define kCCAPICCacheChangedNotification "CCAPICCacheChangedNotification"
104
105
106#define KCM_STATUS_KEY			"kcm-status"
107#define KCM_STATUS_ACQUIRE_START	0
108#define KCM_STATUS_ACQUIRE_SUCCESS	1
109#define KCM_STATUS_ACQUIRE_FAILED	2
110#define KCM_STATUS_ACQUIRE_STOPPED	3
111
112
113#define KCM_NTLM_FLAG_AV_GUEST 8
114
115#endif /* __KCM_H__ */
116
117