mirror of
https://github.com/asterisk/asterisk.git
synced 2025-09-02 19:16:15 +00:00
64aeb20724
This commit adds the ability to make ARI REST requests over the same
websocket used to receive events.
For full details on how to use the new capability, visit...
https://docs.asterisk.org/Configuration/Interfaces/Asterisk-REST-Interface-ARI/ARI-REST-over-WebSocket/
Changes:
* Added utilities to http.c:
* ast_get_http_method_from_string().
* ast_http_parse_post_form().
* Added utilities to json.c:
* ast_json_nvp_array_to_ast_variables().
* ast_variables_to_json_nvp_array().
* Added definitions for new events to carry REST responses.
* Created res/ari/ari_websocket_requests.c to house the new request handlers.
* Moved non-event specific code out of res/ari/resource_events.c into
res/ari/ari_websockets.c
* Refactored res/res_ari.c to move non-http code out of ast_ari_callback()
(which is http specific) and into ast_ari_invoke() so it can be shared
between both the http and websocket transports.
UpgradeNote: This commit adds the ability to make ARI REST requests over the same
websocket used to receive events.
See https://docs.asterisk.org/Configuration/Interfaces/Asterisk-REST-Interface-ARI/ARI-REST-over-WebSocket/
(cherry picked from commit 6bc055416b)
147 lines
3.3 KiB
C
147 lines
3.3 KiB
C
/*
|
|
* Asterisk -- An open source telephony toolkit.
|
|
*
|
|
* Copyright (C) 2013, Digium, Inc.
|
|
*
|
|
* David M. Lee, II <dlee@digium.com>
|
|
*
|
|
* 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.
|
|
*/
|
|
|
|
#ifndef ARI_INTERNAL_H_
|
|
#define ARI_INTERNAL_H_
|
|
|
|
/*! \file
|
|
*
|
|
* \brief Internal API's for res_ari.
|
|
* \author David M. Lee, II <dlee@digium.com>
|
|
*/
|
|
|
|
#include "asterisk/http.h"
|
|
#include "asterisk/json.h"
|
|
#include "asterisk/stringfields.h"
|
|
|
|
/*! @{ */
|
|
|
|
/*!
|
|
* \brief Register CLI commands for ARI.
|
|
*
|
|
* \return 0 on success.
|
|
* \return Non-zero on error.
|
|
*/
|
|
int ast_ari_cli_register(void);
|
|
|
|
/*!
|
|
* \brief Unregister CLI commands for ARI.
|
|
*/
|
|
void ast_ari_cli_unregister(void);
|
|
|
|
/*! @} */
|
|
|
|
/*! @{ */
|
|
|
|
struct ast_ari_conf_general;
|
|
|
|
/*! \brief All configuration options for ARI. */
|
|
struct ast_ari_conf {
|
|
/*! The general section configuration options. */
|
|
struct ast_ari_conf_general *general;
|
|
/*! Configured users */
|
|
struct ao2_container *users;
|
|
};
|
|
|
|
/*! Max length for auth_realm field */
|
|
#define ARI_AUTH_REALM_LEN 256
|
|
|
|
/*! \brief Global configuration options for ARI. */
|
|
struct ast_ari_conf_general {
|
|
/*! Enabled by default, disabled if false. */
|
|
int enabled;
|
|
/*! Write timeout for websocket connections */
|
|
int write_timeout;
|
|
/*! Encoding format used during output (default compact). */
|
|
enum ast_json_encoding_format format;
|
|
/*! Authentication realm */
|
|
char auth_realm[ARI_AUTH_REALM_LEN];
|
|
|
|
AST_DECLARE_STRING_FIELDS(
|
|
AST_STRING_FIELD(allowed_origins);
|
|
);
|
|
};
|
|
|
|
/*! \brief Password format */
|
|
enum ast_ari_password_format {
|
|
/*! \brief Plaintext password */
|
|
ARI_PASSWORD_FORMAT_PLAIN,
|
|
/*! crypt(3) password */
|
|
ARI_PASSWORD_FORMAT_CRYPT,
|
|
};
|
|
|
|
/*!
|
|
* \brief User's password mx length.
|
|
*
|
|
* If 256 seems like a lot, a crypt SHA-512 has over 106 characters.
|
|
*/
|
|
#define ARI_PASSWORD_LEN 256
|
|
|
|
/*! \brief Per-user configuration options */
|
|
struct ast_ari_conf_user {
|
|
/*! Username for authentication */
|
|
char *username;
|
|
/*! User's password. */
|
|
char password[ARI_PASSWORD_LEN];
|
|
/*! Format for the password field */
|
|
enum ast_ari_password_format password_format;
|
|
/*! If true, user cannot execute change operations */
|
|
int read_only;
|
|
};
|
|
|
|
/*!
|
|
* \brief Initialize the ARI configuration
|
|
*/
|
|
int ast_ari_config_init(void);
|
|
|
|
/*!
|
|
* \brief Reload the ARI configuration
|
|
*/
|
|
int ast_ari_config_reload(void);
|
|
|
|
/*!
|
|
* \brief Destroy the ARI configuration
|
|
*/
|
|
void ast_ari_config_destroy(void);
|
|
|
|
/*!
|
|
* \brief Get the current ARI configuration.
|
|
*
|
|
* This is an immutable object, so don't modify it. It is AO2 managed, so
|
|
* ao2_cleanup() when you're done with it.
|
|
*
|
|
* \return ARI configuration object.
|
|
* \retval NULL on error.
|
|
*/
|
|
struct ast_ari_conf *ast_ari_config_get(void);
|
|
|
|
/*!
|
|
* \brief Validated a user's credentials.
|
|
*
|
|
* \param username Name of the user.
|
|
* \param password User's password.
|
|
* \return User object.
|
|
* \retval NULL if username or password is invalid.
|
|
*/
|
|
struct ast_ari_conf_user *ast_ari_config_validate_user(const char *username,
|
|
const char *password);
|
|
|
|
/*! @} */
|
|
|
|
#endif /* ARI_INTERNAL_H_ */
|