xpc: allow easy copy & pase of ./configure instructions
[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 ## Building strongSwan ##
17
18 strongSwan on OS X requires the libvstr library. The simplest way to install
19 it is using MacPorts. It gets statically linked to charon-xpc, hence it is not
20 needed to run the built App.
21
22 Before building the Xcode project, the strongSwan base tree must be built using
23 a monolithic and static build. This can be achieved on OS X by using:
24
25     LDFLAGS="-all_load -L/opt/local/lib" \
26     CFLAGS="-idirafter /opt/local/include -O2 -Wall -Wno-format -Wno-pointer-sign" \
27     ./configure --enable-monolithic --disable-shared --enable-static \
28         --disable-defaults \
29         --enable-openssl --enable-kernel-pfkey --enable-kernel-pfroute \
30         --enable-eap-mschapv2 --enable-eap-identity --enable-nonce \
31         --enable-random --enable-pkcs1 --enable-pem --enable-socket-default \
32         --enable-xauth-generic --enable-keychain --enable-charon \
33         --enable-ikev1 --enable-ikev2
34
35 followed by calling make (no need to make install).
36
37 Building charon-xpc using the Xcode project yields a single binary without
38 any non OS X dependencies.
39
40 Both charon-xpc and the App must be code-signed to allow the installation of
41 the privileged helper. git-grep for "Joe Developer" to change the signing
42 identity.
43
44 ## XPC application protocol ##
45
46 charon-xpc provides a Mach service under the name _org.strongswan.charon-xpc_.
47 Clients can connect to this service to control the daemon. All messages
48 on all connections use the following string dictionary keys/values:
49
50 * _type_: XPC message type, currently either
51         * _rpc_ for a remote procedure call, expects a response
52         * _event_ for application specific event messages
53 * _rpc_: defines the name of the RPC function to call (for _type_ = _rpc_)
54 * _event_: defines a name for the event (for _type_ = _event_)
55
56 Additional arguments and return values are specified by the call and can have
57 any type. Keys are directly attached to the message dictionary.
58
59 On the Mach service connection, the following RPC messages are currently
60 defined:
61
62 * string version = get_version()
63         * _version_: strongSwan version of charon-xpc
64 * bool success = start_connection(string name, string host, string id,
65                                                                   endpoint channel)
66         * _success_: TRUE if initiation started successfully
67         * _name_: connection name to initiate
68         * _host_: server hostname (and identity)
69         * _id_: client identity to use
70         * _channel_: XPC endpoint for this connection
71
72 The start_connection() RPC returns just after the initation of the call and
73 does not wait for the connection to establish. Nonetheless does it have a
74 return value to indicate if connection initiation could be triggered.
75
76 The App passes an (anonymous) XPC endpoint to start_connection(). If the call
77 succeeds, charon-xpc connects to this endpoint to establish a channel used for
78 this specific IKE connection.
79
80 On this channel, the following RPC calls are currently defined from charon-xpc
81 to the App:
82
83 * string password = get_password(string username)
84         * _password_: user password returned
85         * _username_: username to query a password for
86
87 And the following from the App to charon-xpc:
88
89 * bool success = stop_connection()
90         * _success_: TRUE if termination of connection initiated
91
92 The following events are currently defined from charon-xpc to the App:
93
94 * up(): IKE_SA has been established
95 * down(): IKE_SA has been closed or failed to establish
96 * child_up(string local_ts, string remote_ts): CHILD_SA has been established
97 * child_down(string local_ts, string remote_ts): CHILD_SA has been closed
98 * log(string message): debug log message for this connection