LOC-18 Deploy server with ansible
[LocalChat.git] / docs / server-api.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
Server API
============

All requests to the server are placed with the `POST` method, using a JSON request body

The basic structure is

    {
        "action":"[api action]",
        "payload": [json payload]
    }

Which, if successful, will result in a `HTTP 200` and a JSON encapsulated response body.

----

Response Codes
---------------

The following HTTP statuses may be returned

* `200` - Request was successful
* `400` - Invalid request
* `403` - Authentication Invalid/Permission Denied
* `500` - Server had an issue

----

Authentication
---------------

Authentication is performed on a per-room basis, so certain calls (such as `createRoom`) are currently entirely unauthenticated (a form of auth may be introduced for those later).

User's are required to authenticate themselves (via password) when they attempt to enter a room with a `joinRoom` call. If that call is successful then a session key will be provided in the response. This must be embedded into every payload (as attribute `sesskey`) after that.

The server uses `bcrypt` for storing authentication credentials.

----

Supported Actions
-------------------


### banUser

Can only be called by the room admin, kicks a user out of the room, and does not allow them to return (unless re-invited)

    {
        "action":"banUser",
        "payload": {    
                    "roomName": "[name of room]",
                    "user": user,
                    "kick": [user to kick],
                    "sesskey": sessionkey
        }
    }

*Response*

If successful, the value of `status` will be `ok` and the kicked user's session will be terminated and their user record removed. A message will be pushed to the room by `SYSTEM` to note that that user has been kicked and banned.

If the requesting user lacks the privileges to kick a user, `SYSTEM` will push a message to warn that `user` tried to ban `tokick`.

----

### closeRoom

This can only be successfully called by the room's owner. `closeRoom` will close the current room, remove all associated messages, sessions and user accounts.


    {
        "action":"closeRoom",
        "payload": {    
                    "roomName": "[name of room]",
                    "user": user,
                    "sesskey": sessionkey
        }
    }

*Response*

If successful, the value of `status` will be `ok`.

Rooms should always be closed when they are no longer required. The server will (by default) automatically close inactive rooms after a period, but this is intended as a safety net (in case the admin gets disconnected and cannot reconnect for some reason).

----

### createRoom

This is used to create a room. Calls are currently unauthenticated because user accounts are tied to a room rather than existing in a global namespace (this is done to limit the risk of a list of possible users sitting on the server until they're likely to be needed).

    {
        "action":"createRoom",
        "payload": {    
                    "roomName": "[name of room]",
                    "owner": [name of user],
                    "pass": password
        }
    }

When creating a room, we specify the username of the user who will be the room owner/admin, and the password they will use to join the room. In the background this will set up the requisite user account.


*Response*

If the room is successfully created, the value of `status` will be `ok`. The roomname will also be confirmed back as the attribute `name`.

The user will then need to call `joinRoom` in order to enter the room (the client could do this automatically, but the current client version does not).

----

### inviteUser

Used to invite a user into the current room. Can be called by admin's and users alike (`SYSTEM` will push a message into the room to notify others of the invite)

    {
        "action":"inviteUser",
        "payload": {    
                    "roomName": "[name of room]",
                    "user": user,
                    "invite": [user to invite],
                    "pass": [new users pass]
                    "sesskey": sessionkey
        }
    }

When inviting a user, we need to specify their username as `invite` and their authentication password as `pass`

*Response*

If successful, the value of `status` will be `ok`. `SYSTEM` will also push a message into the room that `user` invited `invite`

----

### joinRoom

Used to enter a room.

When the user was invited to the room, a password will have been set for them (the supplied client currently auto-generates that password), it will need to be provided for the user to authenticate.

    {
        "action":"joinRoom",
        "payload": {    
                    "roomName": "[name of room]",
                    "userpass": password,
                    "user": user
        }
    }

*Response*

If authentication is successful, the response will include a number of details that the client will need to take note of for future requests

    {
        "status": "ok",
        "last": last,
        "session": sessionkey,
        "syskey": systemkey
    }
    
The value `last` is the ID of the latest message in the room you've just joined. It should be included in `pollMsg` calls.

The value `sessionkey` is a server generated sessionkey. It must be included in the payload of all future requests (it's used to help authenticate those requests).

The value `syskey` is a decryption passphrase. The server's internal user `SYSTEM` will E2E encrypt any messages it pushes into rooms, this is the key you should use to decrypt those messages.

----

### kickUser

Can only be called by the room admin, kicks a user out of the room (but allows them to return). Useful where you think a user's session has hung (for example)

    {
        "action":"kickUser",
        "payload": {    
                    "roomName": "[name of room]",
                    "user": user,
                    "kick": [user to kick],
                    "sesskey": sessionkey
        }
    }

*Response*

If successful, the value of `status` will be `ok` and the kicked user's session will be terminated. A message will be pushed to the room by `SYSTEM` to note that that user has been kicked.

If the requesting user lacks the privileges to kick a user, `SYSTEM` will push a message to warn that `user` tried to kick `tokick`.

----

### leaveRoom

Used to leave the current room

    {
        "action":"leaveRoom",
        "payload": {    
                    "roomName": "[name of room]",
                    "user": user,
                    "sesskey": sessionkey
        }
    }

*Response*

If successful, the value of `status` will be `ok`. Client's should then disable any automated message polling they are running.

----

### pollMsg

Used to check whether there are any messages since the last the client received. It will return room-wide messages and direct messages addressed to the polling user.

Client provides the ID of the last message they've received, as well as the room they're polling. Where this is the first request, `last` should be 0

    {
        "action":"pollMsg",
        "payload": {    
                    "roomName": "[name of room]",
                    "mylast": "[last]",
                    "user": user,
                    "sesskey": sessionkey
        }
    }


*Response*

If there are no messages, then the response status will be `unchanged`.
If a specific error is being returned, the response status will be `errmessage` - you should disable any automatic polling and the print the content of `text`

If status is `updated` then messages have been returned:

    {
        "status": "updated",
        "messages" : [
                        [msgid,msgtext,timestamp,fromuser,touser],
                        [msgid,msgtext,timestamp,fromuser,touser]    
        ]

    }

Once the client has processed the received messages, the value of `last` in the next `pollMsg` request should be the maximum ID in the resultset.

----

### sendDirectMsg

Used to send a message to a specific user within the room. The message will not be visible to other room occupants.

    {
        "action":"sendDirectMsg",
        "payload": {    
                    "roomName": "[name of room]",
                    "msg": "[message payload]",
                    "to": recipient
                    "user": user,
                    "sesskey": sessionkey
        }
    }

The message payload is encrypted and base64 encoded by the client, so the server only sees a base64 string. 

However, to keep compatability with the supplied client, your message payload (prior to encryption) should be a JSON encapsulated string of the format

        msg = {
            'user': user,
            'text': msg,
            "verb": verb
            }

This should then be PGP encrypted using the room passphrase, and then base64 encoded for embedding into the API payload.
            
Where `verb` is one of `do` or `say` (other values will be treated as `say` by the supplied client).


*Response*

If message sending is successful, the response will contain `status:"ok"`

----

### sendMsg

Used to send a message to the entire room

    {
        "action":"sendMsg",
        "payload": {    
                    "roomName": "[name of room]",
                    "msg": "[message payload]",
                    "user": user,
                    "sesskey": sessionkey
        }
    }

The message payload is encrypted and base64 encoded by the client, so the server only sees a base64 string. 

However, to keep compatability with the supplied client, your message payload (prior to encryption) should be a JSON encapsulated string of the format

        msg = {
            'user': user,
            'text': msg,
            "verb": verb
            }

This should then be PGP encrypted using the room passphrase, and then base64 encoded for embedding into the API payload.
            
Where `verb` is one of `do` or `say` (other values will be treated as `say` by the supplied client).


*Response*

If message sending is successful, the response will contain `status:"ok"`


----