diff options
author | Vivien Kraus <vivien@planete-kraus.eu> | 2021-07-30 11:58:08 +0200 |
---|---|---|
committer | Vivien Kraus <vivien@planete-kraus.eu> | 2021-08-01 15:25:08 +0200 |
commit | ed64c545c4723dc0efdb1265b05d682e11e4c1f6 (patch) | |
tree | 4c4393adc62bff130840c41d9fb137c939f12246 /doc | |
parent | c6f9d0a4878b2e94e92cc8fce5800fb43185be4d (diff) |
Change the name!
Diffstat (limited to 'doc')
-rw-r--r-- | doc/Makefile.am | 6 | ||||
-rw-r--r-- | doc/disfluid.texi (renamed from doc/webid-oidc.texi) | 91 | ||||
-rw-r--r-- | doc/style.css | 2 |
3 files changed, 16 insertions, 83 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index 7cdbfd3..d300e77 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,4 +1,4 @@ -# webid-oidc, implementation of the Solid specification +# disfluid, implementation of the Solid specification # Copyright (C) 2020, 2021 Vivien Kraus # This program is free software: you can redistribute it and/or modify @@ -17,7 +17,7 @@ EXTRA_DIST += \ %reldir%/fdl.texi -info_TEXINFOS = %reldir%/webid-oidc.texi -%canon_reldir%_webid_oidc_texi_TEXINFOS = %reldir%/fdl.texi +info_TEXINFOS = %reldir%/disfluid.texi +%canon_reldir%_disfluid_texi_TEXINFOS = %reldir%/fdl.texi AM_MAKEINFOHTMLFLAGS = --css-include=doc/style.css diff --git a/doc/webid-oidc.texi b/doc/disfluid.texi index e7df400..bebc61b 100644 --- a/doc/webid-oidc.texi +++ b/doc/disfluid.texi @@ -3,7 +3,7 @@ @documentlanguage en @comment %**start of header @include version.texi -@settitle Webid-oidc manual +@settitle Demanding Interoperability to Strengthen the Free (Libre) Web: Introducing Disfluid @syncodeindex pg cp @syncodeindex fn cp @syncodeindex vr cp @@ -11,7 +11,7 @@ @comment %**end of header @copying -This is the manual of webid-oidc (version @value{VERSION}, @value{UPDATED}), an implementation of the Solid authentication protocol for guile, client and server. +This is the manual of disfluid (version @value{VERSION}, @value{UPDATED}), an implementation of the Solid authentication protocol for guile, client and server. Copyright @copyright{} 2020, 2021 Vivien Kraus @quotation @@ -27,11 +27,11 @@ Free Documentation License'' @dircategory Software libraries @direntry -* webid-oidc: (webid-oidc)Decentralized Authentication on the Web. +* disfluid: (disfluid)Interoperability on the web @end direntry @titlepage -@title Webid-oidc manual +@title Demanding Interoperability to Strengthen the Free (Libre) Web: Introducing Disfluid @subtitle for version @value{VERSION}, @value{UPDATED} @author Vivien Kraus (@email{vivien@@planete-kraus.eu}) @page @@ -42,12 +42,12 @@ Free Documentation License'' @contents @ifnottex @node Top -@top Webid-oidc +@top Disfluid @end ifnottex @menu * Decentralized Authentication on the Web:: -* Invoking webid-oidc:: +* Invoking disfluid:: * The Json Web Token:: * Caching on server side:: * Content negociation:: @@ -100,10 +100,10 @@ well-established OpenID Connect. It is intended to work in a web browser, but this package demonstrates that it also works without a web browser. -@node Invoking webid-oidc -@chapter Invoking webid-oidc +@node Invoking disfluid +@chapter Invoking disfluid -The @samp{webid-oidc} program provides different modes of operations: +The @samp{disfluid} program provides different modes of operations: @table @samp @item reverse-proxy @@ -150,7 +150,7 @@ environment variable. @section General server configuration All servers are published under the Affero GPL, which means that the service provider needs to publish all changes made to the program to -users over the network. The @samp{webid-oidc} command provides a +users over the network. The @samp{disfluid} command provides a @samp{--complete-corresponding-source} option so that the system administrator can specify a means to download the source. @@ -604,7 +604,6 @@ the seed. @chapter Running a Resource Server @menu -* Running webid-oidc reverse-proxy:: * The authenticator:: * The full server:: * Resources stored on the server:: @@ -614,38 +613,6 @@ A Solid server is the server that manages your data. It needs to check that the proofs of possession are correct, and the possessed key is signed by the identity provider. -@node Running webid-oidc reverse-proxy -@section Running webid-oidc reverse-proxy - -The @code{webid-oidc} program comes with a reverse proxy command, -aptly named @code{reverse-proxy}, to listen to an interface, take -requests, authenticate them, and pass them to a backend with an -additional header containing the webid of the agent, if authenticated. - -The reverse proxy is invoked with the following arguments: - -@table @asis -@item @code{-p}@var{PORT}, @code{--port=}@var{PORT} -the port on which the reverse proxy listens; -@item @code{-n}@var{URI}, @code{--server-name=}@var{URI} -the public name of the server; -@item @code{-b}@var{URI}, @code{--backend-uri=}@var{URI} -the address of the backend; -@item @code{-H}@var{HEADER}, @code{--header=}@var{HEADER} -replace the name of the header that will contain the webid of the -user. Defaults to @code{XXX-Agent}. Please note that this value should -be ASCII, otherwise it’s not guaranteed that the reverse proxy will -drop other capitalizations of the header in malicious requests; -@item @code{-l @var{FILE.log}}, or @code{--log-file=@var{FILE.log}} -let the server dump all its output to @var{FILE.log}. See the identity -provider comment; -@item @code{-e @var{FILE.err}}, or @code{--error-file=@var{FILE.err}} -let the server dump all its errors to @var{FILE.err}. -@end table - -You can localize the interface by setting the @var{LANG} environment -variable. - @node The authenticator @section The authenticator @@ -931,8 +898,8 @@ used to issue DPoP proofs. @end deffn An example application is provided as the -@code{webid-oidc-example-app} program. It demonstrates how -authentication is done. It should help you understand how webid-oidc +@code{disfluid-example-app} program. It demonstrates how +authentication is done. It should help you understand how Solid-OIDC works. The identity provider needs to call the application on the web. So, @@ -945,40 +912,6 @@ the @var{client-name} to your application name and @var{client-uri} to point to where to a presentation of your application. @end deffn -The @code{webid-oidc} @code{client-service} command can run a server -to serve these resources. It is invoked with the following options: - -@table @asis -@item @code{-h}, or @code{--help} -prints a summary of the options and exit. -@item @code{-v}, or @code{--version} -prints the version of the program and exits. -@item @code{-c @var{URI}}, or @code{--client-id=@var{URI}} -sets the global identitifier of the application, which is dereferenced -to a semantic resource. -@item @code{-r @var{URI}}, or @code{--redirect-uri=@var{URI}} -sets the redirection URI. -@item @code{-C @var{NAME}}, or @code{--client-name=@var{NAME}} -sets the name of your application, so that it is shown when the user -gets an authorization. The webid-oidc issuer program that comes with -this package does not display it, because it could be dishonest, but -other implementations might. -@item @code{-u @var{URI}}, or @code{--client-uri=@var{URI}} -sets an URI for the identity provider to learn more about your app. -@item @code{-p @var{PORT}}, or @code{--port=@var{PORT}} -change the port number used by the server. By default, it is set to -8080. -@item @code{-l @var{FILE.log}}, or @code{--log-file=@var{FILE.log}} -let the server dump all its output to @var{FILE.log}. -@item @code{-e @var{FILE.err}}, or @code{--error-file=@var{FILE.err}} -let the server dump all its errors to @var{FILE.err}. -@end table - -The command is sensitive to the environment variable @emph{LANG}, -which influences how the program is internationalized to the server -administrator. This changes the long form of the options, and the -language in the log files. - @node Exceptional conditions @chapter Exceptional conditions diff --git a/doc/style.css b/doc/style.css index e2dd04d..9a870f8 100644 --- a/doc/style.css +++ b/doc/style.css @@ -1,4 +1,4 @@ -/* webid-oidc, implementation of the Solid specification +/* disfluid, implementation of the Solid specification Copyright (C) 2020, 2021 Vivien Kraus This program is free software: you can redistribute it and/or modify |