* Added Clixon Restconf library
* Builds and installs a new restconf library: libclixon_restconf.so and clixon_restconf.h * The restconf library can be included by a restconf plugin. * Example code in example/Makefile.in and example/restconf_lib.c * Authorization * Example extended with authorization * Test added with http basic authorization (test/test_auth.sh) * Documentation in FAQ.md * README.md extended with new yang, netconf, restconf, datastore, and auth sections.
This commit is contained in:
Olof hagsand
parent
cce76faa79
commit
bfce20c760
17 changed files with 773 additions and 157 deletions
184
README.md
184
README.md
|
|
@ -4,26 +4,43 @@ Clixon is an automatic configuration manager where you generate
|
|||
interactive CLI, NETCONF, RESTCONF and embedded databases with
|
||||
transaction support from a YANG specification.
|
||||
|
||||
Table of contents
|
||||
=================
|
||||
* [Documentation](#documentation)
|
||||
* [Installation](#installation)
|
||||
* [Dependencies](#dependencies)
|
||||
* [Licenses](#licenses)
|
||||
Topics
|
||||
======
|
||||
* [Background](#background)
|
||||
* [Frequently asked questions](doc/FAQ.md)
|
||||
* [Installation](#installation)
|
||||
* [Licenses](#licenses)
|
||||
* [Support](#support)
|
||||
* [Dependencies](#dependencies)
|
||||
* [Extending](#extending)
|
||||
* [Yang](#yang)
|
||||
* [Netconf](#netconf)
|
||||
* [Restconf](#restconf)
|
||||
* [Datastore](datastore/README.md)
|
||||
* [Authentication and Authorization](#auth)
|
||||
* [Example](example/README.md)
|
||||
* [Changelog](CHANGELOG.md) recent changes.
|
||||
* [Clixon SDK](#SDK)
|
||||
* [Clicon and Clixon project page](http://www.clicon.org)
|
||||
* [Tests](test/README.md)
|
||||
* [Reference manual](http://www.clicon.org/doxygen/index.html) (Note: the link may not be up-to-date. It is better to build your own: `cd doc; make doc`)
|
||||
|
||||
Background
|
||||
==========
|
||||
|
||||
Documentation
|
||||
=============
|
||||
- [Frequently asked questions](doc/FAQ.md)
|
||||
- [CHANGELOG](CHANGELOG.md) recent changes.
|
||||
- [XML datastore](datastore/README.md)
|
||||
- [Netconf support](apps/netconf/README.md)
|
||||
- [Restconf support](apps/restconf/README.md)
|
||||
- [Reference manual](http://www.clicon.org/doxygen/index.html) (Note: the link may not be up-to-date. It is better to build your own: `cd doc; make doc`)
|
||||
- [Routing example](example/README.md)
|
||||
- [Clicon and Clixon project page](http://www.clicon.org)
|
||||
- [Tests](test/README.md)
|
||||
Clixon was implemented to provide an open-source generic configuration
|
||||
tool. The existing [CLIgen](http://www.cligen.se) tool was extended to
|
||||
a framework. Most of the user projects are for embedded network and
|
||||
measuring devices, but can be deployed for more general use.
|
||||
|
||||
Users of clixon currently include:
|
||||
* [Netgate](https://www.netgate.com)
|
||||
* [CloudMon360](http://cloudmon360.com)
|
||||
* [Grideye](http://hagsand.se/grideye)
|
||||
* [Netclean](https://www.netclean.com/solutions/whitebox) (only CLIgen)
|
||||
* [Prosilient's PTAnalyzer]<a href="http://www.prosilient.com"> (only CLIgen)
|
||||
|
||||
See also [Clicon project page](http://clicon.org).
|
||||
|
||||
Installation
|
||||
============
|
||||
|
|
@ -38,6 +55,13 @@ A typical installation is as follows:
|
|||
One [example application](example/README.md) is provided, a IETF IP YANG datamodel with
|
||||
generated CLI and configuration interface.
|
||||
|
||||
Licenses
|
||||
========
|
||||
Clixon is open-source and dual licensed. Either Apache License, Version 2.0 or GNU
|
||||
General Public License Version 2; you choose.
|
||||
|
||||
See [LICENSE.md](LICENSE.md) for the license.
|
||||
|
||||
Dependencies
|
||||
============
|
||||
Clixon depends on the following software packages, which need to exist on the target machine.
|
||||
|
|
@ -50,53 +74,105 @@ to build and install CLIgen:
|
|||
- Yacc/bison
|
||||
- Lex/Flex
|
||||
- Fcgi (if restconf is enabled)
|
||||
- [Qdbm](http://fallabs.com/qdbm/) key-value store (if keyvalue datastore is enabled)
|
||||
|
||||
There is no yum/apt/ostree package for Clixon (please help?)
|
||||
|
||||
Licenses
|
||||
Support
|
||||
=======
|
||||
Clixon interaction is best done posting issues, pull requests, or joining the [slack channel](https://join.slack.com/t/clixondev/shared_invite/enQtMzI3OTM4MzA3Nzk3LTA3NWM4OWYwYWMxZDhiYTNhNjRkNjQ1NWI1Zjk5M2JjMDk4MTUzMTljYTZiYmNhODkwMDI2ZTkyNWU3ZWMyN2U).
|
||||
|
||||
Extending
|
||||
=========
|
||||
Clixon provides a core system and can be used as-is using available
|
||||
Yang specifications. However, an application very quickly needs to
|
||||
specialize funxtions. Clixon is extended by (most commonly) writing
|
||||
plugins for cli and backend. Extensions for netconf and restconf
|
||||
are also available.
|
||||
|
||||
Plugins are written in C and easiest is to look at
|
||||
[example](example/README.md) or consulting the [FAQ](doc/FAQ.md).
|
||||
|
||||
Yang
|
||||
====
|
||||
|
||||
YANG and XML is at the heart of Clixon. Yang modules are used as a
|
||||
specification for handling XML configuration data. The YANG spec is
|
||||
used to generate an interactive CLI, netconf and restconf clients. It
|
||||
also manages an XML datastore.
|
||||
|
||||
Clixon mainly follows [YANG 1.0 RFC 6020](https://www.rfc-editor.org/rfc/rfc6020.txt) with some exceptions:
|
||||
- conformance: feature, if-feature, deviation
|
||||
- identity, base, identityref
|
||||
- list features: min/max-elements, unique
|
||||
|
||||
The aim is also to cover new featires in YANG 1.1 [YANG RFC 7950](https://www.rfc-editor.org/rfc/rfc7950.txt)
|
||||
|
||||
Clixon has its own XML library designed for performance.
|
||||
|
||||
Netconf
|
||||
=======
|
||||
Clixon implements the following NETCONF proposals or standards:
|
||||
- [NETCONF Configuration Protocol](http://www.rfc-base.org/txt/rfc-4741.txt)
|
||||
- [Using the NETCONF Configuration Protocol over Secure SHell (SSH)](http://www.rfc-base.org/txt/rfc-4742.txt)
|
||||
- [NETCONF Event Notifications](http://www.rfc-base.org/txt/rfc-5277.txt)
|
||||
|
||||
Some updates are being made to RFC 6241 and RFC 6242.
|
||||
|
||||
Clixon does not support the following features:
|
||||
|
||||
- :url capability
|
||||
- copy-config source config
|
||||
- edit-config testopts
|
||||
- edit-config erropts
|
||||
- edit-config config-text
|
||||
|
||||
Restconf
|
||||
========
|
||||
Clixon is dual licensed. Either Apache License, Version 2.0 or GNU
|
||||
General Public License Version 2; you choose.
|
||||
Clixon restconf is a daemon based on FASTCGI. Instructions are available to
|
||||
run with NGINX.
|
||||
The implementatation is based on [RFC 8040: RESTCONF Protocol](https://tools.ietf.org/html/rfc8040).
|
||||
The following features are supported:
|
||||
- OPTIONS, HEAD, GET, POST, PUT, DELETE
|
||||
The following are not implemented
|
||||
- PATCH
|
||||
- query parameters (section 4.9)
|
||||
- notifications (sec 6)
|
||||
- schema resource
|
||||
|
||||
See [LICENSE.md](LICENSE.md) for the license.
|
||||
See [more detailed restconf instructions](apps/restconf/README.md).
|
||||
|
||||
Background
|
||||
==========
|
||||
We implemented Clixon since we needed a generic configuration tool in
|
||||
several projects, including
|
||||
[KTH](http://www.csc.kth.se/~olofh/10G_OSR). Most of these projects
|
||||
were for embedded network and measuring-probe devices. We started with
|
||||
something called Clicon which was based on a key-value specification
|
||||
and data-store. But as time passed new standards evolved and we
|
||||
started adapting it to XML, Yang and netconf. Finally we made Clixon,
|
||||
where the legacy key specification has been replaced completely by
|
||||
YANG and using XML as configuration data. This means that legacy
|
||||
Clicon applications do not run on Clixon.
|
||||
Datastore
|
||||
=========
|
||||
The Clixon datastore is a stand-alone XML based datastore. The idea is
|
||||
to be able to use different datastores backends with the same
|
||||
API.
|
||||
|
||||
Update: There used to be a key-value plugin based on qdbm but isnow obsoleted. Only a text datastore is implemented.
|
||||
|
||||
The datastore is primarily designed to be used by Clixon but can be used
|
||||
separately.
|
||||
|
||||
See [more detailed restconf instructions](datastore/README.md).
|
||||
|
||||
|
||||
Auth
|
||||
====
|
||||
|
||||
Authentication is not in-scope for Clixon, however, there is ongoing work
|
||||
to implement [NACM](https://tools.ietf.org/html/rfc8341).
|
||||
|
||||
There are hooks (plugin callbacks) to identify which user is accessing a
|
||||
client. That identity can then be used for authorization.
|
||||
|
||||
In short, authentication needs to be coupled to clixon clients:
|
||||
* CLI - Login has already been made via SSH
|
||||
* Netconf - SSH netconf subsystem
|
||||
* Restconf needs credentials. See [FAQ](doc/FAQ.md#How-do-I-write-an-authentication-callback). The [Example](example/README.md) has an example how to do this with HTTP basic auth. It is possible for do this for more advanced mechanisms such as Oauth2 or [https://github.com/CESNET/Netopeer2/tree/master/server/configuration]
|
||||
|
||||
SDK
|
||||
===
|
||||
|
||||
<img src="doc/clixon_example_sdk.png" alt="clixon sdk" style="width: 200px;"/>
|
||||
<img src="doc/clixon_example_sdk.png" alt="clixon sdk" style="width: 180px;"/>
|
||||
|
||||
The figure shows the SDK runtime of Clixon.
|
||||
|
||||
YANG and XML is at the heart of Clixon. Yang modules are used as a
|
||||
specification for handling XML configuration data. The spec is also
|
||||
used to generate an interactive CLI client as well as provide
|
||||
[Netconf](apps/netconf/README.md) and
|
||||
[Restconf](apps/restconf/README.md) clients.
|
||||
|
||||
The [YANG RFC 6020](https://www.rfc-editor.org/rfc/rfc6020.txt) is implemented with the following exceptions:
|
||||
- conformance: feature, if-feature, deviation
|
||||
- identity, base, identityref
|
||||
- list features: min/max-elements, unique, ordered-by
|
||||
|
||||
There are also new features in YANG 1.1 [YANG RFC
|
||||
7950](https://www.rfc-editor.org/rfc/rfc7950.txt), most of which are
|
||||
not implemented.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue