d7da1b6044
The Pinning Services API standard mandates Bearer token authentication.
This adds JWT bearer token authentication to the IPFS Cluster REST and PINSVC
APIs.
The basic_auth_credentials configuration option needs to be not null and have
at least one username/passwords entry.
A user authenticated via Basic Auth can then "POST /token" and obtain a json
object:
```json { "token" : "<JWTtoken>" } ```
The JWT token has the "iss" (issuer) field set to the Basic auth user that
authorized its creation and is HMAC-signed with its password.
When basic-auth-credentials are set, the APIs will verify that requests come
with either Basic Auth authorization header or with a Bearer token
authorization header.
Bearer tokens will be decoded and the signature will be verified against the
password of the issuer.
At the moment we provide no support to revoke tokens, set "expiration date",
"not before" etc, but this may come in the future.
|
||
|---|---|---|
| .github | ||
| adder | ||
| allocator/balanced | ||
| api | ||
| cmd | ||
| cmdutils | ||
| config | ||
| consensus | ||
| datastore | ||
| docker | ||
| informer | ||
| ipfsconn/ipfshttp | ||
| monitor | ||
| observations | ||
| pintracker | ||
| pstoremgr | ||
| rpcutil | ||
| sharness | ||
| state | ||
| test | ||
| version | ||
| .codeclimate.yml | ||
| .codecov.yml | ||
| .dockerignore | ||
| .gitignore | ||
| add_test.go | ||
| allocate.go | ||
| CHANGELOG.md | ||
| cluster_config_test.go | ||
| cluster_config.go | ||
| cluster_test.go | ||
| cluster.go | ||
| clusterhost.go | ||
| config_test.go | ||
| connect_graph.go | ||
| CONTRIBUTING.md | ||
| COPYRIGHT | ||
| docker-compose.yml | ||
| Dockerfile | ||
| Dockerfile-bundle | ||
| Dockerfile-test | ||
| go.mod | ||
| go.sum | ||
| ipfscluster_test.go | ||
| ipfscluster.go | ||
| LICENSE | ||
| LICENSE-APACHE | ||
| LICENSE-MIT | ||
| logging.go | ||
| Makefile | ||
| peer_manager_test.go | ||
| pnet_test.go | ||
| README.md | ||
| release.sh | ||
| rpc_api.go | ||
| rpc_policy.go | ||
| util.go | ||
IPFS Cluster
Pinset orchestration for IPFS
IPFS Cluster provides data orchestration across a swarm of IPFS daemons by allocating, replicating and tracking a global pinset distributed among multiple peers.
There are 3 different applications:
- A cluster peer application:
ipfs-cluster-service, to be run along withgo-ipfsas a sidecar. - A client CLI application:
ipfs-cluster-ctl, which allows easily interacting with the peer's HTTP API. - An additional "follower" peer application:
ipfs-cluster-follow, focused on simplifying the process of configuring and running follower peers.
Are you using IPFS Cluster?
Please participate in the IPFS Cluster user registry.
Table of Contents
Documentation
Please visit https://ipfscluster.io/documentation/ to access user documentation, guides and any other resources, including detailed download and usage instructions.
News & Roadmap
We regularly post project updates to https://ipfscluster.io/news/ .
The most up-to-date Roadmap is available at https://ipfscluster.io/roadmap/ .
Install
Instructions for different installation methods (including from source) are available at https://ipfscluster.io/download .
Usage
Extensive usage information is provided at https://ipfscluster.io/documentation/ , including:
Contribute
PRs accepted. As part of the IPFS project, we have some contribution guidelines.
License
This library is dual-licensed under Apache 2.0 and MIT terms.
© 2022. Protocol Labs, Inc.