# libyang **Repository Path**: netconf/libyang ## Basic Information - **Project Name**: libyang - **Description**: No description available - **Primary Language**: C - **License**: BSD-3-Clause - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2021-05-28 - **Last Updated**: 2021-05-28 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # libyang [![BSD license](https://img.shields.io/badge/License-BSD-blue.svg)](https://opensource.org/licenses/BSD-3-Clause) [![Build](https://github.com/CESNET/libyang/workflows/libyang%20CI/badge.svg)](https://github.com/CESNET/libyang/actions?query=workflow%3A%22libyang+CI%22) [![Docs](https://img.shields.io/badge/docs-link-blue)](https://netopeer.liberouter.org/doc/libyang/) [![codecov.io](https://codecov.io/github/CESNET/libyang/coverage.svg?branch=master)](https://codecov.io/github/CESNET/libyang?branch=master) [![Coverity Scan Build Status](https://scan.coverity.com/projects/5259/badge.svg)](https://scan.coverity.com/projects/5259) [![Ohloh Project Status](https://www.openhub.net/p/libyang/widgets/project_thin_badge.gif)](https://www.openhub.net/p/libyang) libyang is a YANG data modelling language parser and toolkit written (and providing API) in C. The library is used e.g. in [libnetconf2](https://github.com/CESNET/libnetconf2), [Netopeer2](https://github.com/CESNET/Netopeer2) or [sysrepo](https://github.com/sysrepo/sysrepo) projects. If you are interested in future plans announcements, please subscribe to the [Future Plans issue](https://github.com/CESNET/libyang/issues/880). ## Migration from libyang version 1 or older Look into the documentation and the section `Transition Manual`. That should help with basic migration and the ability to compile a project. But to actually make use of the new features, it is required to read through the whole documentation and the API. ## Provided Features * Parsing (and validating) schemas in YANG format. * Parsing (and validating) schemas in YIN format. * Parsing, validating and printing instance data in XML format. * Parsing, validating and printing instance data in JSON format ([RFC 7951](https://tools.ietf.org/html/rfc7951)). * Manipulation with the instance data. * Support for default values in the instance data ([RFC 6243](https://tools.ietf.org/html/rfc6243)). * Support for YANG extensions. * Support for YANG Metadata ([RFC 7952](https://tools.ietf.org/html/rfc7952)). * [yanglint](#yanglint) - feature-rich YANG tool. Current implementation covers YANG 1.0 ([RFC 6020](https://tools.ietf.org/html/rfc6020)) as well as YANG 1.1 ([RFC 7950](https://tools.ietf.org/html/rfc7950)). ## Requirements ### Build Requirements * C compiler * cmake >= 2.8.12 * libpcre2 >= 10.21 (including devel package) * note, that PCRE is supposed to be compiled with unicode support (configure's options `--enable-utf` and `--enable-unicode-properties`) #### Optional * doxygen (for generating documentation) * cmocka >= 1.0.0 (for [tests](#Tests)) * valgrind (for enhanced testing) * gcov (for code coverage) * lcov (for code coverage) * genhtml (for code coverage) ### Runtime Requirements * libpcre2 >= 10.21 ## Building ``` $ mkdir build; cd build $ cmake .. $ make # make install ``` ### Useful CMake Options #### Changing Compiler Set `CC` variable: ``` $ CC=/usr/bin/clang cmake .. ``` #### Changing Install Path To change the prefix where the library, headers and any other files are installed, set `CMAKE_INSTALL_PREFIX` variable: ``` $ cmake -DCMAKE_INSTALL_PREFIX:PATH=/usr .. ``` Default prefix is `/usr/local`. #### Build Modes There are two build modes: * Release. This generates library for the production use without any debug information. * Debug. This generates library with the debug information and disables optimization of the code. The `Debug` mode is currently used as the default one. to switch to the `Release` mode, enter at the command line: ``` $ cmake -D CMAKE_BUILD_TYPE:String="Release" .. ``` #### Changing Extensions Plugins Directory As for YANG extensions, libyang allows loading extension plugins. By default, the directory to store the plugins is LIBDIR/libyang. To change it, use the following cmake option with the value specifying the desired directory: ``` $ cmake -DPLUGINS_DIR:PATH=`pwd`"/src/extensions/" .. ``` The directory path can be also changed runtime via environment variable, e.g.: ``` $ LIBYANG_EXTENSIONS_PLUGINS_DIR=`pwd`/my/relative/path yanglint ``` #### Optimizations Whenever the latest revision of a schema is supposed to be loaded (import without specific revision), it is performed in the standard way, the first time. By default, every other time when the latest revision of the same schema is needed, the one initially loaded is reused. If you know this can cause problems meaning the latest available revision of a schema can change during operation, you can force libyang to always search for the schema anew by: ``` $ cmake -DENABLE_LATEST_REVISIONS=OFF .. ``` ### CMake Notes Note that, with CMake, if you want to change the compiler or its options after you already ran CMake, you need to clear its cache first - the most simple way to do it is to remove all content from the 'build' directory. ## Usage All libyang functions are available via the main header: ``` #include ``` To compile your program with libyang, it is necessary to link it with libyang using the following linker parameters: ``` -lyang ``` Note, that it may be necessary to call `ldconfig(8)` after library installation and if the library was installed into a non-standard path, the path to libyang must be specified to the linker. To help with setting all the compiler's options, there is `libyang.pc` file for `pkg-config(1)` available in the source tree. The file is installed with the library. If you are using `cmake` in you project, it is also possible to use the provided `FindLibYANG.cmake` file to detect presence of the libyang library in the system. ## Bindings There are no bindings for other languages directly in this project but they are available separately. * [Rust](https://github.com/rwestphal/yang2-rs/) ## yanglint libyang project includes a feature-rich tool called `yanglint(1)` for validation and conversion of the schemas and YANG modeled data. The source codes are located at [`/tools/lint`](./tools/lint) and can be used to explore how an application is supposed to use the libyang library. `yanglint(1)` binary as well as its man page are installed together with the library itself. There is also [README](./tools/lint/examples/README.md) describing some examples of using `yanglint`. ## Tests libyang includes several tests built with [cmocka](https://cmocka.org/). The tests can be found in `tests` subdirectory and they are designed for checking library functionality after code changes. Additional regression tests done with a corpus of fuzzing inputs that previously caused crashes are done. Those are available in `tests/fuzz` and are built automatically with the cmocka unit tests. The tests are by default built in the `Debug` build mode by running ``` $ make ``` In case of the `Release` mode, the tests are not built by default (it requires additional dependency), but they can be enabled via cmake option: ``` $ cmake -DENABLE_BUILD_TESTS=ON .. ``` Note that if the necessary [cmocka](https://cmocka.org/) headers are not present in the system include paths, tests are not available despite the build mode or cmake's options. Tests can be run by the make's `test` target: ``` $ make test ``` ### Code Coverage Based on the tests run, it is possible to generate code coverage report via the make's `coverage` target: ``` $ make coverage ``` ## Fuzzing Multiple YANG fuzzing targets and fuzzing instructions are available in the `tests/fuzz` directory. All of the targets can be fuzzed with LLVM's LibFuzzer and AFL, and new targets can easily be added. Asciinema examples which describe the fuzzing setup for both AFL (https://asciinema.org/a/311060) and LibFuzzer (https://asciinema.org/a/311035) are available.