sal.h 33.3 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
/*
linphone
Copyright (C) 2010  Simon MORLAT (simon.morlat@free.fr)

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
*/

20
/**
21
 This header files defines the Signaling Abstraction Layer.
22
 The purpose of this layer is too allow experiment different call signaling
23
24
25
26
27
28
 protocols and implementations under linphone, for example SIP, JINGLE...
**/

#ifndef sal_h
#define sal_h

29
30
31
32
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

jehan's avatar
jehan committed
33
#include "mediastreamer2/mediastream.h"
34
#include "ortp/rtpsession.h"
35
#include "belle-sip/belle-sip.h"
36

jehan's avatar
jehan committed
37
38
#ifndef LINPHONE_PUBLIC
	#define LINPHONE_PUBLIC MS2_PUBLIC
39
40
#endif

Simon Morlat's avatar
Simon Morlat committed
41
42
43
44
45
/*Dirty hack, keep in sync with mediastreamer2/include/mediastream.h */
#ifndef PAYLOAD_TYPE_FLAG_CAN_RECV
#define PAYLOAD_TYPE_FLAG_CAN_RECV	PAYLOAD_TYPE_USER_FLAG_1
#define PAYLOAD_TYPE_FLAG_CAN_SEND	PAYLOAD_TYPE_USER_FLAG_2
#endif
46
47
48
49
50
51
52
53
struct Sal;

typedef struct Sal Sal;

struct SalOp;

typedef struct SalOp SalOp;

54
55
56
57
struct SalAddress;

typedef struct SalAddress SalAddress;

58
59
60
61
struct SalCustomHeader;

typedef struct SalCustomHeader SalCustomHeader;

62
63
64
65
struct SalCustomSdpAttribute;

typedef struct SalCustomSdpAttribute SalCustomSdpAttribute;

66
67
struct addrinfo;

68
69
70
71
typedef enum {
	SalTransportUDP, /*UDP*/
	SalTransportTCP, /*TCP*/
	SalTransportTLS, /*TLS*/
72
	SalTransportDTLS, /*DTLS*/
73
74
}SalTransport;

jehan's avatar
jehan committed
75
76
77
78
79
80
81
82
#define SAL_MEDIA_DESCRIPTION_UNCHANGED						0x00
#define SAL_MEDIA_DESCRIPTION_NETWORK_CHANGED				(1)
#define SAL_MEDIA_DESCRIPTION_CODEC_CHANGED					(1<<1)
#define SAL_MEDIA_DESCRIPTION_CRYPTO_KEYS_CHANGED			(1<<2)
#define SAL_MEDIA_DESCRIPTION_CRYPTO_POLICY_CHANGED			(1<<3)
#define SAL_MEDIA_DESCRIPTION_STREAMS_CHANGED				(1<<4)
#define SAL_MEDIA_DESCRIPTION_NETWORK_XXXCAST_CHANGED		(1<<5) /* use to notify when switching from multicast to unicast*/
#define SAL_MEDIA_DESCRIPTION_FORCE_STREAM_RECONSTRUCTION	(1<<6) /* use force graph reconstruction*/
83
#define SAL_MEDIA_DESCRIPTION_ICE_RESTART_DETECTED			(1<<7)
jehan's avatar
jehan committed
84
85


86

87
88
const char* sal_transport_to_string(SalTransport transport);
SalTransport sal_transport_parse(const char*);
89
90
91
/* Address manipulation API*/
SalAddress * sal_address_new(const char *uri);
SalAddress * sal_address_clone(const SalAddress *addr);
92
93
SalAddress * sal_address_ref(SalAddress *addr);
void sal_address_unref(SalAddress *addr);
94
95
const char *sal_address_get_scheme(const SalAddress *addr);
const char *sal_address_get_display_name(const SalAddress* addr);
jehan's avatar
jehan committed
96
const char *sal_address_get_display_name_unquoted(const SalAddress *addr);
97
98
const char *sal_address_get_username(const SalAddress *addr);
const char *sal_address_get_domain(const SalAddress *addr);
99
int sal_address_get_port(const SalAddress *addr);
100
bool_t sal_address_is_secure(const SalAddress *addr);
101
void sal_address_set_secure(SalAddress *addr, bool_t enabled);
102

103
SalTransport sal_address_get_transport(const SalAddress* addr);
104
const char* sal_address_get_transport_name(const SalAddress* addr);
105
const char *sal_address_get_method_param(const SalAddress *addr);
jehan's avatar
jehan committed
106

107
108
109
void sal_address_set_display_name(SalAddress *addr, const char *display_name);
void sal_address_set_username(SalAddress *addr, const char *username);
void sal_address_set_domain(SalAddress *addr, const char *host);
110
void sal_address_set_port(SalAddress *uri, int port);
111
112
113
114
void sal_address_clean(SalAddress *addr);
char *sal_address_as_string(const SalAddress *u);
char *sal_address_as_string_uri_only(const SalAddress *u);
void sal_address_destroy(SalAddress *u);
115
116
void sal_address_set_param(SalAddress *u,const char* name,const char* value);
void sal_address_set_transport(SalAddress* addr,SalTransport transport);
117
void sal_address_set_transport_name(SalAddress* addr,const char* transport);
118
void sal_address_set_method_param(SalAddress *addr, const char *method);
119
120
void sal_address_set_params(SalAddress *addr, const char *params);
void sal_address_set_uri_params(SalAddress *addr, const char *params);
121
bool_t sal_address_is_ipv6(const SalAddress *addr);
122
bool_t sal_address_is_sip(const SalAddress *addr);
123
124
125
void sal_address_set_password(SalAddress *addr, const char *passwd);
const char *sal_address_get_password(const SalAddress *addr);
void sal_address_set_header(SalAddress *addr, const char *header_name, const char *header_value);
Simon Morlat's avatar
Simon Morlat committed
126

127
LINPHONE_PUBLIC Sal * sal_init(void);
Ghislain MARY's avatar
Ghislain MARY committed
128
LINPHONE_PUBLIC void sal_uninit(Sal* sal);
Simon Morlat's avatar
Simon Morlat committed
129
130
void sal_set_user_pointer(Sal *sal, void *user_data);
void *sal_get_user_pointer(const Sal *sal);
131
132
133


typedef enum {
134
135
	SalAudio,
	SalVideo,
136
	SalText,
137
	SalOther
138
} SalStreamType;
jehan's avatar
jehan committed
139
const char* sal_stream_type_to_string(SalStreamType type);
140

Simon Morlat's avatar
Simon Morlat committed
141
typedef enum{
142
	SalProtoRtpAvp,
143
	SalProtoRtpSavp,
144
145
	SalProtoRtpAvpf,
	SalProtoRtpSavpf,
johan's avatar
johan committed
146
147
	SalProtoUdpTlsRtpSavp,
	SalProtoUdpTlsRtpSavpf,
148
	SalProtoOther
Simon Morlat's avatar
Simon Morlat committed
149
}SalMediaProto;
jehan's avatar
jehan committed
150
const char* sal_media_proto_to_string(SalMediaProto type);
Simon Morlat's avatar
Simon Morlat committed
151

Simon Morlat's avatar
Simon Morlat committed
152
153
154
155
156
157
typedef enum{
	SalStreamSendRecv,
	SalStreamSendOnly,
	SalStreamRecvOnly,
	SalStreamInactive
}SalStreamDir;
jehan's avatar
jehan committed
158
const char* sal_stream_dir_to_string(SalStreamDir type);
Simon Morlat's avatar
Simon Morlat committed
159

jehan's avatar
jehan committed
160

161
162
#define SAL_ENDPOINT_CANDIDATE_MAX 2

163
164
165
166
167
168
169
170
171
172
173
#define SAL_MEDIA_DESCRIPTION_MAX_ICE_ADDR_LEN 64
#define SAL_MEDIA_DESCRIPTION_MAX_ICE_FOUNDATION_LEN 32
#define SAL_MEDIA_DESCRIPTION_MAX_ICE_TYPE_LEN 6

typedef struct SalIceCandidate {
	char addr[SAL_MEDIA_DESCRIPTION_MAX_ICE_ADDR_LEN];
	char raddr[SAL_MEDIA_DESCRIPTION_MAX_ICE_ADDR_LEN];
	char foundation[SAL_MEDIA_DESCRIPTION_MAX_ICE_FOUNDATION_LEN];
	char type[SAL_MEDIA_DESCRIPTION_MAX_ICE_TYPE_LEN];
	unsigned int componentID;
	unsigned int priority;
174
	int port;
175
176
	int rport;
} SalIceCandidate;
177

178
#define SAL_MEDIA_DESCRIPTION_MAX_ICE_CANDIDATES 20
179
180
181
182
183
184
185

typedef struct SalIceRemoteCandidate {
	char addr[SAL_MEDIA_DESCRIPTION_MAX_ICE_ADDR_LEN];
	int port;
} SalIceRemoteCandidate;

#define SAL_MEDIA_DESCRIPTION_MAX_ICE_REMOTE_CANDIDATES 2
186

187
188
#define SAL_MEDIA_DESCRIPTION_MAX_ICE_UFRAG_LEN 256
#define SAL_MEDIA_DESCRIPTION_MAX_ICE_PWD_LEN 256
189

190
/*sufficient for 256bit keys encoded in base 64*/
191
#define SAL_SRTP_KEY_SIZE 128
192

193
194
typedef struct SalSrtpCryptoAlgo {
	unsigned int tag;
jehan's avatar
jehan committed
195
	MSCryptoSuite algo;
196
	char master_key[SAL_SRTP_KEY_SIZE];
197
198
199
200
} SalSrtpCryptoAlgo;

#define SAL_CRYPTO_ALGO_MAX 4

johan's avatar
johan committed
201
202
203
204
205
206
207
typedef enum {
	SalDtlsRoleInvalid,
	SalDtlsRoleIsServer,
	SalDtlsRoleIsClient,
	SalDtlsRoleUnset
} SalDtlsRole;

jehan's avatar
jehan committed
208
typedef enum {
209
210
211
	SalMulticastInactive=0,
	SalMulticastSender,
	SalMulticastReceiver,
jehan's avatar
jehan committed
212
213
214
	SalMulticastSenderReceiver
} SalMulticastRole;

215
216
217
218
219
typedef enum {
	SalOpSDPNormal = 0, /** No special handling for SDP */
	SalOpSDPSimulateError, /** Will simulate an SDP parsing error */
	SalOpSDPSimulateRemove /** Will simulate no SDP in the op */
} SalOpSDPHandling;
jehan's avatar
jehan committed
220

221
typedef struct SalStreamDescription{
222
	char name[16]; /*unique name of stream, in order to ease offer/answer model algorithm*/
Simon Morlat's avatar
Simon Morlat committed
223
	SalMediaProto proto;
224
	SalStreamType type;
225
	char typeother[32];
226
	char proto_other[32];
227
228
	char rtp_addr[64];
	char rtcp_addr[64];
229
	unsigned int rtp_ssrc;
230
	char rtcp_cname[256];
231
232
	int rtp_port;
	int rtcp_port;
233
234
	MSList *payloads; /*<list of PayloadType */
	MSList *already_assigned_payloads; /*<list of PayloadType offered in the past, used for correct allocation of payload type numbers*/
235
236
	int bandwidth;
	int ptime;
Simon Morlat's avatar
Simon Morlat committed
237
	SalStreamDir dir;
238
	SalSrtpCryptoAlgo crypto[SAL_CRYPTO_ALGO_MAX];
239
	unsigned int crypto_local_tag;
240
	int max_rate;
241
	OrtpRtcpFbConfiguration rtcp_fb;
242
	OrtpRtcpXrConfiguration rtcp_xr;
243
	SalCustomSdpAttribute *custom_sdp_attributes;
244
245
246
247
248
	SalIceCandidate ice_candidates[SAL_MEDIA_DESCRIPTION_MAX_ICE_CANDIDATES];
	SalIceRemoteCandidate ice_remote_candidates[SAL_MEDIA_DESCRIPTION_MAX_ICE_REMOTE_CANDIDATES];
	char ice_ufrag[SAL_MEDIA_DESCRIPTION_MAX_ICE_UFRAG_LEN];
	char ice_pwd[SAL_MEDIA_DESCRIPTION_MAX_ICE_PWD_LEN];
	bool_t ice_mismatch;
249
	bool_t ice_completed;
250
251
	bool_t rtcp_mux;
	bool_t pad[1];
johan's avatar
johan committed
252
253
	char dtls_fingerprint[256];
	SalDtlsRole dtls_role;
jehan's avatar
jehan committed
254
255
	int ttl; /*for multicast -1 to disable*/
	SalMulticastRole multicast_role;
256
257
} SalStreamDescription;

258
259
260
261
const char *sal_stream_description_get_type_as_string(const SalStreamDescription *desc);
const char *sal_stream_description_get_proto_as_string(const SalStreamDescription *desc);

#define SAL_MEDIA_DESCRIPTION_MAX_STREAMS 8
Simon Morlat's avatar
Simon Morlat committed
262

263
typedef struct SalMediaDescription{
264
	int refcount;
265
	char name[64];
266
267
	char addr[64];
	char username[64];
268
	int nb_streams;
269
	int bandwidth;
270
271
	unsigned int session_ver;
	unsigned int session_id;
272
	SalStreamDir dir;
Simon Morlat's avatar
Simon Morlat committed
273
	SalStreamDescription streams[SAL_MEDIA_DESCRIPTION_MAX_STREAMS];
274
	SalCustomSdpAttribute *custom_sdp_attributes;
275
	OrtpRtcpXrConfiguration rtcp_xr;
276
277
278
279
	char ice_ufrag[SAL_MEDIA_DESCRIPTION_MAX_ICE_UFRAG_LEN];
	char ice_pwd[SAL_MEDIA_DESCRIPTION_MAX_ICE_PWD_LEN];
	bool_t ice_lite;
	bool_t ice_completed;
280
	bool_t pad[2];
281
282
} SalMediaDescription;

283
284
285
286
287
typedef struct SalMessage{
	const char *from;
	const char *text;
	const char *url;
	const char *message_id;
288
	const char *content_type;
289
	time_t time;
290
291
}SalMessage;

292
293
294
295
296
typedef struct SalIsComposing {
	const char *from;
	const char *text;
} SalIsComposing;

297
298
#define SAL_MEDIA_DESCRIPTION_MAX_MESSAGE_ATTRIBUTES 5

299
SalMediaDescription *sal_media_description_new(void);
300
SalMediaDescription * sal_media_description_ref(SalMediaDescription *md);
301
void sal_media_description_unref(SalMediaDescription *md);
Simon Morlat's avatar
Simon Morlat committed
302
bool_t sal_media_description_empty(const SalMediaDescription *md);
303
int sal_media_description_equals(const SalMediaDescription *md1, const SalMediaDescription *md2);
304
char * sal_media_description_print_differences(int result);
Simon Morlat's avatar
Simon Morlat committed
305
bool_t sal_media_description_has_dir(const SalMediaDescription *md, SalStreamDir dir);
306
LINPHONE_PUBLIC SalStreamDescription *sal_media_description_find_stream(SalMediaDescription *md, SalMediaProto proto, SalStreamType type);
307
308
309
310
unsigned int sal_media_description_nb_active_streams_of_type(SalMediaDescription *md, SalStreamType type);
SalStreamDescription * sal_media_description_get_active_stream_of_type(SalMediaDescription *md, SalStreamType type, unsigned int idx);
SalStreamDescription * sal_media_description_find_secure_stream_of_type(SalMediaDescription *md, SalStreamType type);
SalStreamDescription * sal_media_description_find_best_stream(SalMediaDescription *md, SalStreamType type);
Simon Morlat's avatar
Simon Morlat committed
311
void sal_media_description_set_dir(SalMediaDescription *md, SalStreamDir stream_dir);
312
313
314
bool_t sal_stream_description_active(const SalStreamDescription *sd);
bool_t sal_stream_description_has_avpf(const SalStreamDescription *sd);
bool_t sal_stream_description_has_srtp(const SalStreamDescription *sd);
johan's avatar
johan committed
315
bool_t sal_stream_description_has_dtls(const SalStreamDescription *sd);
316
317
bool_t sal_media_description_has_avpf(const SalMediaDescription *md);
bool_t sal_media_description_has_srtp(const SalMediaDescription *md);
johan's avatar
johan committed
318
bool_t sal_media_description_has_dtls(const SalMediaDescription *md);
319
int sal_media_description_get_nb_active_streams(const SalMediaDescription *md);
Simon Morlat's avatar
Simon Morlat committed
320

321

Simon Morlat's avatar
Simon Morlat committed
322
323
324
/*this structure must be at the first byte of the SalOp structure defined by implementors*/
typedef struct SalOpBase{
	Sal *root;
325
	char *route; /*or request-uri for REGISTER*/
326
	MSList* route_addresses; /*list of SalAddress* */
jehan's avatar
jehan committed
327
	SalAddress* contact_address;
Simon Morlat's avatar
Simon Morlat committed
328
	char *from;
jehan's avatar
jehan committed
329
	SalAddress* from_address;
Simon Morlat's avatar
Simon Morlat committed
330
	char *to;
jehan's avatar
jehan committed
331
	SalAddress* to_address;
332
	char *origin;
jehan's avatar
jehan committed
333
	SalAddress* origin_address;
334
	char *remote_ua;
335
336
	SalAddress* remote_contact_address;
	char *remote_contact;
Simon Morlat's avatar
Simon Morlat committed
337
338
	SalMediaDescription *local_media;
	SalMediaDescription *remote_media;
Simon Morlat's avatar
Simon Morlat committed
339
	void *user_pointer;
jehan's avatar
jehan committed
340
	const char* call_id;
341
	char* realm;
jehan's avatar
jehan committed
342
	SalAddress* service_route; /*as defined by rfc3608, might be a list*/
Simon Morlat's avatar
Simon Morlat committed
343
344
	SalCustomHeader *sent_custom_headers;
	SalCustomHeader *recv_custom_headers;
Simon Morlat's avatar
Simon Morlat committed
345
346
} SalOpBase;

347

348
typedef enum SalReason{
349
	SalReasonNone, /*no error, please leave first so that it takes 0 value*/
350
351
352
353
	SalReasonDeclined,
	SalReasonBusy,
	SalReasonRedirect,
	SalReasonTemporarilyUnavailable,
354
	SalReasonRequestTimeout,
355
356
	SalReasonNotFound,
	SalReasonDoNotDisturb,
357
	SalReasonUnsupportedContent,
358
	SalReasonForbidden,
359
	SalReasonUnknown,
360
	SalReasonServiceUnavailable,
jehan's avatar
jehan committed
361
	SalReasonRequestPending,
362
	SalReasonUnauthorized,
363
	SalReasonNotAcceptable,
364
365
366
367
368
369
	SalReasonNoMatch, /*equivalent to 481 Transaction/Call leg does not exist*/
	SalReasonMovedPermanently,
	SalReasonGone,
	SalReasonAddressIncomplete,
	SalReasonNotImplemented,
	SalReasonBadGateway,
370
	SalReasonServerTimeout,
371
372
	SalReasonIOError,
	SalReasonInternalError
373
374
}SalReason;

jehan's avatar
jehan committed
375
376
const char* sal_reason_to_string(const SalReason reason);

377
378
379
380
381
382
383
384
typedef struct SalErrorInfo{
	SalReason reason;
	char *status_string;
	int protocol_code;
	char *warnings;
	char *full_string; /*concatenation of status_string + warnings*/
}SalErrorInfo;

385
386
387
388
389
390
391
392
393
394
395
typedef enum SalPresenceStatus{
	SalPresenceOffline,
	SalPresenceOnline,
	SalPresenceBusy,
	SalPresenceBerightback,
	SalPresenceAway,
	SalPresenceOnthephone,
	SalPresenceOuttolunch,
	SalPresenceDonotdisturb,
	SalPresenceMoved,
	SalPresenceAltService,
396
	SalPresenceOnVacation
397
398
}SalPresenceStatus;

399
400
401
struct _SalPresenceModel;
typedef struct _SalPresenceModel SalPresenceModel;

jehan's avatar
jehan committed
402
403
const char* sal_presence_status_to_string(const SalPresenceStatus status);

404
405
406
407
408
409
410
typedef enum SalReferStatus{
	SalReferTrying,
	SalReferSuccess,
	SalReferFailed
}SalReferStatus;

typedef enum SalSubscribeStatus{
411
412
	SalSubscribeNone,
	SalSubscribePending,
413
414
	SalSubscribeActive,
	SalSubscribeTerminated
415
}SalSubscribeStatus;
416

417
418
419
420
421
typedef enum SalTextDeliveryStatus{
	SalTextDeliveryInProgress,
	SalTextDeliveryDone,
	SalTextDeliveryFailed
}SalTextDeliveryStatus;
422

423
424
425
/**
 * auth event mode
 * */
jehan's avatar
jehan committed
426
typedef enum SalAuthMode { /*this enum must be same as belle_sip_auth_mode_t*/
427
428
429
430
431
432
433
434
435
436
437
438
	SalAuthModeHttpDigest, /** Digest authentication requested*/
	SalAuthModeTls /** Client certificate requested*/
}SalAuthMode;

struct _SalCertificatesChain;
typedef struct _SalCertificatesChain SalCertificatesChain;
struct _SalSigningKey;
typedef struct _SalSigningKey SalSigningKey;

/**
 * Format of certificate buffer
 * */
jehan's avatar
jehan committed
439
typedef enum SalCertificateRawFormat {/*this enum must be same as belle_sip_certificate_raw_format_t*/
440
441
442
443
444
445
	SAL_CERTIFICATE_RAW_FORMAT_PEM, /** PEM format*/
	SAL_CERTIFICATE_RAW_FORMAT_DER /** ASN.1 raw format*/
}SalCertificateRawFormat;



jehan's avatar
jehan committed
446
447
448
449
450
typedef struct SalAuthInfo{
	char *username;
	char *userid;
	char *password;
	char *realm;
451
	char *domain;
jehan's avatar
jehan committed
452
	char *ha1;
453
454
455
	SalAuthMode mode;
	SalSigningKey *key;
	SalCertificatesChain *certificates;
jehan's avatar
jehan committed
456
457
}SalAuthInfo;

Simon Morlat's avatar
Simon Morlat committed
458
459
460
461
462
typedef struct SalBody{
	const char *type;
	const char *subtype;
	const void *data;
	size_t size;
463
	const char *encoding;
Simon Morlat's avatar
Simon Morlat committed
464
465
}SalBody;

466
467
468
typedef void (*SalOnCallReceived)(SalOp *op);
typedef void (*SalOnCallRinging)(SalOp *op);
typedef void (*SalOnCallAccepted)(SalOp *op);
469
typedef void (*SalOnCallAck)(SalOp *op);
470
typedef void (*SalOnCallUpdating)(SalOp *op, bool_t is_update);/*< Called when a reINVITE/UPDATE is received*/
Simon Morlat's avatar
Simon Morlat committed
471
typedef void (*SalOnCallTerminated)(SalOp *op, const char *from);
472
typedef void (*SalOnCallFailure)(SalOp *op);
473
typedef void (*SalOnCallReleased)(SalOp *salop);
jehan's avatar
jehan committed
474
typedef void (*SalOnAuthRequestedLegacy)(SalOp *op, const char *realm, const char *username);
jehan's avatar
jehan committed
475
typedef bool_t (*SalOnAuthRequested)(Sal *sal,SalAuthInfo* info);
jehan's avatar
jehan committed
476
typedef void (*SalOnAuthFailure)(SalOp *op, SalAuthInfo* info);
477
typedef void (*SalOnRegisterSuccess)(SalOp *op, bool_t registered);
478
typedef void (*SalOnRegisterFailure)(SalOp *op);
479
480
481
typedef void (*SalOnVfuRequest)(SalOp *op);
typedef void (*SalOnDtmfReceived)(SalOp *op, char dtmf);
typedef void (*SalOnRefer)(Sal *sal, SalOp *op, const char *referto);
482
typedef void (*SalOnTextReceived)(SalOp *op, const SalMessage *msg);
483
typedef void (*SalOnTextDeliveryUpdate)(SalOp *op, SalTextDeliveryStatus);
484
typedef void (*SalOnIsComposingReceived)(SalOp *op, const SalIsComposing *is_composing);
485
typedef void (*SalOnNotifyRefer)(SalOp *op, SalReferStatus state);
486
typedef void (*SalOnSubscribeResponse)(SalOp *op, SalSubscribeStatus status);
487
488
489
typedef void (*SalOnNotify)(SalOp *op, SalSubscribeStatus status, const char *event, const SalBody *body);
typedef void (*SalOnSubscribeReceived)(SalOp *salop, const char *event, const SalBody *body);
typedef void (*SalOnSubscribeClosed)(SalOp *salop);
490
typedef void (*SalOnParsePresenceRequested)(SalOp *salop, const char *content_type, const char *content_subtype, const char *content, SalPresenceModel **result);
491
typedef void (*SalOnConvertPresenceToXMLRequested)(SalOp *salop, SalPresenceModel *presence, const char *contact, char **content);
492
typedef void (*SalOnNotifyPresence)(SalOp *op, SalSubscribeStatus ss, SalPresenceModel *model, const char *msg);
493
494
typedef void (*SalOnSubscribePresenceReceived)(SalOp *salop, const char *from);
typedef void (*SalOnSubscribePresenceClosed)(SalOp *salop, const char *from);
495
typedef void (*SalOnPingReply)(SalOp *salop);
Simon Morlat's avatar
Simon Morlat committed
496
typedef void (*SalOnInfoReceived)(SalOp *salop, const SalBody *body);
497
typedef void (*SalOnPublishResponse)(SalOp *salop);
498
typedef void (*SalOnExpire)(SalOp *salop);
jehan's avatar
jehan committed
499
500
501
/*allows sal implementation to access auth info if available, return TRUE if found*/


502

Simon Morlat's avatar
Simon Morlat committed
503
504
505
506
typedef struct SalCallbacks{
	SalOnCallReceived call_received;
	SalOnCallRinging call_ringing;
	SalOnCallAccepted call_accepted;
507
	SalOnCallAck call_ack;
508
	SalOnCallUpdating call_updating;
Simon Morlat's avatar
Simon Morlat committed
509
510
	SalOnCallTerminated call_terminated;
	SalOnCallFailure call_failure;
511
	SalOnCallReleased call_released;
jehan's avatar
jehan committed
512
	SalOnAuthFailure auth_failure;
513
514
515
516
517
518
	SalOnRegisterSuccess register_success;
	SalOnRegisterFailure register_failure;
	SalOnVfuRequest vfu_request;
	SalOnDtmfReceived dtmf_received;
	SalOnRefer refer_received;
	SalOnTextReceived text_received;
519
	SalOnTextDeliveryUpdate text_delivery_update;
520
	SalOnIsComposingReceived is_composing_received;
521
	SalOnNotifyRefer notify_refer;
Simon Morlat's avatar
Simon Morlat committed
522
	SalOnSubscribeReceived subscribe_received;
523
	SalOnSubscribeClosed subscribe_closed;
524
525
526
527
	SalOnSubscribeResponse subscribe_response;
	SalOnNotify notify;
	SalOnSubscribePresenceReceived subscribe_presence_received;
	SalOnSubscribePresenceClosed subscribe_presence_closed;
528
	SalOnParsePresenceRequested parse_presence_requested;
529
	SalOnConvertPresenceToXMLRequested convert_presence_to_xml_requested;
530
	SalOnNotifyPresence notify_presence;
531
	SalOnPingReply ping_reply;
jehan's avatar
jehan committed
532
	SalOnAuthRequested auth_requested;
Simon Morlat's avatar
Simon Morlat committed
533
	SalOnInfoReceived info_received;
534
535
	SalOnPublishResponse on_publish_response;
	SalOnExpire on_expire;
Simon Morlat's avatar
Simon Morlat committed
536
537
}SalCallbacks;

jehan's avatar
jehan committed
538

539

540
SalAuthInfo* sal_auth_info_new(void);
jehan's avatar
jehan committed
541
SalAuthInfo* sal_auth_info_clone(const SalAuthInfo* auth_info);
542
void sal_auth_info_delete(SalAuthInfo* auth_info);
543
LINPHONE_PUBLIC int sal_auth_compute_ha1(const char* userid,const char* realm,const char* password, char ha1[33]);
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
SalAuthMode sal_auth_info_get_mode(const SalAuthInfo* auth_info);
SalSigningKey *sal_auth_info_get_signing_key(const SalAuthInfo* auth_info);
SalCertificatesChain *sal_auth_info_get_certificates_chain(const SalAuthInfo* auth_info);
void sal_auth_info_set_mode(SalAuthInfo* auth_info, SalAuthMode mode);

/** Parse a file containing either a certificate chain order in PEM format or a single DER cert
 * @param auth_info structure where to store the result of parsing
 * @param path path to certificate chain file
 * @param format either PEM or DER
 */
void sal_certificates_chain_parse_file(SalAuthInfo* auth_info, const char* path, SalCertificateRawFormat format);

/**
 * Parse a file containing either a private or public rsa key
 * @param auth_info structure where to store the result of parsing
 * @param passwd password (optionnal)
 */
void sal_signing_key_parse_file(SalAuthInfo* auth_info, const char* path, const char *passwd);

johan's avatar
johan committed
563
564
565
566
567
568
569
570
571
572
/**
 * Parse a directory for files containing certificate with the given subject CNAME
 * @param[out]	certificate_pem				the address of a string to store the certificate in PEM format. To be freed by caller
 * @param[out]	key_pem						the address of a string to store the key in PEM format. To be freed by caller
 * @param[in]	path						directory to parse
 * @param[in]	subject						subject CNAME
 * @param[in]	format 						either PEM or DER
 * @param[in]	generate_certificate		if true, if matching certificate and key can't be found, generate it and store it into the given dir, filename will be subject.pem
 * @param[in]	generate_dtls_fingerprint	if true and we have a certificate, generate the dtls fingerprint as described in rfc4572
 */
Guillaume BIENKOWSKI's avatar
Guillaume BIENKOWSKI committed
573
void sal_certificates_chain_parse_directory(char **certificate_pem, char **key_pem, char **fingerprint, const char* path, const char *subject, SalCertificateRawFormat format, bool_t generate_certificate, bool_t generate_dtls_fingerprint);
johan's avatar
johan committed
574

575
576
577
578
void sal_certificates_chain_delete(SalCertificatesChain *chain);
void sal_signing_key_delete(SalSigningKey *key);


jehan's avatar
jehan committed
579

Simon Morlat's avatar
Simon Morlat committed
580
void sal_set_callbacks(Sal *ctx, const SalCallbacks *cbs);
581
int sal_listen_port(Sal *ctx, const char *addr, int port, SalTransport tr, int is_tunneled);
582
int sal_get_listening_port(Sal *ctx, SalTransport tr);
583
int sal_unlisten_ports(Sal *ctx);
Ghislain MARY's avatar
Ghislain MARY committed
584
LINPHONE_PUBLIC int sal_transport_available(Sal *ctx, SalTransport t);
585
void sal_set_dscp(Sal *ctx, int dscp);
586
587
588
589
void sal_set_supported_tags(Sal *ctx, const char* tags);
void sal_add_supported_tag(Sal *ctx, const char* tag);
void sal_remove_supported_tag(Sal *ctx, const char* tag);
const char *sal_get_supported_tags(Sal *ctx);
590
int sal_reset_transports(Sal *ctx);
591
ortp_socket_t sal_get_socket(Sal *ctx);
592
void sal_set_user_agent(Sal *ctx, const char *user_agent);
593
const char* sal_get_user_agent(Sal *ctx);
594
void sal_append_stack_string_to_user_agent(Sal *ctx);
595
596
/*keepalive period in ms*/
void sal_set_keepalive_period(Sal *ctx,unsigned int value);
597
void sal_use_tcp_tls_keepalive(Sal *ctx, bool_t enabled);
598
int sal_set_tunnel(Sal *ctx, void *tunnelclient);
599
600
601
/*Default value is true*/
void sal_enable_sip_update_method(Sal *ctx,bool_t value);

jehan's avatar
jehan committed
602
603
604
605
606
/**
 * returns keepalive period in ms
 * 0 desactiaved
 * */
unsigned int sal_get_keepalive_period(Sal *ctx);
607
void sal_use_session_timers(Sal *ctx, int expires);
608
void sal_use_dates(Sal *ctx, bool_t enabled);
Simon Morlat's avatar
Simon Morlat committed
609
void sal_use_one_matching_codec_policy(Sal *ctx, bool_t one_matching_codec);
610
void sal_use_rport(Sal *ctx, bool_t use_rports);
611
void sal_enable_auto_contacts(Sal *ctx, bool_t enabled);
612
void sal_set_root_ca(Sal* ctx, const char* rootCa);
613
const char *sal_get_root_ca(Sal* ctx);
614
void sal_verify_server_certificates(Sal *ctx, bool_t verify);
615
void sal_verify_server_cn(Sal *ctx, bool_t verify);
616
617
void sal_set_uuid(Sal*ctx, const char *uuid);
int sal_create_uuid(Sal*ctx, char *uuid, size_t len);
618
LINPHONE_PUBLIC void sal_enable_test_features(Sal*ctx, bool_t enabled);
619
void sal_use_no_initial_route(Sal *ctx, bool_t enabled);
620

Simon Morlat's avatar
Simon Morlat committed
621
int sal_iterate(Sal *sal);
622
MSList * sal_get_pending_auths(Sal *sal);
Simon Morlat's avatar
Simon Morlat committed
623
624
625
626
627

/*create an operation */
SalOp * sal_op_new(Sal *sal);

/*generic SalOp API, working for all operations */
628
Sal *sal_op_get_sal(const SalOp *op);
jehan's avatar
jehan committed
629
void sal_op_set_contact_address(SalOp *op, const SalAddress* address);
Simon Morlat's avatar
Simon Morlat committed
630
void sal_op_set_route(SalOp *op, const char *route);
jehan's avatar
jehan committed
631
void sal_op_set_route_address(SalOp *op, const SalAddress* address);
632
void sal_op_add_route_address(SalOp *op, const SalAddress* address);
633
void sal_op_set_realm(SalOp *op, const char *realm);
Simon Morlat's avatar
Simon Morlat committed
634
void sal_op_set_from(SalOp *op, const char *from);
jehan's avatar
jehan committed
635
void sal_op_set_from_address(SalOp *op, const SalAddress *from);
Simon Morlat's avatar
Simon Morlat committed
636
void sal_op_set_to(SalOp *op, const char *to);
jehan's avatar
jehan committed
637
void sal_op_set_to_address(SalOp *op, const SalAddress *to);
638
SalOp *sal_op_ref(SalOp* h);
639
void sal_op_stop_refreshing(SalOp *op);
Simon Morlat's avatar
Simon Morlat committed
640
void sal_op_release(SalOp *h);
641
642
643
/*same as release, but does not stop refresher if any*/
void* sal_op_unref(SalOp* op);

644
void sal_op_authenticate(SalOp *h, const SalAuthInfo *info);
jehan's avatar
jehan committed
645
void sal_op_cancel_authentication(SalOp *h);
Simon Morlat's avatar
Simon Morlat committed
646
void sal_op_set_user_pointer(SalOp *h, void *up);
647
SalAuthInfo * sal_op_get_auth_requested(SalOp *h);
648
const char *sal_op_get_from(const SalOp *op);
jehan's avatar
jehan committed
649
const SalAddress *sal_op_get_from_address(const SalOp *op);
650
const char *sal_op_get_to(const SalOp *op);
jehan's avatar
jehan committed
651
const SalAddress *sal_op_get_to_address(const SalOp *op);
jehan's avatar
jehan committed
652
const SalAddress *sal_op_get_contact_address(const SalOp *op);
Simon Morlat's avatar
Simon Morlat committed
653
const char *sal_op_get_route(const SalOp *op);
654
const MSList* sal_op_get_route_addresses(const SalOp *op);
655
const char *sal_op_get_proxy(const SalOp *op);
656
const char *sal_op_get_remote_contact(const SalOp *op);
657
const SalAddress* sal_op_get_remote_contact_address(const SalOp *op);
658
659
/*for incoming requests, returns the origin of the packet as a sip uri*/
const char *sal_op_get_network_origin(const SalOp *op);
jehan's avatar
jehan committed
660
const SalAddress *sal_op_get_network_origin_address(const SalOp *op);
661
662
/*returns far-end "User-Agent" string */
const char *sal_op_get_remote_ua(const SalOp *op);
Simon Morlat's avatar
Simon Morlat committed
663
void *sal_op_get_user_pointer(const SalOp *op);
jehan's avatar
jehan committed
664
const char* sal_op_get_call_id(const SalOp *op);
665
char* sal_op_get_dialog_id(const SalOp *op);
666
bool_t sal_op_is_forked_of(const SalOp *op1, const SalOp *op2);
667

jehan's avatar
jehan committed
668
669
670
const SalAddress* sal_op_get_service_route(const SalOp *op);
void sal_op_set_service_route(SalOp *op,const SalAddress* service_route);

671
void sal_op_set_manual_refresher_mode(SalOp *op, bool_t enabled);
672
bool_t sal_op_is_ipv6(SalOp *op);
673
674
/*returns TRUE if there is no pending request that may block a future one */
bool_t sal_op_is_idle(SalOp *op);
675

676
677
678
679
680
const SalErrorInfo *sal_error_info_none(void);
const SalErrorInfo *sal_op_get_error_info(const SalOp *op);
void sal_error_info_reset(SalErrorInfo *ei);
void sal_error_info_set(SalErrorInfo *ei, SalReason reason, int code, const char *status_string, const char *warning);

Simon Morlat's avatar
Simon Morlat committed
681
682
683
/*Call API*/
int sal_call_set_local_media_description(SalOp *h, SalMediaDescription *desc);
int sal_call(SalOp *h, const char *from, const char *to);
684
int sal_call_notify_ringing(SalOp *h, bool_t early_media);
685
/*accept an incoming call or, during a call accept a reINVITE*/
686
int sal_call_accept(SalOp*h);
687
int sal_call_decline(SalOp *h, SalReason reason, const char *redirection /*optional*/);
688
int sal_call_update(SalOp *h, const char *subject, bool_t no_user_consent);
689
SalMediaDescription * sal_call_get_remote_media_description(SalOp *h);
Simon Morlat's avatar
Simon Morlat committed
690
SalMediaDescription * sal_call_get_final_media_description(SalOp *h);
691
692
693
694
695
int sal_call_refer(SalOp *h, const char *refer_to);
int sal_call_refer_with_replaces(SalOp *h, SalOp *other_call_h);
int sal_call_accept_refer(SalOp *h);
/*informs this call is consecutive to an incoming refer */
int sal_call_set_referer(SalOp *h, SalOp *refered_call);
696
697
/* returns the SalOp of a call that should be replaced by h, if any */
SalOp *sal_call_get_replaces(SalOp *h);
Simon Morlat's avatar
Simon Morlat committed
698
int sal_call_send_dtmf(SalOp *h, char dtmf);
699
int sal_call_terminate(SalOp *h);
700
bool_t sal_call_autoanswer_asked(SalOp *op);
701
void sal_call_send_vfu_request(SalOp *h);
702
int sal_call_is_offerer(const SalOp *h);
703
int sal_call_notify_refer_state(SalOp *h, SalOp *newcall);
704
/* Call test API */
705
706
707
708
709
710
711
712
713
714
715


/**
 * @brief Invoking this on the SAL will modify every subsequent SalOp to have a special handling for SDP.
 * @details This is especially useful while testing, to simulate some specific behaviors, like missing SDP or an error in parsing.
 *
 * @warning Don't forget to reset the handling method to SalOpSDPNormal afterwards.
 *
 * @param h the Sal instance
 * @param handling_method Could be SalOpSDPNormal, SalOpSDPSimulateError, SalOpSDPSimulateRemoval (\ref SalOpSDPHandling)
 */
716
LINPHONE_PUBLIC void sal_default_set_sdp_handling(Sal* h, SalOpSDPHandling handling_method) ;
717
/* Second version: for a specific call*/
718
LINPHONE_PUBLIC void sal_call_set_sdp_handling(SalOp *h, SalOpSDPHandling handling) ;
719

Simon Morlat's avatar
Simon Morlat committed
720
/*Registration*/
721
int sal_register(SalOp *op, const char *proxy, const char *from, int expires,SalAddress* old_contact);
722
/*refresh a register, -1 mean use the last known value*/
723
int sal_register_refresh(SalOp *op, int expires);
724
int sal_unregister(SalOp *h);
725

Simon Morlat's avatar
Simon Morlat committed
726
/*Messaging */
Simon Morlat's avatar
Simon Morlat committed
727
int sal_text_send(SalOp *op, const char *from, const char *to, const char *text);
728
int sal_message_send(SalOp *op, const char *from, const char *to, const char* content_type, const char *msg, const char *peer_uri);
Simon Morlat's avatar
Simon Morlat committed
729
int sal_message_reply(SalOp *op, SalReason reason);
Simon Morlat's avatar
Simon Morlat committed
730
731

/*presence Subscribe/notify*/
Simon Morlat's avatar
Simon Morlat committed
732
int sal_subscribe_presence(SalOp *op, const char *from, const char *to, int expires);
733
int sal_notify_presence(SalOp *op, SalPresenceModel *presence);
734
int sal_notify_presence_close(SalOp *op);
Simon Morlat's avatar
Simon Morlat committed
735

736
/*presence publish */
737
int sal_publish_presence(SalOp *op, const char *from, const char *to, int expires, SalPresenceModel *presence);
738

739
740
741
742

/*ping: main purpose is to obtain its own contact address behind firewalls*/
int sal_ping(SalOp *op, const char *from, const char *to);

Simon Morlat's avatar
Simon Morlat committed
743
744
745
/*info messages*/
int sal_send_info(SalOp *op, const char *from, const char *to, const SalBody *body);

746
747
748
749
750
751
752
753
/*generic subscribe/notify/publish api*/
int sal_subscribe(SalOp *op, const char *from, const char *to, const char *eventname, int expires, const SalBody *body);
int sal_unsubscribe(SalOp *op);
int sal_subscribe_accept(SalOp *op);
int sal_subscribe_decline(SalOp *op, SalReason reason);
int sal_notify(SalOp *op, const SalBody *body);
int sal_notify_close(SalOp *op);
int sal_publish(SalOp *op, const char *from, const char *to, const char*event_name, int expires, const SalBody *body);
Simon Morlat's avatar
Simon Morlat committed
754

jehan's avatar
jehan committed
755
756
/*privacy, must be in sync with LinphonePrivacyMask*/
typedef enum _SalPrivacy {
Simon Morlat's avatar
Simon Morlat committed
757
	SalPrivacyNone=0x0,
jehan's avatar
jehan committed
758
759
760
761
	SalPrivacyUser=0x1,
	SalPrivacyHeader=0x2,
	SalPrivacySession=0x4,
	SalPrivacyId=0x8,
Simon Morlat's avatar
Simon Morlat committed
762
763
	SalPrivacyCritical=0x10,
	SalPrivacyDefault=0x8000
jehan's avatar
jehan committed
764
765
766
767
768
769
770
771
} SalPrivacy;
typedef  unsigned int SalPrivacyMask;

const char* sal_privacy_to_string(SalPrivacy  privacy);
void sal_op_set_privacy(SalOp* op,SalPrivacy privacy);
SalPrivacy sal_op_get_privacy(const SalOp* op);


772

773
774
#define payload_type_set_number(pt,n)		(pt)->user_data=(void*)((intptr_t)n);
#define payload_type_get_number(pt)		((int)(intptr_t)(pt)->user_data)
775

776
777
778
/*misc*/
void sal_get_default_local_ip(Sal *sal, int address_family, char *ip, size_t iplen);

779
780
typedef void (*SalResolverCallback)(void *data, const char *name, struct addrinfo *ai_list);

Simon Morlat's avatar
Simon Morlat committed
781
782
783
784
typedef struct SalResolverContext SalResolverContext;

SalResolverContext * sal_resolve_a(Sal* sal, const char *name, int port, int family, SalResolverCallback cb, void *data);
//void sal_resolve_cancel(Sal *sal, SalResolverContext *ctx);
785
786
787
788

SalCustomHeader *sal_custom_header_append(SalCustomHeader *ch, const char *name, const char *value);
const char *sal_custom_header_find(const SalCustomHeader *ch, const char *name);
void sal_custom_header_free(SalCustomHeader *ch);
Simon Morlat's avatar
Simon Morlat committed
789
SalCustomHeader *sal_custom_header_clone(const SalCustomHeader *ch);
Simon Morlat's avatar
Simon Morlat committed
790
791
792
793

const SalCustomHeader *sal_op_get_recv_custom_header(SalOp *op);

void sal_op_set_sent_custom_header(SalOp *op, SalCustomHeader* ch);
794

795
796
797
798
799
800

SalCustomSdpAttribute * sal_custom_sdp_attribute_append(SalCustomSdpAttribute *csa, const char *name, const char *value);
const char * sal_custom_sdp_attribute_find(const SalCustomSdpAttribute *csa, const char *name);
void sal_custom_sdp_attribute_free(SalCustomSdpAttribute *csa);
SalCustomSdpAttribute * sal_custom_sdp_attribute_clone(const SalCustomSdpAttribute *csa);

801
/** deprecated. use sal_set_log_level instead **/
802
void sal_enable_log(void);
803
/** deprecated. use sal_set_log_level instead **/
804
void sal_disable_log(void);
805
void sal_set_log_level(OrtpLogLevel level);
Simon Morlat's avatar
Simon Morlat committed
806
807
808

/*internal API */
void __sal_op_init(SalOp *b, Sal *sal);
809
void __sal_op_set_network_origin(SalOp *op, const char *origin /*a sip uri*/);
jehan's avatar
jehan committed
810
void __sal_op_set_network_origin_address(SalOp *op, SalAddress *origin);
811
void __sal_op_set_remote_contact(SalOp *op, const char *ct);
Simon Morlat's avatar
Simon Morlat committed
812
813
void __sal_op_free(SalOp *b);

814
815
/*test api*/
/*0 for no error*/
816
LINPHONE_PUBLIC	void sal_set_send_error(Sal *sal,int value);
jehan's avatar
jehan committed
817
/*1 for no error*/
818
LINPHONE_PUBLIC	void sal_set_recv_error(Sal *sal,int value);
819
820
821
822

/*always answer 480 if value=true*/
LINPHONE_PUBLIC	void sal_enable_unconditional_answer(Sal *sal,int value);

823
824
825
826
827
LINPHONE_PUBLIC bool_t sal_pending_trans_checking_enabled(const Sal *sal) ;
LINPHONE_PUBLIC int sal_enable_pending_trans_checking(Sal *sal, bool_t value) ;



jehan's avatar
jehan committed
828
829
830
/*refresher retry after value in ms*/
LINPHONE_PUBLIC	void sal_set_refresher_retry_after(Sal *sal,int value);
LINPHONE_PUBLIC	int sal_get_refresher_retry_after(const Sal *sal);
jehan's avatar
jehan committed
831
832
833
/*enable contact fixing*/
void sal_nat_helper_enable(Sal *sal,bool_t enable);
bool_t sal_nat_helper_enabled(Sal *sal);
jehan's avatar
jehan committed
834

Sylvain Berfini's avatar
Sylvain Berfini committed
835
LINPHONE_PUBLIC	void sal_set_dns_timeout(Sal* sal,int timeout);
836
LINPHONE_PUBLIC int sal_get_dns_timeout(const Sal* sal);
837
838
LINPHONE_PUBLIC	void sal_set_transport_timeout(Sal* sal,int timeout);
LINPHONE_PUBLIC int sal_get_transport_timeout(const Sal* sal);
839
840
LINPHONE_PUBLIC void sal_enable_dns_srv(Sal *sal, bool_t enable);
LINPHONE_PUBLIC bool_t sal_dns_srv_enabled(const Sal *sal);
841
842
LINPHONE_PUBLIC void sal_set_dns_user_hosts_file(Sal *sal, const char *hosts_file);
LINPHONE_PUBLIC const char *sal_get_dns_user_hosts_file(const Sal *sal);
843
unsigned int sal_get_random(void);
844
LINPHONE_PUBLIC char