Skip to content

Added CLI interface and did a little clean up. #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
+89 −51
Open

Added CLI interface and did a little clean up. #4

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1044536
refactored how the static ddns call worked since most everything want…
lwahlmeier Apr 9, 2014
ac35d86
Added comment around new function call
lwahlmeier Apr 9, 2014
06600b3
Removed an unneeded debug log message
lwahlmeier Apr 14, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
140 changes: 89 additions & 51 deletions godaddy-ddns.php
100644 → 100755
View file
Original file line number Diff line number Diff line change
@@ -50,10 +50,6 @@
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*******************************************************************************/

// Launch the method for accepting DDNS API requests
GoDaddyDNS::ddns(array(
'detect_external_ip' => false,
));

/**
* The main class for sending and parsing server requests to the
@@ -69,6 +65,8 @@ class GoDaddyDNS
private $_config;
private $_curlHandle;
private $_lastResponse;
public $_lastError;
public $_lastSuccess;

/**
* Initialize the configuration array with configuration defaults.
@@ -78,11 +76,13 @@ public function __construct($config = array()) {
$this->_config = array_merge(array(
'cookie_file' => tempnam(sys_get_temp_dir(), 'Curl'),
'auto_remove_cookie_file' => true,
'auto_logout' => false,
'auto_logout' => true,
'godaddy_dns_default_url' => 'https://dns.godaddy.com/default.aspx',
'godaddy_dns_zonefile_url' => 'https://dns.godaddy.com/ZoneFile.aspx?zoneType=0&sa=&zone=',
'godaddy_dns_zonefile_ws_url' => 'https://dns.godaddy.com/ZoneFile_WS.asmx',
'hostip_api_url' => 'http://api.hostip.info/',
'offline' => false,
'detect_external_ip' => false,
), $config);
}

@@ -122,87 +122,100 @@ public static function ddns($defaults = array()) {
), $defaults);

// Get request values from HTTP data, falling back to the defaults above
$username = isset($_SERVER['PHP_AUTH_USER']) ? $_SERVER['PHP_AUTH_USER'] :
$defaults['username'] = isset($_SERVER['PHP_AUTH_USER']) ? $_SERVER['PHP_AUTH_USER'] :
(isset($_REQUEST['user']) ? $_REQUEST['user'] : $defaults['username']);
$password = isset($_SERVER['PHP_AUTH_PW']) ? $_SERVER['PHP_AUTH_PW'] :
$defaults['password'] = isset($_SERVER['PHP_AUTH_PW']) ? $_SERVER['PHP_AUTH_PW'] :
(isset($_REQUEST['pw']) ? $_REQUEST['pw'] : $defaults['password']);
$hostname = isset($_REQUEST['hostname']) ? $_REQUEST['hostname'] : $defaults['hostname'];
$myip = isset($_REQUEST['myip']) ? $_REQUEST['myip'] :
$defaults['hostname'] = isset($_REQUEST['hostname']) ? $_REQUEST['hostname'] : $defaults['hostname'];
$defaults['myip'] = isset($_REQUEST['myip']) ? $_REQUEST['myip'] :
(isset($_SERVER['REMOTE_ADDR']) ? $_SERVER['REMOTE_ADDR'] : $defaults['myip']);
$offline = isset($_REQUEST['offline']) ? (strtoupper($_REQUEST['offline']) == 'YES') : $defaults['offline'];
$defaults['offline'] = isset($_REQUEST['offline']) ? (strtoupper($_REQUEST['offline']) == 'YES') : $defaults['offline'];


$dns = new self($defaults);
if(!$dns->updateRecord()) {
if($dns->_lastError == "noauth") {
header('WWW-Authenticate: Basic realm="Dynamic DNS"');
header('HTTP/1.1 401 Unauthorized');
} elseif($dns->_lastError == "badauth") {
header('WWW-Authenticate: Basic realm="Bad Auth"');
} else {//($dns->_lastError == "911" || $dns->_lastError == "nohost") {
header('HTTP/1.1 500 Internal Server Error');
}
echo $dns->_lastError;
} else {
echo (($dns->_lastSuccess['last_ip'] == $dns->_lastSuccess['new_ip']) ? 'nochg' : 'good') . ' ' . $dns->_lastSuccess['new_ip'];
}
}

if ($hostname) {
if ($username && $password) {
// Instantiate the GoDaddyDNS class
$dns = new self($defaults);

if ($dns->authenticate($username, $password, $hostname)) {
if ($offline) {
// Use offline IP
$myip = $defaults['offline_ip'];
} elseif ($defaults['detect_external_ip'] && $dns->isPrivateIp($myip)) {
if (($externalip = $dns->getPublicIp($myip))) {
// Use detected external IP
$myip = $externalip;
}
/**
* This is the normal process we run through to update a DNS entry, check/parse config, get any
* IP information then update the record.
* True is returned if we can update, false if we cant. _lastError and _lastSuccess where added to get
* any needed info from after we try.
*/
public function updateRecord() {
if ($this->_config['hostname']) {
if ($this->_config['username'] && $this->_config['password']) {
if ($this->authenticate()) {
if ($this->_config['offline']) {
$this->_config['myip'] = $this->_config['offline_ip'];
} elseif ($this->_config['detect_external_ip']) {
$this->_config['myip'] = $this->getPublicIp();
}

// Attempt to update the hostname's A record
if (($result = $dns->setRecord($hostname, $myip, 'A'))) {
echo (($result['last_ip'] == $result['new_ip']) ? 'nochg' : 'good') . ' ' . $result['new_ip'];
if (($result = $this->setRecord())) {
$this->_lastSuccess = $result;
return true;
} else {
header('HTTP/1.1 500 Internal Server Error');
echo '911';
$this->_lastError = '911';
}
} else {
header('HTTP/1.1 403 Forbidden');
echo 'badauth';
$this->_lastError = 'badauth';
}
} else {
header('WWW-Authenticate: Basic realm="Dynamic DNS"');
header('HTTP/1.1 401 Unauthorized');
echo 'noauth';
$this->_lastError = 'noauth';
}
} else {
header('HTTP/1.1 500 Internal Server Error');
echo 'nohost';
$this->_lastError = 'nohost';
}
return false;
}


/**
* Login to the user's account, returning an error if the credentials are
* invalid or the login fails.
*
* A optional FQDN or TLD can be specified to log the user directly into
* a specific zone record (eliminates an additional page request).
*/
public function authenticate($username, $password, $hostname = null) {
if ($hostname) {
list($host, $domain) = $this->_splitHostname($hostname);
public function authenticate() {
if ($this->_config['hostname']) {
list($host, $domain) = $this->_splitHostname($this->_config['hostname']);
$loginUrl = $this->_config['godaddy_dns_zonefile_url'] . $domain;
} else {
$loginUrl = $this->_config['godaddy_dns_default_url'];
}

$this->_lastResponse = $this->_fetchURL($loginUrl);
if (!$this->isLoggedIn($username)) {
if (!$this->isLoggedIn($this->_config['username'])) {
// User is not already logged in, build and submit a login request
$postUrl = curl_getinfo($this->_curlHandle, CURLINFO_EFFECTIVE_URL);

$post = array(
'Login$userEntryPanel2$LoginImageButton.x' => 0,
'Login$userEntryPanel2$LoginImageButton.y' => 0,
'Login$userEntryPanel2$UsernameTextBox' => $username,
'Login$userEntryPanel2$PasswordTextBox' => $password,
'Login$userEntryPanel2$UsernameTextBox' => $this->_config['username'],
'Login$userEntryPanel2$PasswordTextBox' => $this->_config['password'],
'__EVENTARGUMENT' => $this->_getField('__EVENTARGUMENT'),
'__EVENTTARGET' => $this->_getField('__EVENTTARGET'),
'__VIEWSTATE' => $this->_getField('__VIEWSTATE'),
);
$this->_lastResponse = $this->_fetchURL($postUrl, $post);

if (!$this->isLoggedIn($username, $this->_lastResponse)) {
if (!$this->isLoggedIn()) {
// Invalid username/password or unknown response received
return false;
}
@@ -213,9 +226,9 @@ public function authenticate($username, $password, $hostname = null) {
/**
* Check to see if the expected user is logged in.
*/
public function isLoggedIn($username) {
public function isLoggedIn() {
if (preg_match('#Welcome:&nbsp;<span id="ctl00_lblUser" .*?\>(.*)</span>#', $this->_lastResponse, $match)) {
if (substr(strtolower($match[1]),0,7) == substr(strtolower($username),0,7) || $match[2] == $username) {
if (substr(strtolower($match[1]),0,7) == substr(strtolower($this->_config['username']),0,7) || $match[2] == $this->_config['username']) {
return true;
} else {
// An unexpected user was logged in
@@ -248,17 +261,17 @@ public function logout() {
* (such as the TTL), or submitting batch edit requests (instead
* of handling them one at a time) could be added in the future.
*/
public function setRecord($hostname, $data, $type = 'A') {
list($host, $domain) = $this->_splitHostname($hostname);
public function setRecord($type = 'A') {
list($host, $domain) = $this->_splitHostname($this->_config['hostname']);
switch (strtoupper($type)) {
case 'A':
if (!($record = $this->_findRecord($host, $domain, $type))) {
// Host record not found
return false;
} elseif ($record['data'] != $data) {
} elseif ($record['data'] != $this->_config['myip']) {
// A record is out of date, build the query for updating it
$post = array(
'sInput' => '<PARAMS><PARAM name="type" value="arecord" /><PARAM name="fieldName" value="data" /><PARAM name="fieldValue" value="' . $data . '" /><PARAM name="lstIndex" value="' . $record['index'] . '" /></PARAMS>',
'sInput' => '<PARAMS><PARAM name="type" value="arecord" /><PARAM name="fieldName" value="data" /><PARAM name="fieldValue" value="' . $this->_config['myip'] . '" /><PARAM name="lstIndex" value="' . $record['index'] . '" /></PARAMS>',
);
$calloutResponse = $this->_fetchURL($this->_config['godaddy_dns_zonefile_ws_url'] . '/EditRecordField', http_build_query($post, '', '&'));
if (strpos($calloutResponse, 'SUCCESS') === false) {
@@ -278,7 +291,7 @@ public function setRecord($hostname, $data, $type = 'A') {
// The update succeeded or no changes were needed
return array(
'last_ip' => $record['data'],
'new_ip' => $data,
'new_ip' => $this->_config['myip'],
);
case 'CNAME':
case 'MX':
@@ -327,7 +340,7 @@ public function getPublicIp() {
/**
* Checks to see whether an IP address is private (non-routable) or public.
*/
public function isPrivateIp($ip) {
public static function isPrivateIp($ip) {
return (strpos($ip, '10.') === 0 ||
strpos($ip, '127.') === 0 ||
strpos($ip, '169.254.') === 0 ||
@@ -338,7 +351,7 @@ public function isPrivateIp($ip) {
/**
* Determine the host and domain name components given a hostname - could add some sanity testing.
*/
private function _splitHostname($hostname) {
private static function _splitHostname($hostname) {
$len = strlen($hostname);
$tldPos = strrpos($hostname, '.', 0);
$sldPos = strrpos($hostname, '.', ($tldPos-$len-1));
@@ -425,3 +438,28 @@ private function _getFieldAttribute($attribute, $fieldHtml) {
return false;
}
}

if(php_sapi_name() == "cli") {
if (count($argv) < 4) {
echo "Usage:\n ".$argv[0]." <username> <password> <hostname>\n";
exit(1);
}

$ddns = new GoDaddyDNS(array(
'username' => $argv[1],
'password' => $argv[2],
'hostname' => $argv[3],
'detect_external_ip' => true,));

if($ddns->updateRecord()) {
echo "Updated Record\n";
exit(0);
} else {
echo "Problem updating Record \"".$ddns->_lastError."\"\n";
exit(1);
}
} else {
GoDaddyDNS::ddns();
}

?>