config_parser.c 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802
  1. /*
  2. * Asterisk -- An open source telephony toolkit.
  3. *
  4. * Copyright (C) 2010, Digium, Inc.
  5. *
  6. * See http://www.asterisk.org for more information about
  7. * the Asterisk project. Please do not directly contact
  8. * any of the maintainers of this project for assistance;
  9. * the project provides a web site, mailing lists and IRC
  10. * channels for your use.
  11. *
  12. * This program is free software, distributed under the terms of
  13. * the GNU General Public License Version 2. See the LICENSE file
  14. * at the top of the source tree.
  15. */
  16. /*!
  17. * \file
  18. * \brief sip config parsing functions and unit tests
  19. */
  20. /*** MODULEINFO
  21. <support_level>core</support_level>
  22. ***/
  23. #include "asterisk.h"
  24. ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
  25. #include "include/sip.h"
  26. #include "include/config_parser.h"
  27. #include "include/sip_utils.h"
  28. /*! \brief Parse register=> line in sip.conf
  29. *
  30. * \retval 0 on success
  31. * \retval -1 on failure
  32. */
  33. int sip_parse_register_line(struct sip_registry *reg, int default_expiry, const char *value, int lineno)
  34. {
  35. int portnum = 0;
  36. int domainport = 0;
  37. enum sip_transport transport = SIP_TRANSPORT_UDP;
  38. char buf[256] = "";
  39. char *userpart = NULL, *hostpart = NULL;
  40. /* register => [peer?][transport://]user[@domain][:secret[:authuser]]@host[:port][/extension][~expiry] */
  41. AST_DECLARE_APP_ARGS(pre1,
  42. AST_APP_ARG(peer);
  43. AST_APP_ARG(userpart);
  44. );
  45. AST_DECLARE_APP_ARGS(pre2,
  46. AST_APP_ARG(transport);
  47. AST_APP_ARG(blank);
  48. AST_APP_ARG(userpart);
  49. );
  50. AST_DECLARE_APP_ARGS(user1,
  51. AST_APP_ARG(userpart);
  52. AST_APP_ARG(secret);
  53. AST_APP_ARG(authuser);
  54. );
  55. AST_DECLARE_APP_ARGS(user2,
  56. AST_APP_ARG(user);
  57. AST_APP_ARG(domain);
  58. );
  59. AST_DECLARE_APP_ARGS(user3,
  60. AST_APP_ARG(authuser);
  61. AST_APP_ARG(domainport);
  62. );
  63. AST_DECLARE_APP_ARGS(host1,
  64. AST_APP_ARG(hostpart);
  65. AST_APP_ARG(expiry);
  66. );
  67. AST_DECLARE_APP_ARGS(host2,
  68. AST_APP_ARG(hostpart);
  69. AST_APP_ARG(extension);
  70. );
  71. AST_DECLARE_APP_ARGS(host3,
  72. AST_APP_ARG(host);
  73. AST_APP_ARG(port);
  74. );
  75. if (!value) {
  76. return -1;
  77. }
  78. if (!reg) {
  79. return -1;
  80. }
  81. ast_copy_string(buf, value, sizeof(buf));
  82. /*! register => [peer?][transport://]user[@domain][:secret[:authuser]]@host[:port][/extension][~expiry]
  83. * becomes
  84. * userpart => [peer?][transport://]user[@domain][:secret[:authuser]]
  85. * hostpart => host[:port][/extension][~expiry]
  86. */
  87. if ((hostpart = strrchr(buf, '@'))) {
  88. *hostpart++ = '\0';
  89. userpart = buf;
  90. }
  91. if (ast_strlen_zero(userpart) || ast_strlen_zero(hostpart)) {
  92. ast_log(LOG_WARNING, "Format for registration is [peer?][transport://]user[@domain][:secret[:authuser]]@host[:port][/extension][~expiry] at line %d\n", lineno);
  93. return -1;
  94. }
  95. /*!
  96. * pre1.peer => peer
  97. * pre1.userpart => [transport://]user[@domain][:secret[:authuser]]
  98. * hostpart => host[:port][/extension][~expiry]
  99. */
  100. AST_NONSTANDARD_RAW_ARGS(pre1, userpart, '?');
  101. if (ast_strlen_zero(pre1.userpart)) {
  102. pre1.userpart = pre1.peer;
  103. pre1.peer = NULL;
  104. }
  105. /*!
  106. * pre1.peer => peer
  107. * pre2.transport = transport
  108. * pre2.userpart => user[@domain][:secret[:authuser]]
  109. * hostpart => host[:port][/extension][~expiry]
  110. */
  111. AST_NONSTANDARD_RAW_ARGS(pre2, pre1.userpart, '/');
  112. if (ast_strlen_zero(pre2.userpart)) {
  113. pre2.userpart = pre2.transport;
  114. pre2.transport = NULL;
  115. } else {
  116. pre2.transport[strlen(pre2.transport) - 1] = '\0'; /* Remove trailing : */
  117. }
  118. if (!ast_strlen_zero(pre2.blank)) {
  119. ast_log(LOG_WARNING, "Format for registration is [peer?][transport://]user[@domain][:secret[:authuser]]@host[:port][/extension][~expiry] at line %d\n", lineno);
  120. return -1;
  121. }
  122. /*!
  123. * pre1.peer => peer
  124. * pre2.transport = transport
  125. * user1.userpart => user[@domain]
  126. * user1.secret => secret
  127. * user1.authuser => authuser
  128. * hostpart => host[:port][/extension][~expiry]
  129. */
  130. AST_NONSTANDARD_RAW_ARGS(user1, pre2.userpart, ':');
  131. /*!
  132. * pre1.peer => peer
  133. * pre2.transport = transport
  134. * user1.userpart => user[@domain]
  135. * user1.secret => secret
  136. * user1.authuser => authuser
  137. * host1.hostpart => host[:port][/extension]
  138. * host1.expiry => [expiry]
  139. */
  140. AST_NONSTANDARD_RAW_ARGS(host1, hostpart, '~');
  141. /*!
  142. * pre1.peer => peer
  143. * pre2.transport = transport
  144. * user1.userpart => user[@domain]
  145. * user1.secret => secret
  146. * user1.authuser => authuser
  147. * host2.hostpart => host[:port]
  148. * host2.extension => [extension]
  149. * host1.expiry => [expiry]
  150. */
  151. AST_NONSTANDARD_RAW_ARGS(host2, host1.hostpart, '/');
  152. /*!
  153. * pre1.peer => peer
  154. * pre2.transport = transport
  155. * user1.userpart => user[@domain]
  156. * user1.secret => secret
  157. * user1.authuser => authuser
  158. * host3.host => host
  159. * host3.port => port
  160. * host2.extension => extension
  161. * host1.expiry => expiry
  162. */
  163. AST_NONSTANDARD_RAW_ARGS(host3, host2.hostpart, ':');
  164. /*!
  165. * pre1.peer => peer
  166. * pre2.transport = transport
  167. * user2.user => user
  168. * user2.domain => domain
  169. * user1.secret => secret
  170. * user1.authuser => authuser
  171. * host3.host => host
  172. * host3.port => port
  173. * host2.extension => extension
  174. * host1.expiry => expiry
  175. */
  176. AST_NONSTANDARD_RAW_ARGS(user2, user1.userpart, '@');
  177. /*!
  178. * pre1.peer => peer
  179. * pre2.transport = transport
  180. * user2.user => user
  181. * user2.domain => domain
  182. * user1.secret => secret
  183. * user3.authuser => authuser
  184. * user3.domainport => domainport
  185. * host3.host => host
  186. * host3.port => port
  187. * host2.extension => extension
  188. * host1.expiry => expiry
  189. */
  190. AST_NONSTANDARD_RAW_ARGS(user3, user1.authuser, ':');
  191. /* Reordering needed due to fields being [(:secret[:username])|(:regdomainport:secret:username)]
  192. but parsing being [secret[:username[:regdomainport]]] */
  193. if (user3.argc == 2) {
  194. char *reorder = user3.domainport;
  195. user3.domainport = user1.secret;
  196. user1.secret = user3.authuser;
  197. user3.authuser = reorder;
  198. }
  199. if (host3.port) {
  200. if (!(portnum = port_str2int(host3.port, 0))) {
  201. ast_log(LOG_NOTICE, "'%s' is not a valid port number on line %d of sip.conf. using default.\n", host3.port, lineno);
  202. }
  203. }
  204. if (user3.domainport) {
  205. if (!(domainport = port_str2int(user3.domainport, 0))) {
  206. ast_log(LOG_NOTICE, "'%s' is not a valid domain port number on line %d of sip.conf. using default.\n", user3.domainport, lineno);
  207. }
  208. }
  209. /* set transport type */
  210. if (!pre2.transport) {
  211. transport = SIP_TRANSPORT_UDP;
  212. } else if (!strncasecmp(pre2.transport, "tcp", 3)) {
  213. transport = SIP_TRANSPORT_TCP;
  214. } else if (!strncasecmp(pre2.transport, "tls", 3)) {
  215. transport = SIP_TRANSPORT_TLS;
  216. } else if (!strncasecmp(pre2.transport, "udp", 3)) {
  217. transport = SIP_TRANSPORT_UDP;
  218. } else {
  219. transport = SIP_TRANSPORT_UDP;
  220. ast_log(LOG_NOTICE, "'%.3s' is not a valid transport type on line %d of sip.conf. defaulting to udp.\n", pre2.transport, lineno);
  221. }
  222. /* if no portnum specified, set default for transport */
  223. if (!portnum) {
  224. if (transport == SIP_TRANSPORT_TLS) {
  225. portnum = STANDARD_TLS_PORT;
  226. } else {
  227. portnum = STANDARD_SIP_PORT;
  228. }
  229. }
  230. /* copy into sip_registry object */
  231. ast_string_field_set(reg, callback, ast_strip_quoted(S_OR(host2.extension, "s"), "\"", "\""));
  232. ast_string_field_set(reg, username, ast_strip_quoted(S_OR(user2.user, ""), "\"", "\""));
  233. ast_string_field_set(reg, hostname, ast_strip_quoted(S_OR(host3.host, ""), "\"", "\""));
  234. ast_string_field_set(reg, authuser, ast_strip_quoted(S_OR(user3.authuser, ""), "\"", "\""));
  235. ast_string_field_set(reg, secret, ast_strip_quoted(S_OR(user1.secret, ""), "\"", "\""));
  236. ast_string_field_set(reg, peername, ast_strip_quoted(S_OR(pre1.peer, ""), "\"", "\""));
  237. ast_string_field_set(reg, regdomain, ast_strip_quoted(S_OR(user2.domain, ""), "\"", "\""));
  238. reg->transport = transport;
  239. reg->timeout = reg->expire = -1;
  240. reg->portno = portnum;
  241. reg->regdomainport = domainport;
  242. reg->callid_valid = FALSE;
  243. reg->ocseq = INITIAL_CSEQ;
  244. reg->refresh = reg->expiry = reg->configured_expiry = (host1.expiry ? atoi(ast_strip_quoted(host1.expiry, "\"", "\"")) : default_expiry);
  245. return 0;
  246. }
  247. AST_TEST_DEFINE(sip_parse_register_line_test)
  248. {
  249. int res = AST_TEST_PASS;
  250. struct sip_registry *reg;
  251. int default_expiry = 120;
  252. const char *reg1 = "name@domain";
  253. const char *reg2 = "name:pass@domain";
  254. const char *reg3 = "name@namedomain:pass:authuser@domain";
  255. const char *reg4 = "name@namedomain:pass:authuser@domain/extension";
  256. const char *reg5 = "tcp://name@namedomain:pass:authuser@domain/extension";
  257. const char *reg6 = "tls://name@namedomain:pass:authuser@domain/extension~111";
  258. const char *reg7 = "peer?tcp://name@namedomain:pass:authuser@domain:1234/extension~111";
  259. const char *reg8 = "peer?name@namedomain:pass:authuser@domain:1234/extension~111";
  260. const char *reg9 = "peer?name:pass:authuser:1234/extension~111";
  261. const char *reg10 = "@domin:1234";
  262. const char *reg12 = "name@namedomain:4321:pass:authuser@domain";
  263. const char *reg13 = "name@namedomain:4321::@domain";
  264. switch (cmd) {
  265. case TEST_INIT:
  266. info->name = "sip_parse_register_line_test";
  267. info->category = "/channels/chan_sip/";
  268. info->summary = "tests sip register line parsing";
  269. info->description =
  270. "Tests parsing of various register line configurations. "
  271. "Verifies output matches expected behavior.";
  272. return AST_TEST_NOT_RUN;
  273. case TEST_EXECUTE:
  274. break;
  275. }
  276. /* ---Test reg 1, simple config --- */
  277. if (!(reg = ast_calloc_with_stringfields(1, struct sip_registry, 256))) {
  278. goto alloc_fail;
  279. } else if (
  280. sip_parse_register_line(reg, default_expiry, reg1, 1) ||
  281. strcmp(reg->callback, "s") ||
  282. strcmp(reg->username, "name") ||
  283. strcmp(reg->regdomain, "") ||
  284. strcmp(reg->hostname, "domain") ||
  285. strcmp(reg->authuser, "") ||
  286. strcmp(reg->secret, "") ||
  287. strcmp(reg->peername, "") ||
  288. reg->transport != SIP_TRANSPORT_UDP ||
  289. reg->timeout != -1 ||
  290. reg->expire != -1 ||
  291. reg->refresh != default_expiry ||
  292. reg->expiry != default_expiry ||
  293. reg->configured_expiry != default_expiry ||
  294. reg->portno != STANDARD_SIP_PORT ||
  295. (reg->regdomainport) ||
  296. reg->callid_valid != FALSE ||
  297. reg->ocseq != INITIAL_CSEQ) {
  298. ast_test_status_update(test, "Test 1: simple config failed\n");
  299. res = AST_TEST_FAIL;
  300. }
  301. ast_string_field_free_memory(reg);
  302. ast_free(reg);
  303. /* ---Test reg 2, add secret --- */
  304. if (!(reg = ast_calloc_with_stringfields(1, struct sip_registry, 256))) {
  305. goto alloc_fail;
  306. } else if (
  307. sip_parse_register_line(reg, default_expiry, reg2, 1) ||
  308. strcmp(reg->callback, "s") ||
  309. strcmp(reg->username, "name") ||
  310. strcmp(reg->regdomain, "") ||
  311. strcmp(reg->hostname, "domain") ||
  312. strcmp(reg->authuser, "") ||
  313. strcmp(reg->secret, "pass") ||
  314. strcmp(reg->peername, "") ||
  315. reg->transport != SIP_TRANSPORT_UDP ||
  316. reg->timeout != -1 ||
  317. reg->expire != -1 ||
  318. reg->refresh != default_expiry ||
  319. reg->expiry != default_expiry ||
  320. reg->configured_expiry != default_expiry ||
  321. reg->portno != STANDARD_SIP_PORT ||
  322. (reg->regdomainport) ||
  323. reg->callid_valid != FALSE ||
  324. reg->ocseq != INITIAL_CSEQ) {
  325. ast_test_status_update(test, "Test 2: add secret failed\n");
  326. res = AST_TEST_FAIL;
  327. }
  328. ast_string_field_free_memory(reg);
  329. ast_free(reg);
  330. /* ---Test reg 3, add userdomain and authuser --- */
  331. if (!(reg = ast_calloc_with_stringfields(1, struct sip_registry, 256))) {
  332. goto alloc_fail;
  333. } else if (
  334. sip_parse_register_line(reg, default_expiry, reg3, 1) ||
  335. strcmp(reg->callback, "s") ||
  336. strcmp(reg->username, "name") ||
  337. strcmp(reg->regdomain, "namedomain") ||
  338. strcmp(reg->hostname, "domain") ||
  339. strcmp(reg->authuser, "authuser") ||
  340. strcmp(reg->secret, "pass") ||
  341. strcmp(reg->peername, "") ||
  342. reg->transport != SIP_TRANSPORT_UDP ||
  343. reg->timeout != -1 ||
  344. reg->expire != -1 ||
  345. reg->refresh != default_expiry ||
  346. reg->expiry != default_expiry ||
  347. reg->configured_expiry != default_expiry ||
  348. reg->portno != STANDARD_SIP_PORT ||
  349. (reg->regdomainport) ||
  350. reg->callid_valid != FALSE ||
  351. reg->ocseq != INITIAL_CSEQ) {
  352. ast_test_status_update(test, "Test 3: add userdomain and authuser failed\n");
  353. res = AST_TEST_FAIL;
  354. }
  355. ast_string_field_free_memory(reg);
  356. ast_free(reg);
  357. /* ---Test reg 4, add callback extension --- */
  358. if (!(reg = ast_calloc_with_stringfields(1, struct sip_registry, 256))) {
  359. goto alloc_fail;
  360. } else if (
  361. sip_parse_register_line(reg, default_expiry, reg4, 1) ||
  362. strcmp(reg->callback, "extension") ||
  363. strcmp(reg->username, "name") ||
  364. strcmp(reg->regdomain, "namedomain") ||
  365. strcmp(reg->hostname, "domain") ||
  366. strcmp(reg->authuser, "authuser") ||
  367. strcmp(reg->secret, "pass") ||
  368. strcmp(reg->peername, "") ||
  369. reg->transport != SIP_TRANSPORT_UDP ||
  370. reg->timeout != -1 ||
  371. reg->expire != -1 ||
  372. reg->refresh != default_expiry ||
  373. reg->expiry != default_expiry ||
  374. reg->configured_expiry != default_expiry ||
  375. reg->portno != STANDARD_SIP_PORT ||
  376. (reg->regdomainport) ||
  377. reg->callid_valid != FALSE ||
  378. reg->ocseq != INITIAL_CSEQ) {
  379. ast_test_status_update(test, "Test 4: add callback extension failed\n");
  380. res = AST_TEST_FAIL;
  381. }
  382. ast_string_field_free_memory(reg);
  383. ast_free(reg);
  384. /* ---Test reg 5, add transport --- */
  385. if (!(reg = ast_calloc_with_stringfields(1, struct sip_registry, 256))) {
  386. goto alloc_fail;
  387. } else if (
  388. sip_parse_register_line(reg, default_expiry, reg5, 1) ||
  389. strcmp(reg->callback, "extension") ||
  390. strcmp(reg->username, "name") ||
  391. strcmp(reg->regdomain, "namedomain") ||
  392. strcmp(reg->hostname, "domain") ||
  393. strcmp(reg->authuser, "authuser") ||
  394. strcmp(reg->secret, "pass") ||
  395. strcmp(reg->peername, "") ||
  396. reg->transport != SIP_TRANSPORT_TCP ||
  397. reg->timeout != -1 ||
  398. reg->expire != -1 ||
  399. reg->refresh != default_expiry ||
  400. reg->expiry != default_expiry ||
  401. reg->configured_expiry != default_expiry ||
  402. reg->portno != STANDARD_SIP_PORT ||
  403. (reg->regdomainport) ||
  404. reg->callid_valid != FALSE ||
  405. reg->ocseq != INITIAL_CSEQ) {
  406. ast_test_status_update(test, "Test 5: add transport failed\n");
  407. res = AST_TEST_FAIL;
  408. }
  409. ast_string_field_free_memory(reg);
  410. ast_free(reg);
  411. /* ---Test reg 6, change to tls transport, add expiry --- */
  412. if (!(reg = ast_calloc_with_stringfields(1, struct sip_registry, 256))) {
  413. goto alloc_fail;
  414. } else if (
  415. sip_parse_register_line(reg, default_expiry, reg6, 1) ||
  416. strcmp(reg->callback, "extension") ||
  417. strcmp(reg->username, "name") ||
  418. strcmp(reg->regdomain, "namedomain") ||
  419. strcmp(reg->hostname, "domain") ||
  420. strcmp(reg->authuser, "authuser") ||
  421. strcmp(reg->secret, "pass") ||
  422. strcmp(reg->peername, "") ||
  423. reg->transport != SIP_TRANSPORT_TLS ||
  424. reg->timeout != -1 ||
  425. reg->expire != -1 ||
  426. reg->refresh != 111 ||
  427. reg->expiry != 111 ||
  428. reg->configured_expiry != 111 ||
  429. reg->portno != STANDARD_TLS_PORT ||
  430. (reg->regdomainport) ||
  431. reg->callid_valid != FALSE ||
  432. reg->ocseq != INITIAL_CSEQ) {
  433. ast_test_status_update(test, "Test 6: change to tls transport and add expiry failed\n");
  434. res = AST_TEST_FAIL;
  435. }
  436. ast_string_field_free_memory(reg);
  437. ast_free(reg);
  438. /* ---Test reg 7, change transport to tcp, add custom port, and add peer --- */
  439. if (!(reg = ast_calloc_with_stringfields(1, struct sip_registry, 256))) {
  440. goto alloc_fail;
  441. } else if (
  442. sip_parse_register_line(reg, default_expiry, reg7, 1) ||
  443. strcmp(reg->callback, "extension") ||
  444. strcmp(reg->username, "name") ||
  445. strcmp(reg->regdomain, "namedomain") ||
  446. strcmp(reg->hostname, "domain") ||
  447. strcmp(reg->authuser, "authuser") ||
  448. strcmp(reg->secret, "pass") ||
  449. strcmp(reg->peername, "peer") ||
  450. reg->transport != SIP_TRANSPORT_TCP ||
  451. reg->timeout != -1 ||
  452. reg->expire != -1 ||
  453. reg->refresh != 111 ||
  454. reg->expiry != 111 ||
  455. reg->configured_expiry != 111 ||
  456. reg->portno != 1234 ||
  457. (reg->regdomainport) ||
  458. reg->callid_valid != FALSE ||
  459. reg->ocseq != INITIAL_CSEQ) {
  460. ast_test_status_update(test, "Test 7, change transport to tcp, add custom port, and add peer failed.\n");
  461. res = AST_TEST_FAIL;
  462. }
  463. ast_string_field_free_memory(reg);
  464. ast_free(reg);
  465. /* ---Test reg 8, remove transport --- */
  466. if (!(reg = ast_calloc_with_stringfields(1, struct sip_registry, 256))) {
  467. goto alloc_fail;
  468. } else if (
  469. sip_parse_register_line(reg, default_expiry, reg8, 1) ||
  470. strcmp(reg->callback, "extension") ||
  471. strcmp(reg->username, "name") ||
  472. strcmp(reg->regdomain, "namedomain") ||
  473. strcmp(reg->hostname, "domain") ||
  474. strcmp(reg->authuser, "authuser") ||
  475. strcmp(reg->secret, "pass") ||
  476. strcmp(reg->peername, "peer") ||
  477. reg->transport != SIP_TRANSPORT_UDP ||
  478. reg->timeout != -1 ||
  479. reg->expire != -1 ||
  480. reg->refresh != 111 ||
  481. reg->expiry != 111 ||
  482. reg->configured_expiry != 111 ||
  483. reg->portno != 1234 ||
  484. (reg->regdomainport) ||
  485. reg->callid_valid != FALSE ||
  486. reg->ocseq != INITIAL_CSEQ) {
  487. ast_test_status_update(test, "Test 8, remove transport failed.\n");
  488. res = AST_TEST_FAIL;
  489. }
  490. ast_string_field_free_memory(reg);
  491. ast_free(reg);
  492. /* ---Test reg 9, missing domain, expected to fail --- */
  493. if (!(reg = ast_calloc_with_stringfields(1, struct sip_registry, 256))) {
  494. goto alloc_fail;
  495. } else if (!sip_parse_register_line(reg, default_expiry, reg9, 1)) {
  496. ast_test_status_update(test,
  497. "Test 9, missing domain, expected to fail but did not.\n");
  498. res = AST_TEST_FAIL;
  499. }
  500. ast_string_field_free_memory(reg);
  501. ast_free(reg);
  502. /* ---Test reg 10, missing user, expected to fail --- */
  503. if (!(reg = ast_calloc_with_stringfields(1, struct sip_registry, 256))) {
  504. goto alloc_fail;
  505. } else if (!sip_parse_register_line(reg, default_expiry, reg10, 1)) {
  506. ast_test_status_update(test,
  507. "Test 10, missing user expected to fail but did not\n");
  508. res = AST_TEST_FAIL;
  509. }
  510. ast_string_field_free_memory(reg);
  511. ast_free(reg);
  512. /* ---Test reg 11, no registry object, expected to fail--- */
  513. if (!sip_parse_register_line(NULL, default_expiry, reg1, 1)) {
  514. ast_test_status_update(test,
  515. "Test 11, no registry object, expected to fail but did not.\n");
  516. res = AST_TEST_FAIL;
  517. }
  518. /* ---Test reg 12, no registry line, expected to fail --- */
  519. if (!(reg = ast_calloc_with_stringfields(1, struct sip_registry, 256))) {
  520. goto alloc_fail;
  521. } else if (!sip_parse_register_line(reg, default_expiry, NULL, 1)) {
  522. ast_test_status_update(test,
  523. "Test 12, NULL register line expected to fail but did not.\n");
  524. res = AST_TEST_FAIL;
  525. }
  526. ast_string_field_free_memory(reg);
  527. ast_free(reg);
  528. /* ---Test reg13, add domain port --- */
  529. if (!(reg = ast_calloc_with_stringfields(1, struct sip_registry, 256))) {
  530. goto alloc_fail;
  531. } else if (
  532. sip_parse_register_line(reg, default_expiry, reg12, 1) ||
  533. strcmp(reg->callback, "s") ||
  534. strcmp(reg->username, "name") ||
  535. strcmp(reg->regdomain, "namedomain") ||
  536. strcmp(reg->hostname, "domain") ||
  537. strcmp(reg->authuser, "authuser") ||
  538. strcmp(reg->secret, "pass") ||
  539. strcmp(reg->peername, "") ||
  540. reg->transport != SIP_TRANSPORT_UDP ||
  541. reg->timeout != -1 ||
  542. reg->expire != -1 ||
  543. reg->refresh != default_expiry ||
  544. reg->expiry != default_expiry ||
  545. reg->configured_expiry != default_expiry ||
  546. reg->portno != STANDARD_SIP_PORT ||
  547. reg->regdomainport != 4321 ||
  548. reg->callid_valid != FALSE ||
  549. reg->ocseq != INITIAL_CSEQ) {
  550. ast_test_status_update(test, "Test 13, add domain port failed.\n");
  551. res = AST_TEST_FAIL;
  552. }
  553. ast_string_field_free_memory(reg);
  554. ast_free(reg);
  555. /* ---Test reg14, domain port without secret --- */
  556. if (!(reg = ast_calloc_with_stringfields(1, struct sip_registry, 256))) {
  557. goto alloc_fail;
  558. } else if (
  559. sip_parse_register_line(reg, default_expiry, reg13, 1) ||
  560. strcmp(reg->callback, "s") ||
  561. strcmp(reg->username, "name") ||
  562. strcmp(reg->regdomain, "namedomain") ||
  563. strcmp(reg->hostname, "domain") ||
  564. strcmp(reg->authuser, "") ||
  565. strcmp(reg->secret, "") ||
  566. strcmp(reg->peername, "") ||
  567. reg->transport != SIP_TRANSPORT_UDP ||
  568. reg->timeout != -1 ||
  569. reg->expire != -1 ||
  570. reg->refresh != default_expiry ||
  571. reg->expiry != default_expiry ||
  572. reg->configured_expiry != default_expiry ||
  573. reg->portno != STANDARD_SIP_PORT ||
  574. reg->regdomainport != 4321 ||
  575. reg->callid_valid != FALSE ||
  576. reg->ocseq != INITIAL_CSEQ) {
  577. ast_test_status_update(test, "Test 14, domain port without secret failed.\n");
  578. res = AST_TEST_FAIL;
  579. }
  580. ast_string_field_free_memory(reg);
  581. ast_free(reg);
  582. return res;
  583. alloc_fail:
  584. ast_test_status_update(test, "Out of memory. \n");
  585. return res;
  586. }
  587. int sip_parse_host(char *line, int lineno, char **hostname, int *portnum, enum sip_transport *transport)
  588. {
  589. char *port;
  590. if (ast_strlen_zero(line)) {
  591. *hostname = NULL;
  592. return -1;
  593. }
  594. if ((*hostname = strstr(line, "://"))) {
  595. *hostname += 3;
  596. if (!strncasecmp(line, "tcp", 3)) {
  597. *transport = SIP_TRANSPORT_TCP;
  598. } else if (!strncasecmp(line, "tls", 3)) {
  599. *transport = SIP_TRANSPORT_TLS;
  600. } else if (!strncasecmp(line, "udp", 3)) {
  601. *transport = SIP_TRANSPORT_UDP;
  602. } else if (lineno) {
  603. ast_log(LOG_NOTICE, "'%.3s' is not a valid transport type on line %d of sip.conf. defaulting to udp.\n", line, lineno);
  604. } else {
  605. ast_log(LOG_NOTICE, "'%.3s' is not a valid transport type in sip config. defaulting to udp.\n", line);
  606. }
  607. } else {
  608. *hostname = line;
  609. *transport = SIP_TRANSPORT_UDP;
  610. }
  611. if ((line = strrchr(*hostname, '@')))
  612. line++;
  613. else
  614. line = *hostname;
  615. if (ast_sockaddr_split_hostport(line, hostname, &port, 0) == 0) {
  616. if (lineno) {
  617. ast_log(LOG_WARNING, "Cannot parse host '%s' on line %d of sip.conf.\n",
  618. line, lineno);
  619. } else {
  620. ast_log(LOG_WARNING, "Cannot parse host '%s' in sip config.\n", line);
  621. }
  622. return -1;
  623. }
  624. if (port) {
  625. if (!sscanf(port, "%5u", portnum)) {
  626. if (lineno) {
  627. ast_log(LOG_NOTICE, "'%s' is not a valid port number on line %d of sip.conf. using default.\n", port, lineno);
  628. } else {
  629. ast_log(LOG_NOTICE, "'%s' is not a valid port number in sip config. using default.\n", port);
  630. }
  631. port = NULL;
  632. }
  633. }
  634. if (!port) {
  635. if (*transport & SIP_TRANSPORT_TLS) {
  636. *portnum = STANDARD_TLS_PORT;
  637. } else {
  638. *portnum = STANDARD_SIP_PORT;
  639. }
  640. }
  641. return 0;
  642. }
  643. AST_TEST_DEFINE(sip_parse_host_line_test)
  644. {
  645. int res = AST_TEST_PASS;
  646. char *host;
  647. int port;
  648. enum sip_transport transport;
  649. char host1[] = "www.blah.com";
  650. char host2[] = "tcp://www.blah.com";
  651. char host3[] = "tls://10.10.10.10";
  652. char host4[] = "tls://10.10.10.10:1234";
  653. char host5[] = "10.10.10.10:1234";
  654. switch (cmd) {
  655. case TEST_INIT:
  656. info->name = "sip_parse_host_line_test";
  657. info->category = "/channels/chan_sip/";
  658. info->summary = "tests sip.conf host line parsing";
  659. info->description =
  660. "Tests parsing of various host line configurations. "
  661. "Verifies output matches expected behavior.";
  662. return AST_TEST_NOT_RUN;
  663. case TEST_EXECUTE:
  664. break;
  665. }
  666. /* test 1, simple host */
  667. sip_parse_host(host1, 1, &host, &port, &transport);
  668. if (port != STANDARD_SIP_PORT ||
  669. ast_strlen_zero(host) || strcmp(host, "www.blah.com") ||
  670. transport != SIP_TRANSPORT_UDP) {
  671. ast_test_status_update(test, "Test 1: simple host failed.\n");
  672. res = AST_TEST_FAIL;
  673. }
  674. /* test 2, add tcp transport */
  675. sip_parse_host(host2, 1, &host, &port, &transport);
  676. if (port != STANDARD_SIP_PORT ||
  677. ast_strlen_zero(host) || strcmp(host, "www.blah.com") ||
  678. transport != SIP_TRANSPORT_TCP) {
  679. ast_test_status_update(test, "Test 2: tcp host failed.\n");
  680. res = AST_TEST_FAIL;
  681. }
  682. /* test 3, add tls transport */
  683. sip_parse_host(host3, 1, &host, &port, &transport);
  684. if (port != STANDARD_TLS_PORT ||
  685. ast_strlen_zero(host) || strcmp(host, "10.10.10.10") ||
  686. transport != SIP_TRANSPORT_TLS) {
  687. ast_test_status_update(test, "Test 3: tls host failed. \n");
  688. res = AST_TEST_FAIL;
  689. }
  690. /* test 4, add custom port with tls */
  691. sip_parse_host(host4, 1, &host, &port, &transport);
  692. if (port != 1234 || ast_strlen_zero(host) ||
  693. strcmp(host, "10.10.10.10") ||
  694. transport != SIP_TRANSPORT_TLS) {
  695. ast_test_status_update(test, "Test 4: tls host with custom port failed.\n");
  696. res = AST_TEST_FAIL;
  697. }
  698. /* test 5, simple host with custom port */
  699. sip_parse_host(host5, 1, &host, &port, &transport);
  700. if (port != 1234 || ast_strlen_zero(host) ||
  701. strcmp(host, "10.10.10.10") ||
  702. transport != SIP_TRANSPORT_UDP) {
  703. ast_test_status_update(test, "Test 5: simple host with custom port failed.\n");
  704. res = AST_TEST_FAIL;
  705. }
  706. /* test 6, expected failure with NULL input */
  707. if (!sip_parse_host(NULL, 1, &host, &port, &transport)) {
  708. ast_test_status_update(test, "Test 6: expected error on NULL input did not occur.\n");
  709. res = AST_TEST_FAIL;
  710. }
  711. return res;
  712. }
  713. /*! \brief SIP test registration */
  714. void sip_config_parser_register_tests(void)
  715. {
  716. AST_TEST_REGISTER(sip_parse_register_line_test);
  717. AST_TEST_REGISTER(sip_parse_host_line_test);
  718. }
  719. /*! \brief SIP test registration */
  720. void sip_config_parser_unregister_tests(void)
  721. {
  722. AST_TEST_UNREGISTER(sip_parse_register_line_test);
  723. AST_TEST_UNREGISTER(sip_parse_host_line_test);
  724. }