2 * @brief IPHelper class implementation. This class represents a Helper to get the actual IP.
6 * @copyright Intra2net AG
10 #include "ip_addr_helper.h"
11 #include <boost/asio.hpp>
12 #include <boost/regex.hpp>
16 namespace net = boost::asio;
19 * Default constructor.
21 IPAddrHelper::IPAddrHelper()
32 IPAddrHelper::IPAddrHelper(const Logger::Ptr _log, const string& _webcheck_url, const string& _webcheck_url_alt, const bool _use_ipv6, const string& _proxy, const int _proxy_port)
34 , WebcheckIpUrl(_webcheck_url)
35 , WebcheckIpUrlAlt(_webcheck_url_alt)
37 , ProxyPort(_proxy_port)
40 Hostname = net::ip::host_name();
41 Log->print_hostname(Hostname);
48 IPAddrHelper::~IPAddrHelper()
54 * Tests if a given IP is a local address
55 * @param ip The IP to test
56 * @return true if given IP is local, false if not.
58 bool IPAddrHelper::is_local(const string ip) const
61 boost::regex expr_loopback("127\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}");
64 boost::regex expr_192("192\\.168\\.[0-9]{1,3}\\.[0-9]{1,3}");
67 boost::regex expr_10("10\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}");
70 boost::regex expr_169_254("169\\.254\\.[0-9]{1,3}\\.[0-9]{1,3}");
72 // 172.16.x.x -> 172.31.x.x
73 boost::regex expr_172_1("172\\.1[6-9]{1}\\.[0-9]{1,3}\\.[0-9]{1,3}");
74 boost::regex expr_172_2("172\\.2[0-9]{1}\\.[0-9]{1,3}\\.[0-9]{1,3}");
75 boost::regex expr_172_3("172\\.3[0-1]{1}\\.[0-9]{1,3}\\.[0-9]{1,3}");
77 // It's time to test against the regex patterns
78 if ( boost::regex_search(ip,expr_loopback) )
80 Log->print_regex_match(expr_loopback.str(),ip);
83 else if ( boost::regex_search(ip,expr_192) )
85 Log->print_regex_match(expr_192.str(),ip);
88 else if ( boost::regex_search(ip,expr_10) )
90 Log->print_regex_match(expr_10.str(),ip);
93 else if ( boost::regex_search(ip,expr_169_254) )
95 Log->print_regex_match(expr_169_254.str(),ip);
98 else if ( boost::regex_search(ip,expr_172_1) )
100 Log->print_regex_match(expr_172_1.str(),ip);
103 else if ( boost::regex_search(ip,expr_172_2) )
105 Log->print_regex_match(expr_172_2.str(),ip);
108 else if ( boost::regex_search(ip,expr_172_3) )
110 Log->print_regex_match(expr_172_3.str(),ip);
119 * Get the actual IP of this host through a conventional DNS query or through a IP webcheck URL if configured so.
120 * @return A string representation of the actual IP in dotted format or an empty string if something went wrong.
122 string IPAddrHelper::get_actual_ip() const
125 if ( WebcheckIpUrl.empty() )
134 // If IP is within a private range then return ""
137 Log->print_ip_is_local(ip);
146 * Get the actual IP of the given host through a DNS query.
147 * @param _hostname The hostname for the dns lookup, if empty string, then perform a dns lookup to the local hostname.
148 * @return A string representation of the actual IP in dotted format or an empty string if something went wrong.
150 string IPAddrHelper::dns_query(const string& _hostname) const
155 string hostname = Hostname;
156 if ( !_hostname.empty() )
157 hostname = _hostname;
161 // BOOST asio isn't the simplest way to perform a DNS lookup, but it works just fine.
162 net::io_service io_service;
163 net::ip::tcp::resolver resolver(io_service);
164 net::ip::tcp::resolver::query query(hostname, "0");
165 net::ip::tcp::resolver::iterator endpoint_iterator = resolver.resolve(query);
166 net::ip::tcp::resolver::iterator end;
167 while(endpoint_iterator != end)
170 ip = endpoint_iterator->endpoint().address();
172 ip_addr_v4 = ip.to_string();
173 else if ( ip.is_v6() )
174 ip_addr_v6 = ip.to_string();
175 Log->print_own_ipv4(ip_addr_v4, hostname);
176 if ( UseIPv6 == true )
177 Log->print_own_ipv6(ip_addr_v6, hostname);
184 Log->print_error_hostname_to_ip(e.what(),hostname);
188 if ( (UseIPv6 == true) && (ip_addr_v6 != "") )
196 * Get the actual IP of this host through a IP webcheck URL.
197 * @return A string representation of the actual IP in dotted format or an empty string if something went wrong.
199 string IPAddrHelper::webcheck_ip() const
204 string curl_writedata_buff;
205 char curl_err_buff[CURL_ERROR_SIZE];
209 list<string> url_list;
210 url_list.push_back(WebcheckIpUrl);
211 url_list.push_back(WebcheckIpUrlAlt);
215 CURL * curl_easy_handle = init_curl(curl_writedata_buff,curl_err_buff);
217 // If perform_curl_operation returns a connection problem indicating return code, try the next ip webcheck url if there is one.
218 while ( (curl_err_code == 1) && (url_list.size() != 0) && (url_list.front() != "") )
221 actual_url = url_list.front();
222 url_list.pop_front();
223 set_curl_url(curl_easy_handle,actual_url);
225 // Perform curl operation
226 curl_err_code = perform_curl_operation(curl_easy_handle, curl_err_buff, actual_url);
229 // Cleanup CURL handle
230 curl_easy_cleanup(curl_easy_handle);
232 // If curl_err_code is not 0, the ip couldn't be determined through any configured webcheck url.
233 if ( curl_err_code != 0 )
235 Log->print_webcheck_no_ip();
240 Log->print_received_curl_data(curl_writedata_buff);
242 ip_addr = parse_ip(curl_writedata_buff);
249 * Tries to find a valid IPv4 Address in dottet format in a given string and returns the IP-Address found.
250 * @param data The string data to search in for a valid IPv4-Address.
251 * @return The IP Address found or an empty string.
253 string IPAddrHelper::parse_ip(const string& data) const
257 // regex for valid ip address
258 boost::regex expr("([0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3})");
260 boost::smatch matches;
262 if ( boost::regex_search(data,matches,expr) )
265 Log->print_regex_found_ip(ip);
269 Log->print_regex_ip_not_found(data);
277 * Performs the curl operation.
278 * @param curl_easy_handle The initialized and configured curl handle.
279 * @param curl_err_buff The pointer to the curl error buffer to get error messages from.
280 * @param actual_url The actual configured URL.
281 * @return 0 if all is fine, 1 if an connection problem to the configured url occurs, -1 on other errors.
283 int IPAddrHelper::perform_curl_operation(CURL * curl_easy_handle, char* curl_err_buff, const string& actual_url) const
286 if ( (curl_err_code = curl_easy_perform(curl_easy_handle) ) != 0 )
288 // CURL error occured
289 if ( (curl_err_code == CURLE_COULDNT_CONNECT) || (curl_err_code == CURLE_OPERATION_TIMEOUTED) || (curl_err_code == CURLE_COULDNT_RESOLVE_HOST) )
291 // In case of connection problems we should return 1, that the fallback url will be used.
292 Log->print_webcheck_url_connection_problem(curl_err_buff, actual_url);
298 Log->print_webcheck_error(curl_err_buff, actual_url);
302 // Operation performed without any problems
308 * Sets a url to the easy curl handle
309 * @param curl_easy_handle The easy curl handle to set the url for.
310 * @param url The url to set.
312 void IPAddrHelper::set_curl_url(CURL * curl_easy_handle, const string& url) const
314 curl_easy_setopt(curl_easy_handle,CURLOPT_URL,url.c_str());
319 * Initialized curl easy handle with a few options.
320 * @param curl_writedata_buff Reference to a string wich will be filled with the curl result
321 * @param curl_err_buff A pointer to an char array which will be filled with error message.
322 * @return A pointer to the easy curl handle.
324 CURL * IPAddrHelper::init_curl(string& curl_writedata_buff,char* curl_err_buff) const
326 CURL *curl_easy_handle = curl_easy_init();
328 curl_easy_setopt(curl_easy_handle,CURLOPT_NOPROGRESS,1);
329 curl_easy_setopt(curl_easy_handle,CURLOPT_CONNECTTIMEOUT,5);
330 curl_easy_setopt(curl_easy_handle,CURLOPT_TIMEOUT,10);
331 curl_easy_setopt(curl_easy_handle,CURLOPT_BUFFERSIZE,1024);
332 curl_easy_setopt(curl_easy_handle,CURLOPT_ERRORBUFFER,curl_err_buff);
333 curl_easy_setopt(curl_easy_handle,CURLOPT_WRITEFUNCTION,http_receive);
334 curl_easy_setopt(curl_easy_handle,CURLOPT_WRITEDATA,&curl_writedata_buff);
336 if ( !Proxy.empty() )
338 curl_easy_setopt(curl_easy_handle,CURLOPT_PROXY,Proxy.c_str());
339 curl_easy_setopt(curl_easy_handle,CURLOPT_PROXYPORT,ProxyPort);
342 return curl_easy_handle;
347 * Callback Function is called every time CURL is receiving data from HTTPS-Server and will copy all received Data to the given stream pointer
348 * @param inBuffer Pointer to input.
349 * @param size How many mem blocks are received
350 * @param nmemb size of each memblock
351 * @param outBuffer Pointer to output stream.
352 * @return The size received.
354 int IPAddrHelper::http_receive( char *inBuffer, size_t size, size_t nmemb, string *outBuffer )
356 outBuffer->append(inBuffer);