Skip to content
Snippets Groups Projects
reqresp_parser.h 3.82 KiB
Newer Older
  • Learn to ignore specific revisions
  • David Vossel's avatar
    David Vossel committed
    /*
     * Asterisk -- An open source telephony toolkit.
     *
     * Copyright (C) 2010, Digium, Inc.
     *
     * See http://www.asterisk.org for more information about
     * the Asterisk project. Please do not directly contact
     * any of the maintainers of this project for assistance;
     * the project provides a web site, mailing lists and IRC
     * channels for your use.
     *
     * This program is free software, distributed under the terms of
     * the GNU General Public License Version 2. See the LICENSE file
     * at the top of the source tree.
     */
    
    /*!
     * \file
     * \brief sip request response parser header file
     */
    
    #ifndef _SIP_REQRESP_H
    #define _SIP_REQRESP_H
    
    
    /*!
     * \brief parses a URI in its components.
    
    David Vossel's avatar
    David Vossel committed
     *
     * \note
     * - Multiple scheme's can be specified ',' delimited. ex: "sip:,sips:"
     * - If a component is not requested, do not split around it. This means
     *   that if we don't have domain, we cannot split name:pass and domain:port.
     * - It is safe to call with ret_name, pass, domain, port pointing all to
     *   the same place.
    
     * - If no secret parameter is provided, ret_name will return with both parts, user:secret
     * - If no port parameter is provided, domain will return with both parts, domain:port
    
    David Vossel's avatar
    David Vossel committed
     * - This function overwrites the the uri string.
     * 
     * \retval 0 on success
     * \retval -1 on error.
     *
     * \verbatim
     * general form we are expecting is sip:user:password;user-parameters@host:port;uri-parameters?headers
     * \endverbatim
     */
    int parse_uri(char *uri, const char *scheme, char **ret_name, char **pass, char **domain, char **port, char **transport);
    
    
    /*!
     * \brief parses a URI in to all of its components and any trailing residue
     *
     * \retval 0 on success
     * \retval -1 on error.
     *
     */
    int parse_uri_full(char *uri, const char *scheme, char **user, char **pass, char **host, char **port, struct uriparams *params, char **headers, char **residue);
    
    
    /*!
     * \brief  Get caller id name from SIP headers, copy into output buffer
    
    David Vossel's avatar
    David Vossel committed
     *
    
     * \retval input string pointer placed after display-name field if possible
    
    David Vossel's avatar
    David Vossel committed
     */
    const char *get_calleridname(const char *input, char *output, size_t outputsize);
    
    
    /*!
     * \brief  Get name and number from sip header
     *
     * \note name and number point to malloced memory on return and must be
     * freed. If name or number is not found, they will be returned as NULL.
     *
     * \retval 0 success
     * \retval -1 failure
     */
    int get_name_and_number(const char *hdr, char **name, char **number);
    
    /*! \brief Pick out text in brackets from character string
     * \return pointer to terminated stripped string
     * \param tmp input string that will be modified
     *
     * Examples:
     * \verbatim
     * "foo" <bar>	valid input, returns bar
     *  foo returns the whole string
     * < "foo ... >	returns the string between brackets
     * < "foo...    bogus (missing closing bracket), returns the whole string
     * \endverbatim
     */
    char *get_in_brackets(char *tmp);
    
    
    /*! \brief Get text in brackets and any trailing residue
     *
     * \retval 0 success
     * \retval -1 failure
     * \retval 1 no brackets so got all
     */
    int get_in_brackets_full(char *tmp, char **out, char **residue);
    
    /*! \brief Parse the ABNF structure
     * name-andor-addr = name-addr / addr-spec
     * into its components and return any trailing message-header parameters
     *
     * \retval 0 success
     * \retval -1 failure
     */
    int parse_name_andor_addr(char *uri, const char *scheme, char **name, char **user, char **pass, char **host, char **port, struct uriparams *params, char **headers, char **remander);
    
    /*! \brief Parse all contact header contacts
     * \retval 0 success
     * \retval -1 failure
     * \retval 1 all contacts (star)
     */
    
    int get_comma(char *parse, char **out);
    
    int parse_contact_header(char *contactheader, struct contactliststruct *contactlist);
    
    
    /*!
     * \brief register request parsing tests
     */
    
    David Vossel's avatar
    David Vossel committed
    void sip_request_parser_register_tests(void);
    
    
    /*!
     * \brief unregister request parsing tests
     */
    
    David Vossel's avatar
    David Vossel committed
    void sip_request_parser_unregister_tests(void);
    
    #endif