Merge branch 'nm-psk'
[strongswan.git] / src / frontends / osx / README.md
1 # strongSwan OS X App #
2
3 ## Introduction ##
4
5 The strongSwan OS X App consists of two components:
6
7 * A frontend to configure and control connections
8 * A privileged helper daemon, controlled using XPC, called charon-xpc
9
10 The privileged helper daemon gets installed automatically using SMJobBless
11 functionality on its first use, and gets started automatically by Launchd when
12 needed.
13
14 charon-xpc is a special build linking statically against strongSwan components.
15
16 charon-xpc sources are not part of the official strongSwan distribution. Build
17 the charon-xpc tarball with:
18
19     git archive -o charon-xpc-$(grep AC_INIT configure.ac | \
20                                 cut -d '[' -f3 | cut -d ']' -f1).tar.bz2 \
21         HEAD src/frontends/osx
22
23 ## Building strongSwan ##
24
25 Before building the Xcode project, the strongSwan base tree must be built using
26 a monolithic and static build. This can be achieved on OS X by using:
27
28     CFLAGS="-O2 -Wall -Wno-format -Wno-pointer-sign -Wno-deprecated-declarations" \
29     ./configure --enable-monolithic --disable-shared --enable-static \
30         --disable-defaults \
31         --enable-openssl --enable-kernel-libipsec --enable-kernel-pfroute \
32         --enable-eap-mschapv2 --enable-eap-identity --enable-eap-md5 \
33         --enable-pkcs1 --enable-socket-default --enable-osx-attr \
34         --enable-xauth-generic --enable-gcm --enable-ccm --enable-ctr \
35         --enable-keychain --enable-nonce --enable-charon \
36         --enable-ikev1 --enable-ikev2
37
38 followed by calling make (no need to make install).
39
40 Building charon-xpc using the Xcode project yields a single binary without
41 any non OS X dependencies.
42
43 Both charon-xpc and the App must be code-signed to allow the installation of
44 the privileged helper. git-grep for "Joe Developer" to change the signing
45 identity.
46
47 ## XPC application protocol ##
48
49 charon-xpc provides a Mach service under the name _org.strongswan.charon-xpc_.
50 Clients can connect to this service to control the daemon. All messages
51 on all connections use the following string dictionary keys/values:
52
53 * _type_: XPC message type, currently either
54         * _rpc_ for a remote procedure call, expects a response
55         * _event_ for application specific event messages
56 * _rpc_: defines the name of the RPC function to call (for _type_ = _rpc_)
57 * _event_: defines a name for the event (for _type_ = _event_)
58
59 Additional arguments and return values are specified by the call and can have
60 any type. Keys are directly attached to the message dictionary.
61
62 On the Mach service connection, the following RPC messages are currently
63 defined:
64
65 * string version = get_version()
66         * _version_: strongSwan version of charon-xpc
67 * bool success = start_connection(string name, string host, string id,
68                                                                   endpoint channel)
69         * _success_: TRUE if initiation started successfully
70         * _name_: connection name to initiate
71         * _host_: server hostname (and identity)
72         * _id_: client identity to use
73         * _channel_: XPC endpoint for this connection
74
75 The start_connection() RPC returns just after the initiation of the call and
76 does not wait for the connection to establish. Nonetheless does it have a
77 return value to indicate if connection initiation could be triggered.
78
79 The App passes an (anonymous) XPC endpoint to start_connection(). If the call
80 succeeds, charon-xpc connects to this endpoint to establish a channel used for
81 this specific IKE connection.
82
83 On this channel, the following RPC calls are currently defined from charon-xpc
84 to the App:
85
86 * string password = get_password(string username)
87         * _password_: user password returned
88         * _username_: username to query a password for
89
90 And the following from the App to charon-xpc:
91
92 * bool success = stop_connection()
93         * _success_: TRUE if termination of connection initiated
94
95 The following events are currently defined from charon-xpc to the App:
96
97 * up(): IKE_SA has been established
98 * down(): IKE_SA has been closed or failed to establish
99 * child_up(string local_ts, string remote_ts): CHILD_SA has been established
100 * child_down(string local_ts, string remote_ts): CHILD_SA has been closed
101 * log(string message): debug log message for this connection