2
0
mirror of https://github.com/fhem/fhem-mirror.git synced 2025-04-21 14:04:15 +00:00

98_gcmsend: Add AES encryption

git-svn-id: https://svn.fhem.de/fhem/trunk@12117 2b470e98-0d58-463d-a4d8-8e2adae1ed80
This commit is contained in:
klassm 2016-09-04 15:24:20 +00:00
parent 926b14a9c8
commit 07aabba9d1

View File

@ -1,281 +1,331 @@
package main; package main;
use strict;
use warnings;
use HTTP::Request; use HTTP::Request;
use LWP::UserAgent; use LWP::UserAgent;
use IO::Socket::SSL; use IO::Socket::SSL;
use utf8; use utf8;
use Crypt::CBC;
use Crypt::Cipher::AES;
my @gets = ('dummy'); sub gcmsend_Initialize($)
sub
gcmsend_Initialize($)
{ {
my ($hash) = @_; my ($hash) = @_;
$hash->{DefFn} = "gcmsend_Define"; $hash->{DefFn} = "gcmsend_Define";
$hash->{NotifyFn} = "gcmsend_notify"; $hash->{NotifyFn} = "gcmsend_notify";
$hash->{SetFn} = "gcmsend_set"; $hash->{AttrFn} = "gcmsend_attr";
$hash->{AttrList} = "loglevel:0,1,2,3,4,5 regIds apiKey stateFilter vibrate deviceFilter playSound"; $hash->{SetFn} = "gcmsend_set";
$hash->{AttrList} = "loglevel:0,1,2,3,4,5 regIds apiKey stateFilter vibrate deviceFilter cryptKey";
} }
sub sub gcmsend_attr {
gcmsend_set { my ($cmd, $name, $aName, $aVal) = @_;
my ($hash, @a) = @_; if (not $aName eq "cryptKey") {
my $v = @a[1]; return undef;
if ($v eq "delete_saved_states") {
$hash->{STATES} = {};
return "deleted";
} elsif($v eq "send") {
my $msg = "";
for (my $i = 2; $i < int(@a); $i++) {
if (! ($msg eq "")) {
$msg .= " ";
}
$msg .= @a[$i];
} }
return gcmsend_sendMessage($hash, $msg); $aVal = sprintf("%016s", $aVal);
} else { $aVal = substr $aVal, length($aVal) - 16, 16;
return "unknown set value, choose one of delete_saved_states send"; $_[3] = $aVal;
} return undef;
} }
sub sub gcmsend_set {
gcmsend_Define($$) my ($hash, @a) = @_;
my $v = @a[1];
if ($v eq "delete_saved_states") {
$hash->{STATES} = { };
return "deleted";
} elsif ($v eq "send") {
my $msg = "";
for (my $i = 2; $i < int(@a); $i++) {
if (!($msg eq "")) {
$msg .= " ";
}
$msg .= @a[$i];
}
return gcmsend_sendMessage($hash, $msg);
} else {
return "unknown set value, choose one of delete_saved_states send";
}
}
sub gcmsend_Define($$)
{ {
my ($hash, $def) = @_; my ($hash, $def) = @_;
my @args = split("[ \t]+", $def); my @args = split("[ \t]+", $def);
if (int(@args) < 1) if (int(@args) < 1)
{ {
return "gcmsend_Define: too many arguments. Usage:\n" . return "gcmsend_Define: too many arguments. Usage:\n".
"define <name> gcmsend"; "define <name> gcmsend";
} }
return "Invalid arguments. Usage: \n define <name> gcmsend" if(int(@a) != 0); return "Invalid arguments. Usage: \n define <name> gcmsend" if (int(@args) != 2);
$hash->{STATE} = 'Initialized'; $hash->{STATE} = 'Initialized';
return undef; return undef;
} }
sub gcmsend_array_to_json(@) { sub gcmsend_array_to_json(@) {
my (@array) = @_; my (@array) = @_;
my $ret = ""; my $ret = "";
for (my $i = 0; $i < int(@array); $i++) { for (my $i = 0; $i < int(@array); $i++) {
if ($i != 0) { if ($i != 0) {
$ret .= ","; $ret .= ",";
}
my $value = @array[$i];
$ret .= ("\"".$value."\"");
} }
my $value = @array[$i];
$ret .= ("\"" . $value . "\"");
}
return "[" . $ret . "]"; return "[".$ret."]";
} }
sub gcmsend_sendPayload($$) { sub gcmsend_sendPayload($%) {
my ($hash, $payload) = @_; my ($hash, %payload) = @_;
my %generalPayload = gcmsend_getGeneralPayload($hash);
my %toSendPayload = (%generalPayload, %payload);
my %encryptedPayload = gcmsend_encrypt($hash, %toSendPayload);
my $name = $hash->{NAME}; my $jsonPayload = gcmsend_toJson(%encryptedPayload);
my $logLevel = GetLogLevel($name,5); my $name = $hash->{NAME};
my $client = LWP::UserAgent->new(); my $logLevel = GetLogLevel($name, 5);
my $regIdsText = AttrVal($name, "regIds", "");
my $apikey = AttrVal($name, "apiKey", ""); my $client = LWP::UserAgent->new();
my @registrationIds = split(/\|/, $regIdsText); my $regIdsText = AttrVal($name, "regIds", "");
if (int(@registrationIds) == 0) { my $apikey = AttrVal($name, "apiKey", "");
Log $logLevel, "$name no registrationIds set."; my @registrationIds = split(/\|/, $regIdsText);
if (int(@registrationIds) == 0) {
Log $logLevel, "$name no registrationIds set.";
return undef;
}
return undef if (int(@registrationIds) == 0);
my $data =
"{".
"\"registration_ids\":".gcmsend_array_to_json(@registrationIds).",".
"\"data\": $jsonPayload".
"}";
Log $logLevel, "data is $jsonPayload";
my $req = HTTP::Request->new( POST => "https://android.googleapis.com/gcm/send" );
$req->header( Authorization => 'key='.$apikey );
$req->header( 'Content-Type' => 'application/json; charset=UTF-8' );
$req->content( $data );
my $response = $client->request( $req );
if (!$response->is_success) {
Log $logLevel, "error during request: ".$response->status_line;
$hash->{STATE} = $response->status_line;
}
$hash->{STATE} = "OK";
return undef; return undef;
}
return undef if (int(@registrationIds) == 0);
my $unixTtimestamp = time*1000;
my $data =
"{" .
"\"registration_ids\":" . gcmsend_array_to_json(@registrationIds) . "," .
"\"data\": $payload".
"}";
Log $logLevel, "data is $payload";
my $req = HTTP::Request->new(POST => "https://android.googleapis.com/gcm/send");
$req->header(Authorization => 'key='.$apikey);
$req->header('Content-Type' => 'application/json; charset=UTF-8');
$req->content($data);
my $response = $client->request($req);
if (! $response->is_success) {
Log $logLevel, "error during request: " . $response->status_line;
$hash->{STATE} = $response->status_line;
}
$hash->{STATE} = "OK";
return undef;
} }
sub gcmsend_fillGeneralPayload($$) { sub gcmsend_getGeneralPayload($) {
my ($hash, $payloadString) = @_; my ($hash) = @_;
my $name = $hash->{NAME}; my $name = $hash->{NAME};
my $vibrate = "false"; my $vibrate = "false";
if (AttrVal($name, "vibrate", "false") eq "true") { if (AttrVal($name, "vibrate", "false") eq "true") {
$vibrate = "true"; $vibrate = "true";
} }
my $playSound = "false";
if (AttrVal($name, "playSound", "false") eq "true") {
$playSound = "true";
}
return $payloadString . "," . my $gcmName = $hash->{NAME};
"\"source\":\"gcmsend_fhem\"," .
"\"vibrate\":\"$vibrate\"," . my %generalPayload = (
"\"playSound\":\"$playSound\""; "source" => "gcmsend_fhem",
"gcmDeviceName" => $gcmName,
"vibrate" => "$vibrate"
);
return %generalPayload;
} }
sub gcmsend_sendNotify($$$) { sub gcmsend_sendNotify($$$) {
my ($hash, $deviceName, $changes) = @_; my ($hash, $deviceName, $changes) = @_;
my %payload = (
"deviceName" => $deviceName,
"changes" => $changes,
"type" => "notify"
);
gcmsend_sendPayload($hash, %payload);
}
my $payload = sub gcmsend_toJson(%) {
"\"deviceName\": \"$deviceName\"," . my (%hash) = @_;
"\"changes\":\"$changes\"," . my @entries = ();
"\"type\":\"notify\"";
$payload = "{" . gcmsend_fillGeneralPayload($hash, $payload) . "}"; while (my ($key, $value) = each %hash) {
my $entry = "\"$key\":\"$value\"";
push @entries, $entry;
}
return "{".join(", ", @entries)."}";
}
gcmsend_sendPayload($hash, $payload); my %gcmsend_encrypt_keys = ("type" => "", "notifyId" => "", "changes" => "", "deviceName" => "",
"tickerText" => "", "contentText" => "", "contentTitle" => "");
sub gcmsend_encrypt($%) {
my ($hash, %payload) = @_;
my $key = AttrVal($hash->{NAME}, "cryptKey", "");
if ($key eq "") {
return %payload;
}
my $cipher = Crypt::CBC->new(
-cipher => 'Crypt::Cipher::AES',
-key => $key,
-iv => $key,
-padding => 'standard',
-header => 'none',
-blocksize => '16',
-literal_key => 1,
-keysize => 16
);
my %newPayload = ();
while (my ($key, $value) = each %payload) {
if (exists(%gcmsend_encrypt_keys->{$key})) {
my $padded = sprintf '%16s', $value;
my $length = length($padded);
%newPayload->{$key} = $cipher->encrypt_hex( $value );
} else {
%newPayload->{$key} = $value;
}
}
return %newPayload;
} }
sub gcmsend_sendMessage($$) { sub gcmsend_sendMessage($$) {
my ($hash, $message) = @_; my ($hash, $message) = @_;
my @parts = split(/\|/, $message); my @parts = split(/\|/, $message);
my $tickerText; my $tickerText;
my $contentTitle; my $contentTitle;
my $contentText; my $contentText;
my $notifyId = 1; my $notifyId = 1;
my $length = int(@parts); my $length = int(@parts);
if ($length == 3 || $length == 4) { if ($length == 3 || $length == 4) {
$tickerText = @parts[0]; $tickerText = @parts[0];
$contentTitle = @parts[1]; $contentTitle = @parts[1];
$contentText = @parts[2]; $contentText = @parts[2];
if ($length == 4) { if ($length == 4) {
my $notifyIdText = @parts[3]; my $notifyIdText = @parts[3];
if (!(@parts[3] =~ m/[1-9][0-9]*/)) { if (!(@parts[3] =~ m/[1-9][0-9]*/)) {
return "notifyId must be numeric and positive"; return "notifyId must be numeric and positive";
} }
$notifyId = @parts[3]; $notifyId = @parts[3];
}
} else {
return "Illegal message format. Required format is \r\n ".
"tickerText|contentTitle|contentText[|NotifyID]";
} }
} else { my %payload = (
return "Illegal message format. Required format is \r\n " . "tickerText" => $tickerText,
"tickerText|contentTitle|contentText[|NotifyID]"; "contentTitle" => $contentTitle,
} "contentText" => $contentText,
"notifyId" => $notifyId,
"type" => "message"
);
gcmsend_sendPayload($hash, %payload);
my $payload = return undef;
"\"tickerText\":\"$tickerText\"," .
"\"contentTitle\":\"$contentTitle\"," .
"\"contentText\":\"$contentText\"," .
"\"notifyId\":\"$notifyId\"," .
"\"source\":\"gcmsend_fhem\"," .
"\"type\":\"message\""
;
$payload = "{" . gcmsend_fillGeneralPayload($hash, $payload) . "}";
gcmsend_sendPayload($hash, $payload);
return undef;
} }
sub gcmsend_getLastDeviceStatesFor($$) sub gcmsend_getLastDeviceStatesFor($$)
{ {
my ($gcm, $deviceName) = @_; my ($gcm, $deviceName) = @_;
if (! $gcm->{STATES}) { if (!$gcm->{STATES}) {
$gcm->{STATES} = {}; $gcm->{STATES} = { };
} }
my $states = $gcm->{STATES}; my $states = $gcm->{STATES};
if (!$states->{$deviceName}) { if (!$states->{$deviceName}) {
$states->{$deviceName} = {}; $states->{$deviceName} = { };
} }
return $states->{$deviceName}; return $states->{$deviceName};
} }
sub gcmsend_notify($$) sub gcmsend_notify($$)
{ {
my ($gcm, $dev) = @_; my ($gcm, $dev) = @_;
my $logLevel = GetLogLevel($gcm,5); my $logLevel = GetLogLevel($gcm, 5);
my $name = $dev->{NAME}; my $name = $dev->{NAME};
my $gcmName = $gcm->{NAME}; my $gcmName = $gcm->{NAME};
my $deviceFilter = AttrVal($gcm->{NAME}, "deviceFilter", ""); my $deviceFilter = AttrVal($gcm->{NAME}, "deviceFilter", "");
return if $name eq $gcmName; return if $name eq $gcmName;
return if(!$dev->{CHANGED}); # Some previous notify deleted the array. return if (!$dev->{CHANGED}); # Some previous notify deleted the array.
return if (! ($deviceFilter eq "") && !($name =~ m/$deviceFilter/)); return if (!($deviceFilter eq "") && !($name =~ m/$deviceFilter/));
my $stateFilter = AttrVal($gcm->{NAME}, "stateFilter", ""); my $stateFilter = AttrVal($gcm->{NAME}, "stateFilter", "");
my $lastDeviceStates = gcmsend_getLastDeviceStatesFor($gcm, $name); my $lastDeviceStates = gcmsend_getLastDeviceStatesFor($gcm, $name);
my $val = ""; my $val = "";
my $nrOfFieldChanges = int(@{$dev->{CHANGED}}); my $nrOfFieldChanges = int(@{$dev->{CHANGED}});
my $sendFieldCount = 0; my $sendFieldCount = 0;
for (my $i = 0; $i < $nrOfFieldChanges; $i++) { for (my $i = 0; $i < $nrOfFieldChanges; $i++) {
my @keyValue = split(":", $dev->{CHANGED}[$i]); my @keyValue = split(":", $dev->{CHANGED}[$i]);
my $length = int($keyValue); my $change = $dev->{CHANGED}[$i];
my $change = $dev->{CHANGED}[$i];
# We need to find out a key and a value for each field update. # We need to find out a key and a value for each field update.
# For state updates, we have not field, which is why we simply # For state updates, we have not field, which is why we simply
# put it to "state". # put it to "state".
# For all other updates the notify value is delimited by ":", # For all other updates the notify value is delimited by ":",
# which we use to find out the value and the key. # which we use to find out the value and the key.
my $key; my $key;
my $value; my $value;
my $position = index($change, ':'); my $position = index($change, ':');
if ($position == -1) { if ($position == -1) {
$key = "state"; $key = "state";
$value = $keyValue[0]; $value = $keyValue[0];
} else { } else {
$key = substr($change, 0, $position); $key = substr($change, 0, $position);
$value = substr($change, $position + 2, length($change)); $value = substr($change, $position + 2, length($change));
}
if (!($stateFilter eq "") && !($value =~ m/$stateFilter/)) {
Log $logLevel,
"$gcmName $name: ignoring $key, as value $value is blocked by stateFilter regexp.";
} elsif ($value eq "") {
Log $logLevel, "$gcmName $name: ignoring $key, as value is empty.";
} elsif ($lastDeviceStates->{$key} && $lastDeviceStates->{$key} eq $value) {
my $savedValue = $lastDeviceStates->{$key};
Log $logLevel,
"$gcmName $name: ignoring $key, save value is $savedValue, value is $value";
} else {
$lastDeviceStates->{$key} = $value;
# Multiple field updates are separated by <|>.
if ($sendFieldCount != 0) {
$val .= "<|>";
}
$sendFieldCount += 1;
$val .= "$key:$value";
}
} }
if ($sendFieldCount > 0) {
if (! ($stateFilter eq "") && ! ($value =~ m/$stateFilter/)) { gcmsend_sendNotify($gcm, $name, $val);
Log $logLevel, "$gcmName $name: ignoring $key, as value $value is blocked by stateFilter regexp.";
} elsif ($value eq "") {
Log $logLevel, "$gcmName $name: ignoring $key, as value is empty.";
} elsif ($lastDeviceStates->{$key} && $lastDeviceStates->{$key} eq $value) {
my $savedValue = $lastDeviceStates->{$key};
Log $logLevel, "$gcmName $name: ignoring $key, save value is $savedValue, value is $value";
} else {
$lastDeviceStates->{$key} = $value;
# Multiple field updates are separated by <|>.
if ($sendFieldCount != 0) {
$val .= "<|>";
}
$sendFieldCount += 1;
$val .= "$key:$value";
} }
}
if ($sendFieldCount > 0) {
gcmsend_sendNotify($gcm, $name, $val);
}
} }
1; 1;
@ -314,7 +364,8 @@ sub gcmsend_notify($$)
Notes: Notes:
<ul> <ul>
<li>Module to send messages to GCM (Google Cloud Messaging).</li> <li>Module to send messages to GCM (Google Cloud Messaging).</li>
<li>Prerequisite is a GCM AcsendFieldCount with Google (see <a href="https://code.google.com/apis/console/">Google API Console</a></li> <li>Prerequisite is a GCM Account (see <a href="https://code.google.com/apis/console/">Google API Console</a></li>
<li>Futhermore <code>Crypt::CBC</code> and <code>Crypt::Cipher::AES</code> Perl modules have to be installed
</ul> </ul>
</ul> </ul>
@ -349,8 +400,7 @@ sub gcmsend_notify($$)
<br />Make the receiving device vibrate upon receiving the message. Must be true or false.</li> <br />Make the receiving device vibrate upon receiving the message. Must be true or false.</li>
<li><a name="gcmsend_deviceFilter"><code>attr &lt;name&gt; deviceFilter &lt;regexp&gt;</a> <li><a name="gcmsend_deviceFilter"><code>attr &lt;name&gt; deviceFilter &lt;regexp&gt;</a>
<br />Send a GCM notify only is the device name matches the given filter regexp.</li> <br />Send a GCM notify only is the device name matches the given filter regexp.</li>
<li><a name="gcmsend_playSound"><code attr &lt;name&gt; playSound &lt;true|false&gt;</a> <li><a name="gcmsend_cryptKey"><code>attr &lt;name&gt; cryptKey &lt;key&gt;</a> <br/>Some key to encrypt message content. The key must have a size of 16 bytes. If the key length does not match it will be either cut or padded to the required length. As encryption algorithm AES is used.</li>
<br />Specifies that the implementation of GCM should play a sound when an event is received. Note that andFHEM does not implement this attribute yet.</li>
</ul> </ul>
</ul> </ul>