summaryrefslogtreecommitdiff
path: root/doc/webid-oidc.texi
diff options
context:
space:
mode:
Diffstat (limited to 'doc/webid-oidc.texi')
-rw-r--r--doc/webid-oidc.texi14
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/webid-oidc.texi b/doc/webid-oidc.texi
index c8219c6..81d408a 100644
--- a/doc/webid-oidc.texi
+++ b/doc/webid-oidc.texi
@@ -48,6 +48,7 @@ Free Documentation License''
@menu
* Decentralized Authentication on the Web::
* The Json Web Token::
+* Exceptional conditions::
* GNU Free Documentation License::
* Index::
@end menu
@@ -107,6 +108,19 @@ following, we will only be interested by public-key cryptography. The
concatenation of header, dot, payload, dot and signature in base64 is
the encoding of the JWT.
+@node Exceptional conditions
+@chapter Exceptional conditions
+
+The library will raise an exception whenever something fishy
+occurs. For instance, if a signature is invalid, or the expiration
+date has passed. All exception types are defined in
+@code{(webid-oidc errors)}.
+
+@deffn function error->str @var{error} @var{[#depth]}
+Return a string explaining the @var{error}. You can limit the
+@var{depth} of the explanation as an integer.
+@end deffn
+
@node GNU Free Documentation License
@appendix GNU Free Documentation License