2 * @brief GNUDIP Service class implementation. This class represents the GNUDIP service.
6 * @copyright Intra2net AG
10 #include "service_gnudip.hpp"
14 #include <boost/foreach.hpp>
15 #include <boost/regex.hpp>
21 * Default Constructor, needed for object serialization.
23 ServiceGnudip::ServiceGnudip()
30 * @param _hostname The hostname to update
31 * @param _login The login name.
32 * @param _password The corresponding password.
34 ServiceGnudip::ServiceGnudip(const string& _protocol, const string& _gnudip_server, const string& _hostname, const string& _login, const string& _password, const Logger::Ptr& _logger, const int _update_interval, const int _max_updates_within_interval, const int _dns_cache_ttl, const string& _proxy, const int _proxy_port)
35 : GnudipServer(_gnudip_server)
37 if ( _update_interval == -1 ) // If _update_interval is default po::option_desc (not specified via config)
38 set_update_interval(0); // use default protocol value
40 set_update_interval(_update_interval);
42 if ( _max_updates_within_interval == -1 )
43 set_max_updates_within_interval(0);
45 set_max_updates_within_interval(_max_updates_within_interval);
47 if ( _dns_cache_ttl == -1 )
48 set_dns_cache_ttl(60);
50 set_dns_cache_ttl(_dns_cache_ttl);
52 set_protocol(_protocol);
53 set_hostname(_hostname);
55 set_password(_password);
58 // create http helper class
59 HTTPHelp = HTTPHelper::Ptr(new HTTPHelper(_logger,_proxy,_proxy_port,_login,_password));
61 BaseUrl = assemble_base_url(_gnudip_server);
68 ServiceGnudip::~ServiceGnudip()
74 * Assemble the dyndns update url from the given fqhn
75 * @param gnudip_server The gnudip update server.
76 * @return The assembled update url without IP.
78 string ServiceGnudip::assemble_base_url(const string& gnudip_server) const
83 base_url.append(gnudip_server);
84 base_url.append("/gnudip/cgi-bin/gdipupdt.cgi");
91 * Parses the data received from the initial request, which should contain salt, time and sign.
92 * @param curl_data The complete received curl data.
93 * @return A map with salt, time and sign or an empty map.
95 map<string,string> ServiceGnudip::parse_initial_request(const string& curl_data) const
97 map<string,string> response;
100 boost::regex expr_salt("<meta name=\"salt\" content=\"([^\"]*)\"");
102 boost::regex expr_time("<meta name=\"time\" content=\"([^\"]*)\"");
104 boost::regex expr_sign("<meta name=\"sign\" content=\"([^\"]*)\"");
106 boost::smatch matches;
108 // Get the salt out of received http data
109 if ( boost::regex_search(curl_data,matches,expr_salt) )
111 response.insert(pair<string,string>("salt",matches[1].str())); /*lint !e534 */
112 get_logger()->print_regex_match(expr_salt.str(),matches[1].str());
116 get_logger()->print_no_regex_match(expr_salt.str(),curl_data);
121 // Get the time out of received http data
122 if ( boost::regex_search(curl_data,matches,expr_time) )
124 response.insert(pair<string,string>("time",matches[1].str())); /*lint !e534 */
125 get_logger()->print_regex_match(expr_salt.str(),matches[1].str());
129 get_logger()->print_no_regex_match(expr_salt.str(),curl_data);
134 // Get the sign out of received http data
135 if ( boost::regex_search(curl_data,matches,expr_sign) )
137 response.insert(pair<string,string>("sign",matches[1].str())); /*lint !e534 */
138 get_logger()->print_regex_match(expr_salt.str(),matches[1].str());
142 get_logger()->print_no_regex_match(expr_salt.str(),curl_data);
152 * Parses the data received from the update request, which should contain the return code.
153 * @param curl_data The complete received curl data.
154 * @return A string containing the return code of the update request.
156 string ServiceGnudip::parse_return_code(const string& curl_data) const
160 // regex for return code
161 boost::regex expr_retc("<meta name=\"retc\" content=\"([^\"]*)\"");
162 boost::smatch matches;
164 // Get the return code out of received http data
165 if ( boost::regex_search(curl_data,matches,expr_retc) )
167 return_code = matches[1].str();
168 get_logger()->print_regex_match(expr_retc.str(),matches[1].str());
172 get_logger()->print_no_regex_match(expr_retc.str(),curl_data);
181 * Get the assembled update url.
182 * @param salt Salt from the initial request
183 * @param time Time from the initial request
184 * @param sign Sign from the initial request
185 * @param secret Computed md5 secret in HEX
186 * @param ip IP to update
187 * @return The assembled update url.
189 string ServiceGnudip::assemble_update_url(const string& salt, const string& curr_time, const string& sign, const string& secret, const string& ip) const
191 string url = BaseUrl;
193 url.append("?salt=");
195 url.append("&time=");
196 url.append(curr_time);
197 url.append("&sign=");
199 url.append("&user=");
200 url.append(get_login());
201 url.append("&domn=");
202 string fqhn = get_hostname();
203 string domain = fqhn.substr(fqhn.find('.')+1);
205 url.append("&pass=");
207 url.append("&reqc=0&addr=");
215 * Performs the Service update.
216 * @param ip IP Address to set.
217 * @return 0 if all is fine, -1 otherwise.
219 int ServiceGnudip::perform_update(const std::string& ip)
221 if ( HTTPHelp->is_initialized() )
224 long http_status_code = HTTPHelp->http_get(BaseUrl);
226 get_logger()->print_http_status_code(BaseUrl,http_status_code);
228 if ( http_status_code == 200 )
230 // Get the received http data which should contain the salt, time and sign
231 string curl_data = HTTPHelp->get_curl_data();
233 // Parse salt, time and sign out of the received data
234 map<string,string> salt_time_sign = parse_initial_request(curl_data);
236 if ( salt_time_sign.empty() )
238 get_logger()->print_could_not_parse_received_data(curl_data);
242 // at this point we have salt, time and sign parsed successfully
243 string salt, sign_time, sign;
245 map<string,string>::iterator iter = salt_time_sign.find("salt");
246 if ( iter != salt_time_sign.end() )
249 iter = salt_time_sign.find("time");
250 if ( iter != salt_time_sign.end() )
251 sign_time = iter->second;
253 iter = salt_time_sign.find("sign");
254 if ( iter != salt_time_sign.end() )
257 if ( salt.empty() || sign_time.empty() || sign.empty() )
258 get_logger()->print_could_not_get_initial_gnudip_data();
260 // compute md5 sum from users password and get the HEX representation
264 pw_md5_hex = Util::compute_md5_digest(get_password());
266 catch ( exception& e )
268 get_logger()->print_exception_md5_sum(e.what());
273 get_logger()->print_exception_md5_sum("Unknown exception");
277 // append "." and salt and compute md5 sum and get the HEX representation
278 pw_md5_hex.append(".");
279 pw_md5_hex.append(salt);
284 secret = Util::compute_md5_digest(pw_md5_hex);
286 catch ( exception& e )
288 get_logger()->print_exception_md5_sum(e.what());
293 get_logger()->print_exception_md5_sum("Unknown exception");
297 // Now its time to issue the second http_get operation
298 string url = assemble_update_url(salt, sign_time, sign, secret, ip);
300 // perform the update operation
301 http_status_code = HTTPHelp->http_get(url);
303 get_logger()->print_http_status_code(url,http_status_code);
305 if ( http_status_code == 200 )
307 // parse the update request return code
308 curl_data = HTTPHelp->get_curl_data();
309 string update_return_code = parse_return_code(curl_data);
310 if ( update_return_code == "0" )
314 else if ( update_return_code == "1" )
316 get_logger()->print_service_not_authorized(url,get_login(),get_password());
320 get_logger()->print_update_failure(url,update_return_code);
325 // second http get operation (update) was not successful
326 get_logger()->print_update_failure(url,http_status_code);
331 // first http get operation was not successful
332 get_logger()->print_update_failure(BaseUrl,http_status_code);
337 get_logger()->print_httphelper_not_initialized();
338 HTTPHelp->re_initialize();