Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[BUG] [nightly] Personal Access Tokens don't work #24799

Closed
evanferrao opened this issue May 18, 2023 · 2 comments · Fixed by #24767
Closed

[BUG] [nightly] Personal Access Tokens don't work #24799

evanferrao opened this issue May 18, 2023 · 2 comments · Fixed by #24767
Labels
issue/not-a-bug The reported issue is the intended behavior or the problem is not inside Gitea topic/security Something leaks user information or is otherwise vulnerable. Should be fixed!

Comments

@evanferrao
Copy link

Description

On the nightly build of gitea 1e1e8b5, Generating Tokens no longer has scope option. As a result, the generated tokens are useless, and are not able to clone private repositories, etc.

Gitea Version

1e1e8b5 (commit SHA)

Can you reproduce the bug on the Gitea demo site?

No

Log Gist

https://paste.evanferrao.win/raw/lh22z6t

Screenshots

I'm uploading a screen recording instead of a screenshot. It helps to understand way faster.

Gitea.Token.Scope.missing.webm

Git Version

2.40.1, Wire Protocol Version 2 Enabled

Operating System

ZorinOS 16 based on ubuntu 20.04 LTS

How are you running Gitea?

I'm running gitea using docker-compose. I've attached it below.

version: "3"

networks:
  gitea:
    external: false

services:
  server:
    image: gitea/gitea:nightly
    container_name: gitea
    restart: always
    environment:
      - GITEA__log__MODE="console"
      - GITEA__log__ROUTER="console"
      - GITEA__log__LEVEL="debug"
      - GITEA__log__STACKTRACE_LEVEL="debug"
    networks:
      - gitea
    volumes:
      - ./gitea:/data
      - /home/git/.ssh/:/data/git/.ssh
      - /etc/timezone:/etc/timezone:ro
      - /etc/localtime:/etc/localtime:ro
    ports:
      - "127.0.0.1:3000:3000"
      - "127.0.0.1:2222:22"

Database

SQLite

@delvh
Copy link
Member

delvh commented May 18, 2023

Yes, that is intended.
We decided that the original design was not good enough and disabled the UI for it (#24527).
We plan to add a better implementation until the release of 1.20.0-rc0 in about two weeks (#24767)

@delvh delvh added topic/security Something leaks user information or is otherwise vulnerable. Should be fixed! issue/not-a-bug The reported issue is the intended behavior or the problem is not inside Gitea and removed type/bug labels May 18, 2023
@delvh
Copy link
Member

delvh commented May 18, 2023

If I'm not mistaken, it is still possible to create a token with scopes.
However, you need to create the request yourself using the browser console or something similar.

delvh pushed a commit that referenced this issue Jun 4, 2023
## Changes
- Adds the following high level access scopes, each with `read` and
`write` levels:
    - `activitypub`
    - `admin` (hidden if user is not a site admin)
    - `misc`
    - `notification`
    - `organization`
    - `package`
    - `issue`
    - `repository`
    - `user`
- Adds new middleware function `tokenRequiresScopes()` in addition to
`reqToken()`
  -  `tokenRequiresScopes()` is used for each high-level api section
- _if_ a scoped token is present, checks that the required scope is
included based on the section and HTTP method
  - `reqToken()` is used for individual routes
- checks that required authentication is present (but does not check
scope levels as this will already have been handled by
`tokenRequiresScopes()`
- Adds migration to convert old scoped access tokens to the new set of
scopes
- Updates the user interface for scope selection

### User interface example
<img width="903" alt="Screen Shot 2023-05-31 at 1 56 55 PM"
src="https://github.com/go-gitea/gitea/assets/23248839/654766ec-2143-4f59-9037-3b51600e32f3">
<img width="917" alt="Screen Shot 2023-05-31 at 1 56 43 PM"
src="https://github.com/go-gitea/gitea/assets/23248839/1ad64081-012c-4a73-b393-66b30352654c">

## tokenRequiresScopes  Design Decision
- `tokenRequiresScopes()` was added to more reliably cover api routes.
For an incoming request, this function uses the given scope category
(say `AccessTokenScopeCategoryOrganization`) and the HTTP method (say
`DELETE`) and verifies that any scoped tokens in use include
`delete:organization`.
- `reqToken()` is used to enforce auth for individual routes that
require it. If a scoped token is not present for a request,
`tokenRequiresScopes()` will not return an error

## TODO
- [x] Alphabetize scope categories
- [x] Change 'public repos only' to a radio button (private vs public).
Also expand this to organizations
- [X] Disable token creation if no scopes selected. Alternatively, show
warning
- [x] `reqToken()` is missing from many `POST/DELETE` routes in the api.
`tokenRequiresScopes()` only checks that a given token has the correct
scope, `reqToken()` must be used to check that a token (or some other
auth) is present.
   -  _This should be addressed in this PR_
- [x] The migration should be reviewed very carefully in order to
minimize access changes to existing user tokens.
   - _This should be addressed in this PR_
- [x] Link to api to swagger documentation, clarify what
read/write/delete levels correspond to
- [x] Review cases where more than one scope is needed as this directly
deviates from the api definition.
   - _This should be addressed in this PR_
   - For example: 
   ```go
	m.Group("/users/{username}/orgs", func() {
		m.Get("", reqToken(), org.ListUserOrgs)
		m.Get("/{org}/permissions", reqToken(), org.GetUserOrgsPermissions)
}, tokenRequiresScopes(auth_model.AccessTokenScopeCategoryUser,
auth_model.AccessTokenScopeCategoryOrganization),
context_service.UserAssignmentAPI())
   ```

## Future improvements
- [ ] Add required scopes to swagger documentation
- [ ] Redesign `reqToken()` to be opt-out rather than opt-in
- [ ] Subdivide scopes like `repository`
- [ ] Once a token is created, if it has no scopes, we should display
text instead of an empty bullet point
- [ ] If the 'public repos only' option is selected, should read
categories be selected by default

Closes #24501
Closes #24799

Co-authored-by: Jonathan Tran <jon@allspice.io>
Co-authored-by: Kyle D <kdumontnu@gmail.com>
Co-authored-by: silverwind <me@silverwind.io>
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 20, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
issue/not-a-bug The reported issue is the intended behavior or the problem is not inside Gitea topic/security Something leaks user information or is otherwise vulnerable. Should be fixed!
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants