The tcmaker-keyfobs from tcmaker

Update Keyfobs plugin to work with future door controller

The following SQS Schema is proposed for new messages.

See https://github.com/tcmaker/access_control/blob/master/doc/tcdoor-spec.md for the larger picture.

Add Credential

{
    "action" : "activate",
    "code" : "codenumber",                           //string, not integer
    "facility" : "frontdoor",
    "codetype" : "fob",                              //"fob" or "passcode"
    "member": "3870",                                //string or int
    "priority":  3,                                  //integer
    "tag":  "d2f3ce26-12ab-4b2a-8943-d49e4a7b1420",
    "effective" : "ISO8601 UTC Time",
    "expiration" : "ISO8601 UTC Time"             
}

Note: @rrotter requests we enforce a maximum duration of a credential, rejecting all credentials where the expiration is later than e.g. a week after the effective date, as a fail-safe, thus requiring a user be occasionally re-activated by the membership systems, each reactivation overlapping with the previous. I have no opposition to such a requirement.

Revoke Credential

{
    "action": "revoke",
    "facility" : "facilityname",
    "tag" : "f2151449-113e-4e2c-8c7d-fcecafd8b9d8"
}

Modify Credential

Change all of a memberid's credentials, to replace a keyfob, for example

{
    "action": "modify",
    "facility" : "name",    
    "member" : "memberId", 
    "oldtype": "fob",          //"fob" or "passcode"
    "oldcode": "numbers",    
    "newtype" : "fob",         //"fob" or "passcode"
    "newcode" : "newnumbers"    
}

Set Requirement

{
    "action": "set-requirement",
    "requiredpriority" : 1,                          //integer
    "facility" : "frontdoor",
    "tag" : "556aba4d-4d5f-4779-a914-d80e73b2696b",
    "description" : "desc",                         //optional, for convenience
    "timespec" : "SEE BELOW"
}

For timespec, one of the following values SHALL be used:

always
A full iCalendar definition. The system will parse the icalendar event information for repeating
events, e.g. open house. Hopefully this will make integration with clubhouse or admin panels for classes or whatnot straight-forward.

Revoke Requirement

{
    "action": "revoke-requirement",
    "facility" : "facilityname",
    "tag" : "192f0827-3a9c-41f1-a7e1-5446340a744a"
}

In CRM/Keyfobs/BAO/Keyfob.php lives the current activate and deactivate functions:

A short-term workaround may work to eliminate the deactivation functionality, and update the activate to compute a fob expiration time, and send using that. The door controller will not mind duplicate credentials.

tcmaker-keyfobs/CRM/Keyfobs/BAO/Keyfob.php

Lines 83 to 123 in a9396a1

 public function deactivate() { 

 // You can't deactivate a code that doesn't exist 

 if (! $this->code) { 

 return; 

 } 

 $message = array( 

 'action' => 'deactivate', 

 'code' => $this->code, 

 'member' => (int)$this->contact_id, 

 'access_level' => 0, 

 ); 

 $this->getSqsClient()->sendMessage(array( 

 'QueueUrl' => Civi::settings()->get('keyfobs_aws_sqs_queue_url'), 

 'MessageBody' => json_encode($message), 

 'MessageGroupId' => 'DoorMessages', 

 'MessageDeduplicationId' => uniqid($more_entropy=true), 

 )); 

 } 

 public function activate() { 

 // Don't activate unless a code is present. 

 if (! $this->code) { 

 return; 

 } 

 $message = array( 

 'action' => 'activate', 

 'code' => $this->code, 

 'member' => (int)$this->contact_id, 

 'access_level' => (int)$this->access_level, 

 ); 

 $this->getSqsClient()->sendMessage(array( 

 'QueueUrl' => Civi::settings()->get('keyfobs_aws_sqs_queue_url'), 

 'MessageBody' => json_encode($message), 

 'MessageGroupId' => 'DoorMessages', 

 'MessageDeduplicationId' => uniqid($more_entropy=true), 

 )); 

 }

tcmaker / tcmaker-keyfobs Goto Github PK

tcmaker-keyfobs's People

Contributors

Stargazers

Watchers

tcmaker-keyfobs's Issues

Update Keyfobs plugin to work with future door controller

Add Credential

Revoke Credential

Modify Credential

Set Requirement

Revoke Requirement

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent

	public function deactivate() {
	// You can't deactivate a code that doesn't exist
	if (! $this->code) {
	return;
	}

	$message = array(
	'action' => 'deactivate',
	'code' => $this->code,
	'member' => (int)$this->contact_id,
	'access_level' => 0,
	);

	$this->getSqsClient()->sendMessage(array(
	'QueueUrl' => Civi::settings()->get('keyfobs_aws_sqs_queue_url'),
	'MessageBody' => json_encode($message),
	'MessageGroupId' => 'DoorMessages',
	'MessageDeduplicationId' => uniqid($more_entropy=true),
	));
	}

	public function activate() {
	// Don't activate unless a code is present.
	if (! $this->code) {
	return;
	}

	$message = array(
	'action' => 'activate',
	'code' => $this->code,
	'member' => (int)$this->contact_id,
	'access_level' => (int)$this->access_level,
	);

	$this->getSqsClient()->sendMessage(array(
	'QueueUrl' => Civi::settings()->get('keyfobs_aws_sqs_queue_url'),
	'MessageBody' => json_encode($message),
	'MessageGroupId' => 'DoorMessages',
	'MessageDeduplicationId' => uniqid($more_entropy=true),
	));
	}