diff options
author | Vivien Kraus <vivien@planete-kraus.eu> | 2021-05-05 15:22:01 +0200 |
---|---|---|
committer | Vivien Kraus <vivien@planete-kraus.eu> | 2021-06-19 15:44:36 +0200 |
commit | 7b97db1634394f90e653d0cd25bc45ce770b10f3 (patch) | |
tree | 49ef000fb158f1087c95bd4a13eea20c3565e137 /doc | |
parent | 3f66c5a713694d6acf8ce66319fe9719539d2a37 (diff) |
Add a server for an application
Diffstat (limited to 'doc')
-rw-r--r-- | doc/webid-oidc.texi | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/doc/webid-oidc.texi b/doc/webid-oidc.texi index 55a92d9..b9c9f65 100644 --- a/doc/webid-oidc.texi +++ b/doc/webid-oidc.texi @@ -614,6 +614,50 @@ requests. used to issue DPoP proofs. @end deffn +The identity provider needs to call the application on the web. So, +your client should have a public endpoint on the web. + +@deffn function serve-application @var{id} @var{redirect-uri} @var{[#client-name]} @var{[#client-uri]} +Return a handler for web requests to serve the application manifest +and the redirection to transmit the authorization code. You should set +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-client-service} program 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{-i @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{-n @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 program 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 |