aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md52
1 files changed, 52 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..448aed1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,52 @@
+SUMMARY
+-------
+
+This contains a basic OAuth2 authorization and token server:
+cynagoauth-server.
+
+It currently only implments the client credential flow, checking
+the client identity using the Smack label. A tiny launcher,
+cynagoauth-launch, is provided to negociate the token and run
+the final client, setting CYNAGOAUTH_TOKEN environment
+variable and substi
+
+
+
+LICENSE
+-------
+
+This is released under the terms of APLv2 as explained
+in file LICENSE.txt
+
+
+DEPENDENCIES
+------------
+
+It depends of:
+
+ - json-c
+ - libmicrohttpd
+ - openssl
+ - libcurl
+
+
+COMPILING
+---------
+
+To compile and install it:
+
+```
+mkdir build
+cd build
+cmake ..
+make
+```
+
+RFCs
+----
+
+OAuth 2.0 Authorization Server Metadata: https://tools.ietf.org/html/rfc8414
+
+OAuth 2.0 Dynamic Client Registration Protocol: https://tools.ietf.org/html/rfc7591
+
+OpenID Connect Discovery 1.0: https://openid.net/specs/openid-connect-discovery-1_0.html