LibOSDP - Open Supervised Device Protocol Library

This is an open source implementation of IEC 60839-11-5 Open Supervised Device Protocol (OSDP). The protocol is intended to improve interoperability among access control and security products. It supports Secure Channel (SC) for encrypted and authenticated communication between configured devices.

OSDP describes the communication protocol for interfacing one or more Peripheral Devices (PD) to a Control Panel (CP) over a two-wire RS-485 multi-drop serial communication channel. Nevertheless, this protocol can be used to transfer secure data over any stream based physical channel. Read more about OSDP here.

This protocol is developed and maintained by Security Industry Association (SIA).

Salient Features of LibOSDP

Supports secure channel communication (AES-128)
Can be used to setup a PD or CP mode of operation
Exposes a well defined contract though a single header file
No run-time memory allocation. All memory is allocated at init-time
No external dependencies (for ease of cross compilation)
Fully non-blocking, asynchronous design
Provides Python3 and Rust bindings for the C library for faster testing/integration

Language Support

C API

LibOSDP is written in C. It exposes a minimal set of API to setup and manage the lifecycle of OSDP devices. See include/osdp.h for more details.

Rust API

LibOSDP is now available via crates.io/crates/libosdp. See rust/README.md for more info and usage examples.

Python API

There are currently two python implementation within this repo:

A basic wrapper around LibOSDP.
A more idiomatic python module that builds on top of the basic wrapper.

Although both implementations are considered fairly mature, neither have been submitted to pypi.org due to lack of time (PRs in this direction are appreciated). The plan at this time is to merge both of these implementation into python/.

Supported Commands and Replies

OSDP has certain command and reply IDs pre-registered. This implementation of the protocol support only the most common among them. You can see a list of commands and replies and their support status in LibOSDP here.

Dependencies

goToMain/C-Utils (host, submodule)
cmake3 (host)
python3 (host, optional)
python3-pip (host, optional)
doxygen (host, optional; for building the html docs as seen here)
OpenSSL (host and target, optional - recommended)
MbedTLS (host and target, optional)
pytest (host, optional; for running the integrated test suite)

For ubuntu

sudo apt install cmake python3 python3-pip python3-dev libssl-dev doxygen

Compile LibOSDP

LibOSDP provides a lean-build that only builds the core library and nothing else. This is useful if you are cross compiling as it doesn't have any other dependencies but a C compiler. Here is an example of how you can cross compile LibOSDP to arm-none-eabi-gcc.

export CROSS_COMPILE=arm-none-eabi-
export CCFLAGS=--specs=nosys.specs
./configure.sh
make

To build libosdp and all its components you must have cmake-3.0 (or above) and a C compiler installed. This repository produces a libosdp.so and libosdpstatic.a; so depending on on your needs you can link these with -losdp or -losdpstatic, respectively.

Have a look at `sample/* for a quick lookup on how to consume this library and structure your application.

You can also read the API documentation for a comprehensive list of APIs that are exposed by libosdp.

git clone https://github.com/goToMain/libosdp --recurse-submodules
# git submodule update --init (if you missed doing --recurse-submodules earlier)
cd libosdp
mkdir build && cd build
cmake ..
make

Refer to this document for more information on build and cross compilation.

Run the test suite

LibOSDP uses the pytest python framework to test changes made to ensure we aren't breaking existing functionalities while adding newer ones. You can install pytest in your development machine with,

python3 -m pip install pytest

Running the tests locally before creating a pull request is recommended to make sure that your changes aren't breaking any of the existing functionalities. Here is how you can run them:

mkdir build && cd build
cmake ..
make python_install
make check

To add new tests for the feature you are working one, see the other tests in pytest directory.

Build HTML docs

This sections is for those who want to build the HTML documentation for this project locally. The latest version of the doc can always be found at libosdp.sidcha.dev.

Install the dependencies (one time) with,

pip3 install -r doc/requirements.txt

Build the docs by doing the following:

mkdir build && cd build
cmake ..
make html_docs # output in ./docs/sphinx/

Contributions, Issues and Bugs

The Github issue tracker doubles up as TODO list for this project. Have a look at the open items, PRs in those directions are welcome.

If you have a idea, find bugs, or other issues, please open a new issue in the github page of this project https://github.com/goTomain/libosdp.

You can read more on this here.

License

This software is distributed under the terms of Apache-2.0 license. If you don't know what that means/implies, you can consider it is as "free as in beer".

OSDP protocol is also open for consumption into any product. There is no need to,

obtain permission from SIA
pay royalty to SIA
become SIA member

The OSDP specification can be obtained from SIA for a cost. Read more at our FAQ page.

Sympatron/libosdp