aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--doc/handbook/chapters/user.texi27
1 files changed, 14 insertions, 13 deletions
diff --git a/doc/handbook/chapters/user.texi b/doc/handbook/chapters/user.texi
index 5aa3a62bf..ea41bbb6c 100644
--- a/doc/handbook/chapters/user.texi
+++ b/doc/handbook/chapters/user.texi
@@ -1914,22 +1914,22 @@ Like other IdPs, re:claim features an (optional) OpenID-Connect 1.0-compliant pr
1914Before adding attributes to an identity, you must first create an ego: 1914Before adding attributes to an identity, you must first create an ego:
1915 1915
1916@example 1916@example
1917$ gnunet-identity -C "username" 1917$ gnunet-identity -C "user"
1918@end example 1918@end example
1919 1919
1920Henceforth, you can manage a new user profile of the user ``username''. 1920Henceforth, you can manage a new user profile of the user ``user''.
1921 1921
1922To add an email address to your user profile, simply use the @command{gnunet-reclaim} command line tool:: 1922To add an email address to your user profile, simply use the @command{gnunet-reclaim} command line tool::
1923 1923
1924@example 1924@example
1925$ gnunet-reclaim -e "username" -a "email" -V "username@@example.gnunet" 1925$ gnunet-reclaim -e "user" -a "email" -V "username@@example.gnunet"
1926@end example 1926@end example
1927 1927
1928All of your attributes can be listed using the @command{gnunet-reclaim} 1928All of your attributes can be listed using the @command{gnunet-reclaim}
1929command line tool as well: 1929command line tool as well:
1930 1930
1931@example 1931@example
1932$ gnunet-reclaim -e "username" -D 1932$ gnunet-reclaim -e "user" -D
1933@end example 1933@end example
1934 1934
1935Currently, and by default, attribute values are interpreted as plain text. 1935Currently, and by default, attribute values are interpreted as plain text.
@@ -1941,10 +1941,10 @@ In the future there might be more value types such as X.509 certificate credenti
1941If you want to allow a third party such as a website or friend to access to your attributes (or a subset thereof) execute: 1941If you want to allow a third party such as a website or friend to access to your attributes (or a subset thereof) execute:
1942 1942
1943@example 1943@example
1944$ gnunet-reclaim -e "username" -r "PKEY" -i "attribute1,attribute2,..." 1944$ gnunet-reclaim -e "user" -r "PKEY" -i "attribute1,attribute2,..."
1945@end example 1945@end example
1946 1946
1947Where "PKEY" is the public key of the third party and "attribute1,attribute2,..." is a comma-separated list of attribute names, such as "email", that you want to share. 1947Where "PKEY" is the public key of the third party and "attribute1,attribute2,..." is a comma-separated list of attribute names, such as "email,name,...", that you want to share.
1948 1948
1949The command will return a "ticket" string. 1949The command will return a "ticket" string.
1950You must give this "ticket" to the requesting third party. 1950You must give this "ticket" to the requesting third party.
@@ -1955,13 +1955,14 @@ The third party can then retrieve your shared identity attributes using:
1955$ gnunet-reclaim -e "friend" -C "ticket" 1955$ gnunet-reclaim -e "friend" -C "ticket"
1956@end example 1956@end example
1957 1957
1958Where "friend" is the name for "user" that the requesting party is using.
1958This will retrieve and list the shared identity attributes. 1959This will retrieve and list the shared identity attributes.
1959The above command will also work if the user "username" is currently offline since the attributes are retrieved from GNS. 1960The above command will also work if the user is currently offline since the attributes are retrieved from GNS.
1960Further, the "ticket" can be re-used later to retrieve up-to-date attributes in case "username" has changed the value(s). For instance, becasue his email address changed. 1961Further, the "ticket" can be re-used later to retrieve up-to-date attributes in case "friend" has changed the value(s). For instance, because his email address changed.
1961 1962
1962To list all given authorizations (tickets) you can execute: 1963To list all given authorizations (tickets) you can execute:
1963@example 1964@example
1964$ gnunet-reclaim -e "friend" -T (TODO there is only a REST API for this ATM) 1965$ gnunet-reclaim -e "friend" -T (TODO there is only a C and REST API for this at this time)
1965@end example 1966@end example
1966 1967
1967 1968
@@ -1971,7 +1972,7 @@ $ gnunet-reclaim -e "friend" -T (TODO there is only a REST API for this ATM)
1971If you want to revoke the access of a third party to your attributes you can execute: 1972If you want to revoke the access of a third party to your attributes you can execute:
1972 1973
1973@example 1974@example
1974$ gnunet-reclaim -e "username" -R "ticket" 1975$ gnunet-reclaim -e "user" -R "ticket"
1975@end example 1976@end example
1976 1977
1977This will prevent the third party from accessing the attribute in the future. 1978This will prevent the third party from accessing the attribute in the future.
@@ -1983,14 +1984,14 @@ This behaviour is _exactly the same_ as with other IdPs.
1983@subsection Using the OpenID-Connect IdP 1984@subsection Using the OpenID-Connect IdP
1984 1985
1985@menu 1986@menu
1986* Setting up reclaim.io:: 1987* Setting up reclaim.id::
1987* For Users:: 1988* For Users::
1988* For Service Providers:: 1989* For Service Providers::
1989@end menu 1990@end menu
1990 1991
1991 1992
1992@node Setting up reclaim.io 1993@node Setting up reclaim.id
1993@subsubsection Setting up reclaim.io 1994@subsubsection Setting up reclaim.id
1994 1995
1995@example 1996@example
1996$ gnunet-identity -C id 1997$ gnunet-identity -C id