kholisabdullah/Device-Pairing-Subsystem

SPDX-License-Identifier: BSD-4-Clause-Clear

Redistribution and use in source and binary forms, with or without modification, are permitted (subject to the limitations in the disclaimer below) provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
All advertising materials mentioning features or use of this software, or any deployment of this software, or documentation accompanying any distribution of this software, must display the trademark/logo as per the details provided here: https://www.qualcomm.com/documents/dirbs-logo-and-brand-guidelines
Neither the name of Qualcomm Technologies, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

SPDX-License-Identifier: ZLIB-ACKNOWLEDGEMENT

This software is provided 'as-is', without any express or implied warranty. In no event will the authors be held liable for any damages arising from the use of this software.

Permission is granted to anyone to use this software for any purpose, including commercial applications, and to alter it and redistribute it freely, subject to the following restrictions:

The origin of this software must not be misrepresented; you must not claim that you wrote the original software. If you use this software in a product, an acknowledgment is required by displaying the trademark/logo as per the details provided here: https://www.qualcomm.com/documents/dirbs-logo-and-brand-guidelines
Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software.
This notice may not be removed or altered from any source distribution.

NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

DPS-Device Pairing Subsystem

Device Pairing Subsystem is a part of the Device Identification, Registration and Blocking (DIRBS) System. The main purpose of DPS is to facilitate the pairing of users’ devices with their SIMs (IMSIs) over the SMS.

Documentation

DPS-API-Installation-Guide-1.0.0.pdf
DPS-SPA-Installation-Guide-1.0.0.pdf
DPS-User-Guide-Authority-1.0.0.pdf
DPS-User-Guide-MNO-1.0.0.pdf

Frontend Application Repo

https://github.com/dirbs/Device-Pairing-Subsystem-Frontend

Directory structure

This repository contains code for DPS part of the DIRBS. It contains

app/ -- The DPS core server app, to be used as DPS Web Server including database models, apis and resources
mock/ -- Sample data files etc which are used in app to be reside here
scripts/ -- Pair-Deletion script, pair-list generation script etc
tests/ -- Unit test scripts and Data
Documentation/ -- Installation guide for DPS

Prerequisites

In order to run a development environment, Python 3.0+ and Postgresql10 we assume that these are installed.

We also assume that this repo is cloned from Github onto the local computer, it is assumed that all commands mentioned in this guide are run from root directory of the project and inside virtual environment

On Windows, we assume that a Bash like shell is available (i.e Bash under Cygwin), with GNU make installed.

Starting a dev environment

The easiest and quickest way to get started is to use local-only environment (i.e everything runs locally, including Postgresql Server). To setup the local environment, follow the section below:

Setting up local dev environment

For setting up a local dev environment we assume that the prerequisites are met already. To setup a local environment:

Create database using Postgresql (Name and credentials should be same as in config)
Create virtual environment using virtualenv and activate it:

virtualenv venv
source venv/bin/activate

Make sure that virtual-env is made using Python3 and all the required dependencies are installed.

Run Database migrations using:

python manage.py db init
python manage.py db migrate
python manage.py db upgrade
python manage.py create_view

This will automatically create and migrate database schemas and requirements.

Start DPS development server using:

python run.py

This will start a flask development environment for DPS.

To run unit tests, run:

pytest -v -s

Other Helpful Commands

To Upgrade already installed database:

python manage.py db upgrade

To generate full pairing-list for DIRBS Core:

python scripts/pairlist_generation.py

To delete un-confirmed pairs to clean-up main DB:

python scripts/unconfirmed_pair_deletion.py

To run unit and regression tests:

pytest -v -s

kholisabdullah / Device-Pairing-Subsystem