mighty82 / libosdp Goto Github PK

This is an open source implementation of Open Supervised Device Protocol (OSDP) developed by Security Industry Association (SIA). The protocol is intended to improve interoperability among access control and security products. OSDP is currently in-process to become a standard recognized by the American National Standards Institute (ANSI).

OSDP describes the communication protocol for interfacing one or more Peripheral Devices (PD) to a Control Panel (CP). The OSDP specification describes the protocol implementation over a two-wire RS-485 multi-drop serial communication channel. Nevertheless, this protocol can be used to transfer secure data over any physical channel. Have a look at our protocol design documents to get a better idea.

• Supports secure channel communication (AES-128).
• Can be used to setup a PD or CP mode of operation.
• Exposes a well defined contract though include/osdp.h.
• No run-time memory allocation. All memory is allocated at init-time.
• Well designed source code architecure.

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)

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 details on how to consume this library.

mkdir build && cd build
cmake ..
make
make check
make DESTDIR=/your/install/path install

LibOSDP can can be configured to enable/disable certain featured by passing the -DCONFIG_XXX=ON/OFF flag to cmake. Following table lists all such config switches. For instance, if you want to also build static library, you can pass the flag -DCONFIG_OSDP_BUILD_STATIC=ON to cmake.

If you are familiar with cmake, then adding LibOSDP to your project is super simple. First off, add the following to your CMakeLists.txt

include(ExternalProject)
ExternalProject_Add(ext_libosdp
	GIT_REPOSITORY    https://github.com/cbsiddharth/libosdp.git
	GIT_TAG           master
	SOURCE_DIR        ${CMAKE_BINARY_DIR}/libosdp/src
	BINARY_DIR        ${CMAKE_BINARY_DIR}/libosdp/build
	CONFIGURE_COMMAND cmake ${CMAKE_BINARY_DIR}/libosdp/src
	BUILD_COMMAND     make
	INSTALL_COMMAND   make install DESTDIR=${CMAKE_BINARY_DIR}/libosdp/install
)
include_directories("${CMAKE_BINARY_DIR}/libosdp/install/include")
link_directories("${CMAKE_BINARY_DIR}/libosdp/install/lib")

Next you must add ext_libosdp as a dependency to your target. That it! now you can link your application to osdp library. Following example shows how you can do this.

set(OSDP_APP osdp-app)
list(APPEND OSDP_APP_SRC
    "src/main.c"
    "src/more_source_files.c"
    ...
)
add_executable(${OSDP_APP} ${OSDP_APP_SRC})
add_dependencies(${OSDP_APP} ext_libosdp)
target_link_libraries(${OSDP_APP} osdp)

LibOSDP can be compiled with your cross compiler by passing a toolchain file to cmake. This can be done by invoking cmake with the command line argument -DCMAKE_TOOLCHAIN_FILE=/path/to/toolchain-file.cmake.

If your toolchain is installed in /opt/toolchain/armv8l-linux-gnueabihf/ and the sysroot is present in /opt/toolchain/armv8l-linux-gnueabihf/sysroot, the toolchain-file.cmake file should look like this:

set(CMAKE_SYSTEM_NAME Linux)
set(CMAKE_SYSTEM_PROCESSOR arm)

# specify the cross compiler and sysroot
set(TOOLCHAIN_INST_PATH /opt/toolchain/armv8l-linux-gnueabihf)
set(CMAKE_C_COMPILER    ${TOOLCHAIN_INST_PATH}/bin/armv8l-linux-gnueabihf-gcc)
set(CMAKE_CXX_COMPILER  ${TOOLCHAIN_INST_PATH}/bin/armv8l-linux-gnueabihf-g++)
set(CMAKE_SYSROOT       ${TOOLCHAIN_INST_PATH}/sysroot)

# don't search for programs in the build host directories
set(CMAKE_FIND_ROOT_PATH_MODE_PROGRAM NEVER)

# search for libraries and headers in the target directories only
set(CMAKE_FIND_ROOT_PATH_MODE_LIBRARY ONLY)
set(CMAKE_FIND_ROOT_PATH_MODE_INCLUDE ONLY)
set(CMAKE_FIND_ROOT_PATH_MODE_PACKAGE ONLY)

For convenience, the toolchain-file.cmake file can be placed in a common path (probably where the toolchain is installed) and referenced from our build directory.

mkdir build && cd build
cmake -DCMAKE_TOOLCHAIN_FILE=/opt/toolchain/armv8l-linux-gnueabihf/toolchain-file.cmake ..
make

This repository is a work in progress; read the TODO file for list of pending tasks. Patches in those areas are welcome; open an issue in the github page of this project (https://github.com/cbsiddharth/libosdp) if you face any issues.