Server API Tutorial
Run the example
- Install and run the gateway
- Download the Python client library
- Copy the root certificate of the gateway to your working directory. As default, the certificate(ca.crt) resides in cert of the installation directory.
-
Change the server and the device information in example/server/test/test.py as needed.
# the path of the root certificate GATEWAY_CA_FILE = '../../../../cert/gateway/ca.crt' # the ip address of the gateway GATEWAY_IP = '192.168.0.2' GATEWAY_PORT = 4000 # the ip address of the target device DEVICE_IP = '192.168.0.110' DEVICE_PORT = 51211 USE_SSL = False
-
Run.
cd example/server/test python test.py
1. Connect to the gateway and the device
The example assumes you use the device gateway. For the master gateway or other connection options, refer to the Connect or ConnectMaster examples.
client = GatewayClient(GATEWAY_IP, GATEWAY_PORT, GATEWAY_CA_FILE)
channel = client.getChannel()
connectSvc = ConnectSvc(channel)
connInfo = connect_pb2.ConnectInfo(IPAddr=DEVICE_IP, port=DEVICE_PORT, useSSL=USE_SSL)
devID = connectSvc.connect(connInfo)
2. Subscribe
To receive requests from devices, you have to configure the related options as described, first.
testConfig = auth_pb2.AuthConfig()
testConfig.CopyFrom(origAuthConfig)
testConfig.useServerMatching = True
self.authSvc.setConfig(deviceID, testConfig)
Then, you have to subscribe to the request channel.
self.reqCh = self.serverSvc.subscribe(QUEUE_SIZE)
3. Handle verification requests
With server matching enabled, the device will send a verification request to the gateway when it reads a card. You can implement your own logic and return its result to the device using HandleVerify.
def handleVerify(self):
try:
for req in self.reqCh:
if self.returnError: # emulate authentication failure
self.serverSvc.handleVerify(req, server_pb2.VERIFY_FAIL, None)
else: # emulate authentication success
userHdr = user_pb2.UserHdr(ID=TEST_USER_ID, numOfCard=1)
cardData = card_pb2.CSNCardData(data=req.verifyReq.cardData)
userInfo = user_pb2.UserInfo(hdr=userHdr, cards=[cardData])
self.serverSvc.handleVerify(req, server_pb2.SUCCESS, userInfo)
verifyThread = threading.Thread(target=self.handleVerify)
verifyThread.start()
4. Handle identification requests
With server matching enabled, the device will send an identification request to the gateway when it reads a fingerprint. You can implement your own logic and return its result to the device using HandleIdentify.
def handleIdentify(self):
try:
for req in self.reqCh:
if self.returnError: # emulate authentication failure
self.serverSvc.handleIdentify(req, server_pb2.IDENTIFY_FAIL, None)
else: # emulate authentication success
userHdr = user_pb2.UserHdr(ID=TEST_USER_ID, numOfFinger=1)
fingerData = finger_pb2.FingerData(templates=[req.identifyReq.templateData, req.identifyReq.templateData,])
userInfo = user_pb2.UserInfo(hdr=userHdr, fingers=[fingerData])
self.serverSvc.handleIdentify(req, server_pb2.SUCCESS, userInfo)
identifyThread = threading.Thread(target=self.handleIdentify)
identifyThread.start()