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).
- 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 bindings for the C library for faster testing/integration.
LibOSDP exposes a minimal set of API to setup and manage the lifecycle of
OSDP devices. See include/osdp.h for more details.
To setup a device as a Control Panel in Python, you'd do something like this:
import osdp
## Setup OSDP device in Control Panel mode
cp = osdp.ControlPanel(pd_info, master_key=key)
## send a output command to PD-1
cp.send_command(1, output_cmd)Similarly, for Peripheral Device,
import osdp
## Setup OSDP device in Peripheral Device mode
pd = osdp.PeripheralDevice(pd_info, capabilities=pd_cap)
## Set a handler for incoming commands from CP
pd.set_command_callback(command_handler_fn)For more details, look at cp_app.py and pd_app.py.
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.
- cmake3 (host)
- python3 (host, optional)
- python3-pip (host, optional)
- doxygen (host, optional)
- OpenSSL (host and target, optional - recommended)
- goToMain/C-Utils (host, submodule)
sudo apt install cmake python3 python3-pip python3-dev libssl-dev doxygenpip3 install -r doc/requirements.txt
mkdir build && cd build
cmake ..
make html_docs # output in ./docs/sphinx/To build libosdp you must have cmake-3.0 (or above) and a C compiler installed.
This repository produces a libosdpstatic.a and libosdp.so. You can link
these with your application as needed (-losdp or -losdpstatic). 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
# optionally
make check
make DESTDIR=/your/install/path installRefer to this document for more information on build and cross compilation.
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.
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.