No description
Find a file
Chongyi Zheng de484e86bc
Support scoped access tokens (#20908)
This PR adds the support for scopes of access tokens, mimicking the
design of GitHub OAuth scopes.

The changes of the core logic are in `models/auth` that `AccessToken`
struct will have a `Scope` field. The normalized (no duplication of
scope), comma-separated scope string will be stored in `access_token`
table in the database.
In `services/auth`, the scope will be stored in context, which will be
used by `reqToken` middleware in API calls. Only OAuth2 tokens will have
granular token scopes, while others like BasicAuth will default to scope
`all`.
A large amount of work happens in `routers/api/v1/api.go` and the
corresponding `tests/integration` tests, that is adding necessary scopes
to each of the API calls as they fit.


- [x] Add `Scope` field to `AccessToken`
- [x] Add access control to all API endpoints
- [x] Update frontend & backend for when creating tokens
- [x] Add a database migration for `scope` column (enable 'all' access
to past tokens)

I'm aiming to complete it before Gitea 1.19 release.

Fixes #4300
2023-01-17 15:46:03 -06:00
.gitea Issue template form (#16349) 2021-09-15 20:33:13 +03:00
.github update discord invite (#19907) 2022-06-07 11:40:27 -04:00
assets Add support for incoming emails (#22056) 2023-01-14 23:57:10 +08:00
build Change use of Walk to WalkDir to improve disk performance (#22462) 2023-01-16 16:21:44 +00:00
cmd Improve utils of slices (#22379) 2023-01-11 13:31:16 +08:00
contrib Fixed lint warnings in Grafana raised by Mixtool (#22486) 2023-01-17 10:23:25 -06:00
custom/conf Add cron method to gc LFS MetaObjects (#22385) 2023-01-16 13:50:53 -06:00
docker Remove deprecated DSA host key from Docker Container (#21522) 2022-11-03 19:49:12 +08:00
docs Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
models Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
modules Add cron method to gc LFS MetaObjects (#22385) 2023-01-16 13:50:53 -06:00
options Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
public Update JS dependencies and eslint (#22190) 2022-12-20 17:15:47 -05:00
routers Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
services Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
snap Remove unnecessary whitespace in snapcraft.yaml (#22090) 2022-12-10 08:31:16 -06:00
templates Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
tests Support scoped access tokens (#20908) 2023-01-17 15:46:03 -06:00
tools Move fuzz tests into tests/fuzz (#22376) 2023-01-09 15:30:14 +08:00
web_src Fix environments for KaTeX and error reporting (#22453) 2023-01-16 18:25:46 +08:00
.air.toml Add more test directory to exclude dir of air, remove watching templates from air include dir because gitea has internal mechanism (#22246) 2022-12-27 14:00:34 +08:00
.changelog.yml Changelog for v1.15.0-rc1 (#16422) 2021-07-15 11:47:57 -04:00
.dockerignore Add .dockerignore (#21753) 2022-11-10 04:04:09 +01:00
.drone.yml Add support for incoming emails (#22056) 2023-01-14 23:57:10 +08:00
.editorconfig Add markdownlint (#20512) 2022-07-28 09:22:47 +08:00
.eslintrc.yaml Update JS dependencies and eslint (#22190) 2022-12-20 17:15:47 -05:00
.gitattributes Hook go-licenses into tidy again (#21353) 2022-10-10 20:45:02 +02:00
.gitignore Add go licenses to licenses.txt (#21034) 2022-09-04 00:20:46 +02:00
.gitpod.yml Add sqlite vscode extension to Gitpod configuration (#21552) 2022-10-24 16:55:59 -04:00
.golangci.yml Add more packages to denylist (#22412) 2023-01-12 23:35:53 +08:00
.ignore Add some .ignore entries (#18296) 2022-01-16 17:26:15 +00:00
.lgtm
.markdownlint.yaml Add markdownlint (#20512) 2022-07-28 09:22:47 +08:00
.npmrc
.spectral.yaml Add spectral linter for Swagger (#20321) 2022-07-11 18:07:16 -05:00
.stylelintrc.yaml Move all remaining colors into CSS variables (#21903) 2022-11-23 08:22:27 +08:00
BSDmakefile
build.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
CHANGELOG.md chore: changelog 1.18.1 (#22471) (#22487) 2023-01-17 12:18:22 -06:00
CONTRIBUTING.md Update standard copyright header to use a placeholder year (#22254) 2022-12-27 11:51:23 -06:00
DCO
Dockerfile Update to Alpine 3.17 (#21904) 2022-12-02 11:23:26 -05:00
Dockerfile.rootless Add dumb-init to rootless docker (#21775) 2022-12-04 11:12:06 +00:00
go.mod Add support for incoming emails (#22056) 2023-01-14 23:57:10 +08:00
go.sum Add support for incoming emails (#22056) 2023-01-14 23:57:10 +08:00
LICENSE
main.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
MAINTAINERS Update username (#22147) 2022-12-16 15:11:03 +02:00
Makefile Remove the netgo tag for Windows build (#22467) 2023-01-16 13:29:10 +00:00
package-lock.json Bump json5 from 1.0.1 to 1.0.2 (#22365) 2023-01-08 19:48:00 +08:00
package.json Update JS dependencies and eslint (#22190) 2022-12-20 17:15:47 -05:00
playwright.config.js Update JS dependencies and eslint config (#21388) 2022-10-10 20:02:20 +08:00
README.md Add cynkra bronze sponsor (#21325) 2022-10-13 21:44:04 -04:00
README_ZH.md Refactor Gitpod configuration to improve quick spin up of automated dev environments (#21411) 2022-10-12 12:17:04 -04:00
SECURITY.md Add markdownlint (#20512) 2022-07-28 09:22:47 +08:00
vitest.config.js Update JS dependencies and eslint (#22190) 2022-12-20 17:15:47 -05:00
webpack.config.js Update JS dependencies and eslint (#22190) 2022-12-20 17:15:47 -05:00

Gitea

Gitea - Git with a cup of tea

Contribute with Gitpod

View this document in Chinese

Purpose

The goal of this project is to make the easiest, fastest, and most painless way of setting up a self-hosted Git service.

As Gitea is written in Go, it works across all the platforms and architectures that are supported by Go, including Linux, macOS, and Windows on x86, amd64, ARM and PowerPC architectures. You can try it out using the online demo. This project has been forked from Gogs since November of 2016, but a lot has changed.

Building

From the root of the source tree, run:

TAGS="bindata" make build

or if SQLite support is required:

TAGS="bindata sqlite sqlite_unlock_notify" make build

The build target is split into two sub-targets:

  • make backend which requires Go Stable, required version is defined in go.mod.
  • make frontend which requires Node.js LTS or greater and Internet connectivity to download npm dependencies.

When building from the official source tarballs which include pre-built frontend files, the frontend target will not be triggered, making it possible to build without Node.js and Internet connectivity.

Parallelism (make -j <num>) is not supported.

More info: https://docs.gitea.io/en-us/install-from-source/

Using

./gitea web

NOTE: If you're interested in using our APIs, we have experimental support with documentation.

Contributing

Expected workflow is: Fork -> Patch -> Push -> Pull Request

NOTES:

  1. YOU MUST READ THE CONTRIBUTORS GUIDE BEFORE STARTING TO WORK ON A PULL REQUEST.
  2. If you have found a vulnerability in the project, please write privately to security@gitea.io. Thanks!

Translating

Translations are done through Crowdin. If you want to translate to a new language ask one of the managers in the Crowdin project to add a new language there.

You can also just create an issue for adding a language or ask on discord on the #translation channel. If you need context or find some translation issues, you can leave a comment on the string or ask on Discord. For general translation questions there is a section in the docs. Currently a bit empty but we hope to fill it as questions pop up.

https://docs.gitea.io/en-us/translation-guidelines/

Crowdin

Further information

For more information and instructions about how to install Gitea, please look at our documentation. If you have questions that are not covered by the documentation, you can get in contact with us on our Discord server or create a post in the discourse forum.

We maintain a list of Gitea-related projects at gitea/awesome-gitea.

The Hugo-based documentation theme is hosted at gitea/theme.

The official Gitea CLI is developed at gitea/tea.

Authors

Backers

Thank you to all our backers! 🙏 [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

FAQ

How do you pronounce Gitea?

Gitea is pronounced /ɡɪti:/ as in "gi-tea" with a hard g.

Why is this not hosted on a Gitea instance?

We're working on it.

License

This project is licensed under the MIT License. See the LICENSE file for the full license text.

Screenshots

Looking for an overview of the interface? Check it out!

Dashboard User Profile Global Issues
Branches Web Editor Activity
New Migration Migrating Pull Request View
Pull Request Dark Diff Review Dark Diff Dark