https://github.com/cloudfoundry/cf-uaac
https://github.com/cloudfoundry/cf-uaac
Last synced: 9 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/cloudfoundry/cf-uaac
- Owner: cloudfoundry
- License: apache-2.0
- Created: 2012-11-21T21:09:39.000Z (about 13 years ago)
- Default Branch: main
- Last Pushed: 2025-03-05T11:40:02.000Z (11 months ago)
- Last Synced: 2025-04-24T14:04:40.392Z (10 months ago)
- Language: Ruby
- Homepage:
- Size: 913 KB
- Stars: 42
- Watchers: 83
- Forks: 29
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CloudFoundry UAA Command Line Client
[](https://rubygems.org/gems/cf-uaac)
## Operating system compatibility
The `uaac` CLI is tested on Linux and Mac OS, and is supported on these systems.
It is not tested or supported on Windows, though it has been known to work at some point.
## Installation
From Rubygems:
`gem install cf-uaac`
Or to build and install the gem:
```
bundle install
gem build cf-uaac.gemspec
gem install cf-uaac*.gem
```
### Troubleshooting possible installation issues
You may encounter some errors when building native extentions of the required
Gems. We redirect you to the documentation of those Gem dependencies, as many
different compilation/linking issue may occur.
Typical issues with x86 Darwin systems (i.e. macOS) may involve the following
`cflags` and `ldflags` options, for the `bundler` Gem to properly build the
required Gems native extensions. You should not use them blindly without
knowing what you're doing. If you don't want persistent workarounds in your
Bundler config, those settings can also be passed to one-off `gem install`
invocations. Please refer to `gem help install` and `man bundle-config`.
```
bundle config build.eventmachine --with-cflags="-fms-extensions"
bundle config build.mysql2 --with-ldflags="-L/usr/local/opt/openssl@1.1/lib"
bundle config build.thin --with-cflags="-fms-extensions -Wno-error=implicit-function-declaration"
```
## Concepts
The user uses a client (like a webapp, or uaac) to do things. The client and the user have different secrets; both the user's and client's secret are passwords.
## Connecting and logging in
* `uaac help` opens up the help menu and shows a full list of commands.
* `uaac target` tells UAAC which UAA you're targeting. e.g. `uaa.example.io`.
* `uaac target ` lets you choose a registered target.
* `uaac targets` lists all registered targets.
* `uaac token client get (-s )` authenticates and gets your token so it can be used by UAAC. The `-s` or `--secret` flag is for inputting your secret, otherwise it will be asked for by UAAC.
Now that UAAC has your token, you're able to run commands and hit the endpoints that your client has the proper scopes for. A list of scopes can be found in [UAA's API documentation.](https://github.com/cloudfoundry/uaa/blob/master/docs/UAA-APIs.rst#scopes-authorized-by-the-uaa)
To use the APIs, see: https://github.com/cloudfoundry/cf-uaa-lib
### Caveats in connecting
When necessary, the `--skip-ssl-validation` flag should be used once only,
along with the `uaac target` invocation. See `uaac target -h`.
## Creating clients
Authenticate as `admin`, or a user with the right permissions: `clients.admin` or `clients.write`.
`uaac client add -i` brings up the interactive interface. If entering multiple values, separate them with commas.
Scopes and authorities are different in the context of a client.
* Scopes is a list of permitted scopes for this client to obtain on behalf of a user.
* Authorities is a list of granted authorities for the client, such as `uaa.admin` or `scim.invite`.
`uaac contexts` will list the scopes for a client, which correspond to the users' authorities.
## Tests
Run the tests with rake:
`bundle exec rake test`
Run the tests and see a fancy coverage report:
`bundle exec rake cov`
Run integration tests (on a server running on localhost:8080/uaa):
```
export UAA_CLIENT_ID="admin"
export UAA_CLIENT_SECRET="adminsecret"
export UAA_CLIENT_TARGET="http://localhost:8080/uaa"
bundle exec rake test
```