Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/keygen-sh/keygen-api
Keygen is a fair source software licensing and distribution API built with Ruby on Rails. For developers, by developers.
https://github.com/keygen-sh/keygen-api
api fair-source license-keys rails rails-api ruby ruby-on-rails software-distribution software-licensing source-available
Last synced: about 2 months ago
JSON representation
Keygen is a fair source software licensing and distribution API built with Ruby on Rails. For developers, by developers.
- Host: GitHub
- URL: https://github.com/keygen-sh/keygen-api
- Owner: keygen-sh
- License: other
- Created: 2016-04-10T22:10:48.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-07-30T16:55:35.000Z (about 2 months ago)
- Last Synced: 2024-07-31T01:43:20.127Z (about 2 months ago)
- Topics: api, fair-source, license-keys, rails, rails-api, ruby, ruby-on-rails, software-distribution, software-licensing, source-available
- Language: Gherkin
- Homepage: https://keygen.sh
- Size: 9.11 MB
- Stars: 732
- Watchers: 14
- Forks: 42
- Open Issues: 179
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Security: SECURITY.md
Awesome Lists containing this project
README
[](https://github.com/keygen-sh/keygen-api/actions)
[][discord]
# Keygen
Keygen is an open, source-available software licensing and distribution API, built
for developers, by developers. Use Keygen to add license key validation,
entitlements, and device activation to your business's desktop apps,
server applications, on-premise software, and other products.
## Software licensing for everyone
Keygen comes in two editions. Keygen CE is our Community Edition, and is
free (as in beer) to self-host for personal and commercial use. Keygen
EE is our Enterprise Edition, and it requires a license key to use.
Keygen EE comes with dedicated support, as well as enterprise-grade features like request logs,
audit logs, permissions, environments, and more.
I built Keygen to make software licensing accessible to everyone.
## Managed hosting with Keygen Cloud
The easiest way to get started with Keygen is with [our official managed
service in the cloud][keygen-cloud]. We'll handle the hard stuff — high
availability, backups, security, and maintenance — while you focus on
product.
Our managed hosting can save a substantial amount of developer time and
resources. For most businesses, this ends up being the best value
option and the revenue goes to funding the maintenance and further
development of Keygen. So you’ll be supporting open source software
and getting a great service!
## Self hosting with Keygen CE
Keygen is an open, source-available software licensing and distribution API, and
we have a free (as in beer) [self-hosted solution][self-hosting]. Keygen Community
Edition is exactly the same code base as our managed solution, Keygen Cloud, but with
a less frequent release schedule (think of it as an LTS release).
Bug fixes and new features are released to Keygen Cloud several times
per week. Features are battle-tested in Keygen Cloud which allows us to fix
any bugs before the general self-hosted release. Every 6 months, we
combine all the changes into a new self-hosted release.
Keygen CE does lack a few features from Keygen Cloud, which are available
in Keygen EE.
Interested in self-hosting Keygen? Take a look at our [self-hosting docs][self-hosting].
## Self hosting with Keygen EE
Keygen is also enterprise-grade, battle-tested in Keygen Cloud with some of
the best brands in the world. The following features are available in
Keygen Enterprise Edition:
- **Request logs**: keep a historical record of API requests, along with who
made the request, the request body, response body, status code, IP address,
and other information.
- **Event logs**: keep an audit trail of every single event that happens on a
Keygen account.
- **Environments**: manage separate environments within a Keygen account, from
test environments, to a sandbox, to QA, to production.
- **Permissions**: enterprise-grade roles and permissions.
- **SSO/SAML**: support for SSO/SAML coming soon.
Keygen uses Keygen EE in production to run Keygen Cloud, which is used to
license Keygen EE. It's ~~turtles~~ Keygens all the way down (we love
dogfooding our own products).
To obtain a license key, please [reach out][sales].
## Sustainability
Our only sources of funding for Keygen is our premium, managed service for
running Keygen in the Cloud, and Keygen EE. But if you're looking for an
alternative way to support the project, we've put together [some
sponsorship options][sponsor].
If you choose to self-host Keygen CE, you can [become a sponsor][sponsor],
which is a great way to give back to the community and to contribute
to the long-term sustainability of the project.
## Support
Keygen CE is a community supported project and there are **no guarantees** that
you will receive support from the creators of Keygen to troubleshoot your
self-hosting issues. Keygen offers **best-effort** support for Keygen CE. There is [a community-supported Discord server][discord]
and [a forum][forum] where you can ask for help with self-hosting.
If you do need support guantantees, consider becoming a [Keygen Cloud][keygen-cloud]
customer, or [purchasing Keygen EE][sales].
## Developing
### Secrets
To generate a [secret key](https://guides.rubyonrails.org/security.html) for the application, run:
```bash
export SECRET_KEY_BASE="$(openssl rand -hex 64)"
```
To generate [at-work encryption](https://guides.rubyonrails.org/active_record_encryption.html) secrets, run:
```bash
export ENCRYPTION_DETERMINISTIC_KEY="$(openssl rand -base64 32)"
export ENCRYPTION_PRIMARY_KEY="$(openssl rand -base64 32)"
export ENCRYPTION_KEY_DERIVATION_SALT="$(openssl rand -base64 32)"
```
### Setup
To install dependencies, run:
```bash
bundle
```
To setup Keygen, run:
```bash
bundle exec rails keygen:setup
```
### Seeding
To seed the database with sample data, run (optional):
```bash
bundle exec rails db:seed:development
```
### Running
To start the server, run:
```bash
bundle exec rails server
```
To start a worker, run:
```bash
bundle exec sidekiq
```
To start a console, run:
```bash
bundle exec rails console
```
### Testing
To setup the test environment, run:
```bash
bundle exec rake test:setup
```
To run the entire test suite, specs and features, run (takes ~20 mins on a 16-core CPU):
```bash
bundle exec rake test
```
To run Cucumber features, run:
```bash
bundle exec rake test:cucumber
bundle exec rake test:cucumber[features/api/v1/licenses/actions/validations.feature:369]
bundle exec rake test:cucumber[features/api/v1/licenses/actions/validations.feature]
bundle exec rake test:cucumber[features/api/v1/licenses]
```
To run Rspec specs, run:
```bash
bundle exec rake test:rspec
bundle exec rake test:rspec[spec/models/license_spec.rb:199]
bundle exec rake test:rspec[spec/models/license_spec.rb]
bundle exec rake test:rspec[spec/models]
```
## License
Keygen is licensed under the [Elastic License 2.0 (ELv2)](https://github.com/keygen-sh/keygen-api/blob/master/LICENSE.md) license because it provides the best balance between freedom and protection. The ELv2 license is a permissive license that allows you to use, modify, and distribute Keygen as long as you follow a few simple rules:
1. **You may not provide Keygen's API to others as a managed service.** For example, you _cannot_ host Keygen yourself and sell it as a cloud-based licensing service, competing with Keygen Cloud. However, you _can_ sell a product that directly exposes and utilizes Keygen's API, as long as Keygen cannot be used outside of your product for other purposes (such as your customer using an embedded Keygen EE instance to license _their_ product in addition to _your_ product).
1. **You may not circumvent the license key functionality or remove/obscure features protected by license keys.** For example, our code contains [license gates](https://github.com/keygen-sh/keygen-api/blob/ddbeed71543627fc15d37342c937e8bb4ef97157/app/models/environment.rb#L2) that unlock functionality for Keygen EE. You _cannot_ remove or change the licensing code to, for example, unlock a Keygen EE feature in Keygen CE.
1. You may not alter, remove, or obscure any licensing, copyright, or other notices.
Anything else is fair game. There's no clause that requires you to open source modifications made to Keygen or other derivative works.
You can self-host Keygen EE to license your enterprise application.
You can embed Keygen CE in your on-premise application.
You can run Keygen CE on a private network.
You can fork Keygen into a private repo.
If the ELv2 license doesn't work for your company, please [reach out][sales].
The license is available [here](https://keygen.sh/license/).
## Contributing
If you discover an issue, or are interested in a new feature, please open an issue. If you want to contribute code, feel free to open a pull request. If the PR is substantial, it may be beneficial to open an issue beforehand to discuss.
The CLA is available [here](https://keygen.sh/cla/).
## Security
We take security at Keygen very seriously. We perform annual pen-tests on our code base and infrastructure. In addition, we regularly perform code audits. Our most recent pen-test was performed by [Greg Molnar](https://greg.molnar.io/security-consultancy/), an OSCP-certified security researcher in the Ruby and Rails community.
If you believe you've found a vulnerability, please see our [`SECURITY.md`](https://github.com/keygen-sh/keygen-api/blob/master/SECURITY.md) file.
## Is it any good?
[Yes.](https://news.ycombinator.com/item?id=3067434)
[keygen-cloud]: https://keygen.sh
[self-hosting]: https://keygen.sh/docs/self-hosting/
[sponsor]: https://github.com/sponsors/ezekg
[support]: mailto:[email protected]
[discord]: https://discord.gg/TRrhSaWSsN
[forum]: https://github.com/keygen-sh/community/discussions
[contribute]: https://keygen.sh/contrib/
[license]: https://keygen.sh/license/
[sales]: mailto:[email protected]