HTTP command config aka HTTP control socket info class.  
 More...
#include <http_command_config.h>
HTTP command config aka HTTP control socket info class. 
Definition at line 21 of file http_command_config.h.
◆ HttpCommandConfig()
Constructor. 
- Parameters
- 
  
    | config | Pointer to the configuration to parse. |  
 
Definition at line 35 of file http_command_config.cc.
References Element::boolean, isc::config::COMMAND_HTTP_SOCKET_SECURITY_WARNING, isc::config::command_logger, Element::create(), DEFAULT_AUTHENTICATION_REALM, DEFAULT_SOCKET_ADDRESS, DEFAULT_SOCKET_PORT, if(), Element::integer, isc_throw, LOG_WARN, Element::map, isc::http::parseCfgHttpHeaders(), isc::data::UserContext::setContext(), isc::util::file::PathChecker::shouldEnforceSecurity(), and Element::string.
 
 
◆ ~HttpCommandConfig()
  
  | 
        
          | isc::config::HttpCommandConfig::~HttpCommandConfig | ( |  | ) |  |  | default | 
 
 
◆ getAuthConfig()
Returns HTTP authentication configuration. 
- Note
- Only the basic HTTP authentication is supported.
- Returns
- HTTP authentication configuration. 
Definition at line 93 of file http_command_config.h.
 
 
◆ getCertFile()
  
  | 
        
          | std::string isc::config::HttpCommandConfig::getCertFile | ( |  | ) | const |  | inline | 
 
Returns cert-file TLS parameter. 
- Returns
- Server certificate file name. 
Definition at line 124 of file http_command_config.h.
 
 
◆ getCertRequired()
  
  | 
        
          | bool isc::config::HttpCommandConfig::getCertRequired | ( |  | ) | const |  | inline | 
 
Returns cert-required TLS parameter. 
- Returns
- True when client certificates are required, false when they are optional, the default is to require them (true). 
Definition at line 153 of file http_command_config.h.
 
 
◆ getEmulateAgentResponse()
  
  | 
        
          | bool isc::config::HttpCommandConfig::getEmulateAgentResponse | ( |  | ) | const |  | inline | 
 
Returns emulate agent response flag. 
- Returns
- True when responses for normal command outcomes are guaranteed to be wrapped in an Element::list. This emulates how kea-ctrl-agent forms responses. Defaults to true. 
Definition at line 170 of file http_command_config.h.
 
 
◆ getHttpHeaders()
Returns http-headers configuration. 
- Returns
- Collection of config HTTP headers. 
Definition at line 77 of file http_command_config.h.
 
 
◆ getKeyFile()
  
  | 
        
          | std::string isc::config::HttpCommandConfig::getKeyFile | ( |  | ) | const |  | inline | 
 
Returns key-file TLS parameter. 
- Returns
- Server private key file name. 
Definition at line 138 of file http_command_config.h.
 
 
◆ getSocketAddress()
Returns socket address. 
- Returns
- IP address where the HTTP service is available. 
Definition at line 49 of file http_command_config.h.
 
 
◆ getSocketPort()
  
  | 
        
          | uint16_t isc::config::HttpCommandConfig::getSocketPort | ( |  | ) | const |  | inline | 
 
Returns socket port. 
- Returns
- TCP port where the HTTP service is available. 
Definition at line 63 of file http_command_config.h.
 
 
◆ getSocketType()
  
  | 
        
          | std::string isc::config::HttpCommandConfig::getSocketType | ( |  | ) | const |  | inline | 
 
Returns socket type. 
- Returns
- The socket type ("http" or "https"). 
Definition at line 35 of file http_command_config.h.
 
 
◆ getTrustAnchor()
  
  | 
        
          | std::string isc::config::HttpCommandConfig::getTrustAnchor | ( |  | ) | const |  | inline | 
 
Returns trust-anchor TLS parameter. 
- Returns
- Trust anchor aka Certificate Authority. 
Definition at line 109 of file http_command_config.h.
 
 
◆ setAuthConfig()
Sets HTTP authentication configuration. 
- Note
- Only the basic HTTP authentication is supported.
- Parameters
- 
  
    | auth_config | HTTP authentication configuration. |  
 
Definition at line 102 of file http_command_config.h.
 
 
◆ setCertFile()
  
  | 
        
          | void isc::config::HttpCommandConfig::setCertFile | ( | const std::string & | cert | ) |  |  | inline | 
 
Sets cert-file TLS parameter. 
- Parameters
- 
  
    | cert | Server certificate file name. |  
 
Definition at line 131 of file http_command_config.h.
 
 
◆ setCertRequired()
  
  | 
        
          | void isc::config::HttpCommandConfig::setCertRequired | ( | bool | required | ) |  |  | inline | 
 
Sets cert-required TLS parameter. 
- Parameters
- 
  
    | required | Client certificates are required when true (the default) or optional when false. |  
 
Definition at line 161 of file http_command_config.h.
 
 
◆ setEmulateAgentResponse()
  
  | 
        
          | void isc::config::HttpCommandConfig::setEmulateAgentResponse | ( | const bool | emulate_agent_response | ) |  |  | inline | 
 
Sets emulate agent response flag. 
- Parameters
- 
  
    | emulate_agent_response | The new value of the emulation flag. |  
 
Definition at line 177 of file http_command_config.h.
 
 
◆ setHttpHeaders()
Sets http-headers configuration. 
- Parameters
- 
  
    | headers | Collection of config HTTP headers. |  
 
Definition at line 84 of file http_command_config.h.
 
 
◆ setKeyFile()
  
  | 
        
          | void isc::config::HttpCommandConfig::setKeyFile | ( | const std::string & | key | ) |  |  | inline | 
 
Sets key-file TLS parameter. 
- Parameters
- 
  
    | key | Server private key file name. |  
 
Definition at line 145 of file http_command_config.h.
 
 
◆ setSocketAddress()
Sets socket address. 
- Parameters
- 
  
    | socket_address | The new socket address. |  
 
Definition at line 56 of file http_command_config.h.
 
 
◆ setSocketPort()
  
  | 
        
          | void isc::config::HttpCommandConfig::setSocketPort | ( | const uint16_t | socket_port | ) |  |  | inline | 
 
 
◆ setSocketType()
  
  | 
        
          | void isc::config::HttpCommandConfig::setSocketType | ( | const std::string & | socket_type | ) |  |  | inline | 
 
Sets socket type. 
- Parameters
- 
  
    | socket_type | The new socket type (should be "http" or "https"). |  
 
Definition at line 42 of file http_command_config.h.
 
 
◆ setTrustAnchor()
  
  | 
        
          | void isc::config::HttpCommandConfig::setTrustAnchor | ( | const std::string & | ca | ) |  |  | inline | 
 
Sets trust-anchor TLS parameter. 
- Parameters
- 
  
    | ca | Trust anchor aka Certificate Authority (can be a file name or a directory path). |  
 
Definition at line 117 of file http_command_config.h.
 
 
◆ toElement()
  
  | 
        
          | ElementPtr isc::config::HttpCommandConfig::toElement | ( |  | ) | const |  | virtual | 
 
 
◆ DEFAULT_AUTHENTICATION_REALM
  
  | 
        
          | string isc::config::HttpCommandConfig::DEFAULT_AUTHENTICATION_REALM = "" |  | static | 
 
 
◆ DEFAULT_SOCKET_ADDRESS
  
  | 
        
          | IOAddress isc::config::HttpCommandConfig::DEFAULT_SOCKET_ADDRESS = IOAddress("127.0.0.1") |  | static | 
 
 
◆ DEFAULT_SOCKET_PORT
  
  | 
        
          | uint16_t isc::config::HttpCommandConfig::DEFAULT_SOCKET_PORT = 8000 |  | static | 
 
 
The documentation for this class was generated from the following files: