/usr/include/pjsip/sip_transport_tls.h is in libpjproject-dev 2.7.2~dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 | /* $Id: sip_transport_tls.h 5649 2017-09-15 05:32:08Z riza $ */
/*
* Copyright (C) 2008-2011 Teluu Inc. (http://www.teluu.com)
* Copyright (C) 2003-2008 Benny Prijono <benny@prijono.org>
*
* 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
*/
#ifndef __PJSIP_TRANSPORT_TLS_H__
#define __PJSIP_TRANSPORT_TLS_H__
/**
* @file sip_transport_tls.h
* @brief SIP TLS Transport.
*/
#include <pjsip/sip_transport.h>
#include <pj/pool.h>
#include <pj/ssl_sock.h>
#include <pj/string.h>
#include <pj/sock_qos.h>
PJ_BEGIN_DECL
/**
* @defgroup PJSIP_TRANSPORT_TLS TLS Transport
* @ingroup PJSIP_TRANSPORT
* @brief API to create and register TLS transport.
* @{
* The functions below are used to create TLS transport and register
* the transport to the framework.
*/
/**
* The default SSL method to be used by PJSIP.
* Default is PJSIP_TLSV1_METHOD
*/
#ifndef PJSIP_SSL_DEFAULT_METHOD
# define PJSIP_SSL_DEFAULT_METHOD PJSIP_TLSV1_METHOD
#endif
/** SSL protocol method constants. */
typedef enum pjsip_ssl_method
{
PJSIP_SSL_UNSPECIFIED_METHOD = 0, /**< Default protocol method. */
PJSIP_SSLV2_METHOD = 20, /**< Use SSLv2 method. */
PJSIP_SSLV3_METHOD = 30, /**< Use SSLv3 method. */
PJSIP_TLSV1_METHOD = 31, /**< Use TLSv1 method. */
PJSIP_TLSV1_1_METHOD = 32, /**< Use TLSv1_1 method. */
PJSIP_TLSV1_2_METHOD = 33, /**< Use TLSv1_2 method. */
PJSIP_SSLV23_METHOD = 23, /**< Use SSLv23 method. */
} pjsip_ssl_method;
/**
* The default enabled SSL proto to be used.
* Default is all protocol above TLSv1 (TLSv1 & TLS v1.1 & TLS v1.2).
*/
#ifndef PJSIP_SSL_DEFAULT_PROTO
# define PJSIP_SSL_DEFAULT_PROTO (PJ_SSL_SOCK_PROTO_TLS1 | \
PJ_SSL_SOCK_PROTO_TLS1_1 | \
PJ_SSL_SOCK_PROTO_TLS1_2)
#endif
/**
* TLS transport settings.
*/
typedef struct pjsip_tls_setting
{
/**
* Certificate of Authority (CA) list file.
*/
pj_str_t ca_list_file;
/**
* Certificate of Authority (CA) list directory path.
*/
pj_str_t ca_list_path;
/**
* Public endpoint certificate file, which will be used as client-
* side certificate for outgoing TLS connection, and server-side
* certificate for incoming TLS connection.
*/
pj_str_t cert_file;
/**
* Optional private key of the endpoint certificate to be used.
*/
pj_str_t privkey_file;
/**
* Password to open private key.
*/
pj_str_t password;
/**
* TLS protocol method from #pjsip_ssl_method. In the future, this field
* might be deprecated in favor of <b>proto</b> field. For now, this field
* is only applicable only when <b>proto</b> field is set to zero.
*
* Default is PJSIP_SSL_UNSPECIFIED_METHOD (0), which in turn will
* use PJSIP_SSL_DEFAULT_METHOD, which default value is PJSIP_TLSV1_METHOD.
*/
pjsip_ssl_method method;
/**
* TLS protocol type from #pj_ssl_sock_proto. Use this field to enable
* specific protocol type. Use bitwise OR operation to combine the protocol
* type.
*
* Default is PJSIP_SSL_DEFAULT_PROTO.
*/
pj_uint32_t proto;
/**
* Number of ciphers contained in the specified cipher preference.
* If this is set to zero, then default cipher list of the backend
* will be used.
*
* Default: 0 (zero).
*/
unsigned ciphers_num;
/**
* Ciphers and order preference. The #pj_ssl_cipher_get_availables()
* can be used to check the available ciphers supported by backend.
*/
pj_ssl_cipher *ciphers;
/**
* Number of curves contained in the specified curve preference.
* If this is set to zero, then default curve list of the backend
* will be used.
*
* Default: 0 (zero).
*/
unsigned curves_num;
/**
* Curves and order preference. The #pj_ssl_curve_get_availables()
* can be used to check the available curves supported by backend.
*/
pj_ssl_curve *curves;
/**
* The supported signature algorithms. Set the sigalgs string
* using this form:
* "<DIGEST>+<ALGORITHM>:<DIGEST>+<ALGORITHM>"
* Digests are: "RSA", "DSA" or "ECDSA"
* Algorithms are: "MD5", "SHA1", "SHA224", "SHA256", "SHA384", "SHA512"
* Example: "ECDSA+SHA256:RSA+SHA256"
*/
pj_str_t sigalgs;
/**
* Reseed random number generator.
* For type #PJ_SSL_ENTROPY_FILE, parameter \a entropy_path
* must be set to a file.
* For type #PJ_SSL_ENTROPY_EGD, parameter \a entropy_path
* must be set to a socket.
*
* Default value is PJ_SSL_ENTROPY_NONE.
*/
pj_ssl_entropy_t entropy_type;
/**
* When using a file/socket for entropy #PJ_SSL_ENTROPY_EGD or
* #PJ_SSL_ENTROPY_FILE, \a entropy_path must contain the path
* to entropy socket/file.
*
* Default value is an empty string.
*/
pj_str_t entropy_path;
/**
* Specifies TLS transport behavior on the server TLS certificate
* verification result:
* - If \a verify_server is disabled (set to PJ_FALSE), TLS transport
* will just notify the application via #pjsip_tp_state_callback with
* state PJSIP_TP_STATE_CONNECTED regardless TLS verification result.
* - If \a verify_server is enabled (set to PJ_TRUE), TLS transport
* will be shutdown and application will be notified with state
* PJSIP_TP_STATE_DISCONNECTED whenever there is any TLS verification
* error, otherwise PJSIP_TP_STATE_CONNECTED will be notified.
*
* In any cases, application can inspect #pjsip_tls_state_info in the
* callback to see the verification detail.
*
* Default value is PJ_FALSE.
*/
pj_bool_t verify_server;
/**
* Specifies TLS transport behavior on the client TLS certificate
* verification result:
* - If \a verify_client is disabled (set to PJ_FALSE), TLS transport
* will just notify the application via #pjsip_tp_state_callback with
* state PJSIP_TP_STATE_CONNECTED regardless TLS verification result.
* - If \a verify_client is enabled (set to PJ_TRUE), TLS transport
* will be shutdown and application will be notified with state
* PJSIP_TP_STATE_DISCONNECTED whenever there is any TLS verification
* error, otherwise PJSIP_TP_STATE_CONNECTED will be notified.
*
* In any cases, application can inspect #pjsip_tls_state_info in the
* callback to see the verification detail.
*
* Default value is PJ_FALSE.
*/
pj_bool_t verify_client;
/**
* When acting as server (incoming TLS connections), reject inocming
* connection if client doesn't supply a TLS certificate.
*
* This setting corresponds to SSL_VERIFY_FAIL_IF_NO_PEER_CERT flag.
* Default value is PJ_FALSE.
*/
pj_bool_t require_client_cert;
/**
* TLS negotiation timeout to be applied for both outgoing and
* incoming connection. If both sec and msec member is set to zero,
* the SSL negotiation doesn't have a timeout.
*/
pj_time_val timeout;
/**
* Should SO_REUSEADDR be used for the listener socket.
* Default value is PJSIP_TLS_TRANSPORT_REUSEADDR.
*/
pj_bool_t reuse_addr;
/**
* QoS traffic type to be set on this transport. When application wants
* to apply QoS tagging to the transport, it's preferable to set this
* field rather than \a qos_param fields since this is more portable.
*
* Default value is PJ_QOS_TYPE_BEST_EFFORT.
*/
pj_qos_type qos_type;
/**
* Set the low level QoS parameters to the transport. This is a lower
* level operation than setting the \a qos_type field and may not be
* supported on all platforms.
*
* By default all settings in this structure are disabled.
*/
pj_qos_params qos_params;
/**
* Specify if the transport should ignore any errors when setting the QoS
* traffic type/parameters.
*
* Default: PJ_TRUE
*/
pj_bool_t qos_ignore_error;
/**
* Specify options to be set on the transport.
*
* By default there is no options.
*
*/
pj_sockopt_params sockopt_params;
/**
* Specify if the transport should ignore any errors when setting the
* sockopt parameters.
*
* Default: PJ_TRUE
*
*/
pj_bool_t sockopt_ignore_error;
} pjsip_tls_setting;
/**
* This structure defines TLS transport extended info in <tt>ext_info</tt>
* field of #pjsip_transport_state_info for the transport state notification
* callback #pjsip_tp_state_callback.
*/
typedef struct pjsip_tls_state_info
{
/**
* SSL socket info.
*/
pj_ssl_sock_info *ssl_sock_info;
} pjsip_tls_state_info;
/**
* Initialize TLS setting with default values.
*
* @param tls_opt The TLS setting to be initialized.
*/
PJ_INLINE(void) pjsip_tls_setting_default(pjsip_tls_setting *tls_opt)
{
pj_memset(tls_opt, 0, sizeof(*tls_opt));
tls_opt->reuse_addr = PJSIP_TLS_TRANSPORT_REUSEADDR;
tls_opt->qos_type = PJ_QOS_TYPE_BEST_EFFORT;
tls_opt->qos_ignore_error = PJ_TRUE;
tls_opt->sockopt_ignore_error = PJ_TRUE;
tls_opt->proto = PJSIP_SSL_DEFAULT_PROTO;
}
/**
* Copy TLS setting.
*
* @param pool The pool to duplicate strings etc.
* @param dst Destination structure.
* @param src Source structure.
*/
PJ_INLINE(void) pjsip_tls_setting_copy(pj_pool_t *pool,
pjsip_tls_setting *dst,
const pjsip_tls_setting *src)
{
pj_memcpy(dst, src, sizeof(*dst));
pj_strdup_with_null(pool, &dst->ca_list_file, &src->ca_list_file);
pj_strdup_with_null(pool, &dst->ca_list_path, &src->ca_list_path);
pj_strdup_with_null(pool, &dst->cert_file, &src->cert_file);
pj_strdup_with_null(pool, &dst->privkey_file, &src->privkey_file);
pj_strdup_with_null(pool, &dst->password, &src->password);
pj_strdup_with_null(pool, &dst->sigalgs, &src->sigalgs);
pj_strdup_with_null(pool, &dst->entropy_path, &src->entropy_path);
if (src->ciphers_num) {
unsigned i;
dst->ciphers = (pj_ssl_cipher*) pj_pool_calloc(pool, src->ciphers_num,
sizeof(pj_ssl_cipher));
for (i=0; i<src->ciphers_num; ++i)
dst->ciphers[i] = src->ciphers[i];
}
if (src->curves_num) {
unsigned i;
dst->curves = (pj_ssl_curve*) pj_pool_calloc(pool, src->curves_num,
sizeof(pj_ssl_curve));
for (i=0; i<src->curves_num; ++i)
dst->curves[i] = src->curves[i];
}
}
/**
* Register support for SIP TLS transport by creating TLS listener on
* the specified address and port. This function will create an
* instance of SIP TLS transport factory and register it to the
* transport manager.
*
* See also #pjsip_tls_transport_start2() which supports IPv6.
*
* @param endpt The SIP endpoint.
* @param opt Optional TLS settings.
* @param local Optional local address to bind, or specify the
* address to bind the server socket to. Both IP
* interface address and port fields are optional.
* If IP interface address is not specified, socket
* will be bound to PJ_INADDR_ANY. If port is not
* specified, socket will be bound to any port
* selected by the operating system.
* @param a_name Optional published address, which is the address to be
* advertised as the address of this SIP transport.
* If this argument is NULL, then the bound address
* will be used as the published address.
* @param async_cnt Number of simultaneous asynchronous accept()
* operations to be supported. It is recommended that
* the number here corresponds to the number of
* processors in the system (or the number of SIP
* worker threads).
* @param p_factory Optional pointer to receive the instance of the
* SIP TLS transport factory just created.
*
* @return PJ_SUCCESS when the transport has been successfully
* started and registered to transport manager, or
* the appropriate error code.
*/
PJ_DECL(pj_status_t) pjsip_tls_transport_start(pjsip_endpoint *endpt,
const pjsip_tls_setting *opt,
const pj_sockaddr_in *local,
const pjsip_host_port *a_name,
unsigned async_cnt,
pjsip_tpfactory **p_factory);
/**
* Variant of #pjsip_tls_transport_start() that supports IPv6. To instantiate
* IPv6 listener, set the address family of the "local" argument to IPv6
* (the host and port part may be left unspecified if not desired, i.e. by
* filling them with zeroes).
*
* @param endpt The SIP endpoint.
* @param opt Optional TLS settings.
* @param local Optional local address to bind, or specify the
* address to bind the server socket to. Both IP
* interface address and port fields are optional.
* If IP interface address is not specified, socket
* will be bound to any address. If port is not
* specified, socket will be bound to any port
* selected by the operating system.
* @param a_name Optional published address, which is the address to be
* advertised as the address of this SIP transport.
* If this argument is NULL, then the bound address
* will be used as the published address.
* @param async_cnt Number of simultaneous asynchronous accept()
* operations to be supported. It is recommended that
* the number here corresponds to the number of
* processors in the system (or the number of SIP
* worker threads).
* @param p_factory Optional pointer to receive the instance of the
* SIP TLS transport factory just created.
*
* @return PJ_SUCCESS when the transport has been successfully
* started and registered to transport manager, or
* the appropriate error code.
*/
PJ_DECL(pj_status_t) pjsip_tls_transport_start2(pjsip_endpoint *endpt,
const pjsip_tls_setting *opt,
const pj_sockaddr *local,
const pjsip_host_port *a_name,
unsigned async_cnt,
pjsip_tpfactory **p_factory);
/**
* Start the TLS listener, if the listener is not started yet. This is useful
* to start the listener manually, if listener was not started when
* PJSIP_TLS_TRANSPORT_DONT_CREATE_LISTENER is set to 0.
*
* @param factory The SIP TLS transport factory.
*
* @param local The address where the listener should be bound to.
* Both IP interface address and port fields are optional.
* If IP interface address is not specified, socket
* will be bound to PJ_INADDR_ANY. If port is not
* specified, socket will be bound to any port
* selected by the operating system.
*
* @param a_name The published address for the listener.
* If this argument is NULL, then the bound address will
* be used as the published address.
*
* @return PJ_SUCCESS when the listener has been successfully
* started.
*/
PJ_DECL(pj_status_t) pjsip_tls_transport_lis_start(pjsip_tpfactory *factory,
const pj_sockaddr *local,
const pjsip_host_port *a_name);
/**
* Restart the TLS listener. This will close the listener socket and recreate
* the socket based on the config used when starting the transport.
*
* @param factory The SIP TLS transport factory.
*
* @param local The address where the listener should be bound to.
* Both IP interface address and port fields are optional.
* If IP interface address is not specified, socket
* will be bound to PJ_INADDR_ANY. If port is not
* specified, socket will be bound to any port
* selected by the operating system.
*
* @param a_name The published address for the listener.
* If this argument is NULL, then the bound address will
* be used as the published address.
*
* @return PJ_SUCCESS when the listener has been successfully
* restarted.
*
*/
PJ_DECL(pj_status_t) pjsip_tls_transport_restart(pjsip_tpfactory *factory,
const pj_sockaddr *local,
const pjsip_host_port *a_name);
PJ_END_DECL
/**
* @}
*/
#endif /* __PJSIP_TRANSPORT_TLS_H__ */
|