mart-w/kanidm
1
0
Fork 0
mirror of https://github.com/kanidm/kanidm.git synced 2025-02-24 04:57:00 +01:00
Code Issues Actions 10 Packages Projects Releases Wiki Activity
kanidm/kanidm_book/src/client_tools.md

85 lines
2.4 KiB
Markdown
Raw Normal View History

20191202 documentation (#156) Add an initial skeleton and draft of a book, which should be maintained and improved as the server is developed to help guide users.
2019-12-03 07:03:05 +01:00
# Interacting with the Server
To interact with Kanidm as an administration, you'll need to use our command line tools
## From (experimental) packages
Minor typo and formatting fixes.
2020-01-27 13:30:09 +01:00
Kanidm currently supports:
13 135 webauthn support (#332) Fixes #13 and Fixes #135 - webauthn and webauthn with cli. This is the core of webauthn, but only as a single factor. Some changes are still needed for webauthn as MFA and as a verified single factor. This will be made in a subsequent PR.
2020-12-02 02:12:07 +01:00
* Fedora 33
* OpenSUSE leap 15.2
Minor typo and formatting fixes.
2020-01-27 13:30:09 +01:00
* Tumbleweed
20191202 documentation (#156) Add an initial skeleton and draft of a book, which should be maintained and improved as the server is developed to help guide users.
2019-12-03 07:03:05 +01:00
Update tumbleweed docs
2020-10-14 05:05:45 +02:00
### OpenSUSE Tumbleweed
20191202 documentation (#156) Add an initial skeleton and draft of a book, which should be maintained and improved as the server is developed to help guide users.
2019-12-03 07:03:05 +01:00
Update tumbleweed docs
2020-10-14 05:05:45 +02:00
Kanidm is part of OpenSUSE Tumbleweed since October 2020. This means you can install
the clients with:
zypper ref
zypper in kanidm-clients
### OpenSUSE Leap 15.2
Leap 15.2 is still not fully supported with Kanidm. For an experimental client, you can
try the development repository. Using zypper you can add the repository with:
20191202 documentation (#156) Add an initial skeleton and draft of a book, which should be maintained and improved as the server is developed to help guide users.
2019-12-03 07:03:05 +01:00
zypper ar obs://home:firstyear:kanidm home_firstyear_kanidm
195 rel cleanup (#268) Fixes #195 pre release cleanup. This does a LOT, clippy, formatting, and much much more. It fixes a lot of parts of the book, improves server config and more.
2020-06-18 02:30:42 +02:00
zypper mr -f home_firstyear_kanidm
20191202 documentation (#156) Add an initial skeleton and draft of a book, which should be maintained and improved as the server is developed to help guide users.
2019-12-03 07:03:05 +01:00
Then you need to referesh your metadata and install the clients.
zypper ref
zypper in kanidm-clients
### Fedora
Update tumbleweed docs
2020-10-14 05:05:45 +02:00
Fedora is still experimentally supported through the development repository. You need to add the repository metadata into the correct directory.
20191202 documentation (#156) Add an initial skeleton and draft of a book, which should be maintained and improved as the server is developed to help guide users.
2019-12-03 07:03:05 +01:00
cd /etc/yum.repos.d
13 135 webauthn support (#332) Fixes #13 and Fixes #135 - webauthn and webauthn with cli. This is the core of webauthn, but only as a single factor. Some changes are still needed for webauthn as MFA and as a verified single factor. This will be made in a subsequent PR.
2020-12-02 02:12:07 +01:00
wget https://download.opensuse.org/repositories/home:/firstyear:/kanidm/Fedora_33/home:firstyear:kanidm.repo
195 rel cleanup (#268) Fixes #195 pre release cleanup. This does a LOT, clippy, formatting, and much much more. It fixes a lot of parts of the book, improves server config and more.
2020-06-18 02:30:42 +02:00
Update tumbleweed docs
2020-10-14 05:05:45 +02:00
You can then install with:
dnf install kanidm-clients
20191202 documentation (#156) Add an initial skeleton and draft of a book, which should be maintained and improved as the server is developed to help guide users.
2019-12-03 07:03:05 +01:00
## From source
After you check out the source (see github), navigate to:
cd kanidm_tools
195 rel cleanup (#268) Fixes #195 pre release cleanup. This does a LOT, clippy, formatting, and much much more. It fixes a lot of parts of the book, improves server config and more.
2020-06-18 02:30:42 +02:00
cargo install --path .
20191202 documentation (#156) Add an initial skeleton and draft of a book, which should be maintained and improved as the server is developed to help guide users.
2019-12-03 07:03:05 +01:00
Minor typo and formatting fixes.
2020-01-27 13:30:09 +01:00
## Check the tools work
20191202 documentation (#156) Add an initial skeleton and draft of a book, which should be maintained and improved as the server is developed to help guide users.
2019-12-03 07:03:05 +01:00
Now you can check your instance is working. You may need to provide a CA certificate for verification
with the -C parameter:
250 cookie to auth bearer (#321) Fixes #250, replacing cookies with auth-bearer tokens. This is done using fernet with randomised keys each startup. The reason for this is that in the future the size of the auth token may exceed cookie limits, so we must be able to understand and process auth bearer. Additionaly, this lets us store the tokens for say the kanidm cli as reqwest today can't persist a cookie jar.
2020-09-18 05:19:57 +02:00
kanidm login --name anonymous
20191202 documentation (#156) Add an initial skeleton and draft of a book, which should be maintained and improved as the server is developed to help guide users.
2019-12-03 07:03:05 +01:00
kanidm self whoami -C ../path/to/ca.pem -H https://localhost:8443 --name anonymous
kanidm self whoami -H https://localhost:8443 --name anonymous
195 rel cleanup (#268) Fixes #195 pre release cleanup. This does a LOT, clippy, formatting, and much much more. It fixes a lot of parts of the book, improves server config and more.
2020-06-18 02:30:42 +02:00
Now you can take some time to look at what commands are available - please ask for help at anytime.
20191202 documentation (#156) Add an initial skeleton and draft of a book, which should be maintained and improved as the server is developed to help guide users.
2019-12-03 07:03:05 +01:00
250 cookie to auth bearer (#321) Fixes #250, replacing cookies with auth-bearer tokens. This is done using fernet with randomised keys each startup. The reason for this is that in the future the size of the auth token may exceed cookie limits, so we must be able to understand and process auth bearer. Additionaly, this lets us store the tokens for say the kanidm cli as reqwest today can't persist a cookie jar.
2020-09-18 05:19:57 +02:00
## Authenticating a user with the command line
To authenticate as a user for use with the command line, you need to use the `login` command
to establish a session token.
kanidm login --name USERNAME
kanidm login --name admin
Once complete, you can use kanidm without reauthenticating for a period of time for administration.
20191202 documentation (#156) Add an initial skeleton and draft of a book, which should be maintained and improved as the server is developed to help guide users.
2019-12-03 07:03:05 +01:00
## Kandim configuration
You can configure kanidm to help make commands simpler by modifying ~/.config/kanidm OR /etc/kanidm/config
uri = "https://idm.example.com"
verify_ca = true|false
verify_hostnames = true|false
ca_path = "/path/to/ca.pem"
Once configured, you can test this with:
kanidm self whoami --name anonymous
250 cookie to auth bearer (#321) Fixes #250, replacing cookies with auth-bearer tokens. This is done using fernet with randomised keys each startup. The reason for this is that in the future the size of the auth token may exceed cookie limits, so we must be able to understand and process auth bearer. Additionaly, this lets us store the tokens for say the kanidm cli as reqwest today can't persist a cookie jar.
2020-09-18 05:19:57 +02:00
Reference in a new issue Copy permalink