| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786 |
- // Copyright 2015 The Gogs Authors. All rights reserved.
- // Copyright 2016 The Gitea Authors. All rights reserved.
- // SPDX-License-Identifier: MIT
-
- // Package v1 Gitea API
- //
- // This documentation describes the Gitea API.
- //
- // Schemes: https, http
- // License: MIT http://opensource.org/licenses/MIT
- //
- // Consumes:
- // - application/json
- // - text/plain
- //
- // Produces:
- // - application/json
- // - text/html
- //
- // Security:
- // - BasicAuth :
- // - Token :
- // - AccessToken :
- // - AuthorizationHeaderToken :
- // - SudoParam :
- // - SudoHeader :
- // - TOTPHeader :
- //
- // SecurityDefinitions:
- // BasicAuth:
- // type: basic
- // Token:
- // type: apiKey
- // name: token
- // in: query
- // description: This authentication option is deprecated for removal in Gitea 1.23. Please use AuthorizationHeaderToken instead.
- // AccessToken:
- // type: apiKey
- // name: access_token
- // in: query
- // description: This authentication option is deprecated for removal in Gitea 1.23. Please use AuthorizationHeaderToken instead.
- // AuthorizationHeaderToken:
- // type: apiKey
- // name: Authorization
- // in: header
- // description: API tokens must be prepended with "token" followed by a space.
- // SudoParam:
- // type: apiKey
- // name: sudo
- // in: query
- // description: Sudo API request as the user provided as the key. Admin privileges are required.
- // SudoHeader:
- // type: apiKey
- // name: Sudo
- // in: header
- // description: Sudo API request as the user provided as the key. Admin privileges are required.
- // TOTPHeader:
- // type: apiKey
- // name: X-GITEA-OTP
- // in: header
- // description: Must be used in combination with BasicAuth if two-factor authentication is enabled.
- //
- // swagger:meta
- package v1
-
- import (
- gocontext "context"
- "errors"
- "fmt"
- "net/http"
- "strings"
-
- actions_model "code.gitea.io/gitea/models/actions"
- auth_model "code.gitea.io/gitea/models/auth"
- "code.gitea.io/gitea/models/organization"
- "code.gitea.io/gitea/models/perm"
- access_model "code.gitea.io/gitea/models/perm/access"
- repo_model "code.gitea.io/gitea/models/repo"
- "code.gitea.io/gitea/models/unit"
- user_model "code.gitea.io/gitea/models/user"
- "code.gitea.io/gitea/modules/graceful"
- "code.gitea.io/gitea/modules/log"
- "code.gitea.io/gitea/modules/setting"
- api "code.gitea.io/gitea/modules/structs"
- "code.gitea.io/gitea/modules/web"
- "code.gitea.io/gitea/routers/api/v1/activitypub"
- "code.gitea.io/gitea/routers/api/v1/admin"
- "code.gitea.io/gitea/routers/api/v1/misc"
- "code.gitea.io/gitea/routers/api/v1/notify"
- "code.gitea.io/gitea/routers/api/v1/org"
- "code.gitea.io/gitea/routers/api/v1/packages"
- "code.gitea.io/gitea/routers/api/v1/repo"
- "code.gitea.io/gitea/routers/api/v1/settings"
- "code.gitea.io/gitea/routers/api/v1/user"
- "code.gitea.io/gitea/routers/common"
- "code.gitea.io/gitea/services/actions"
- "code.gitea.io/gitea/services/auth"
- "code.gitea.io/gitea/services/context"
- "code.gitea.io/gitea/services/forms"
-
- _ "code.gitea.io/gitea/routers/api/v1/swagger" // for swagger generation
-
- "gitea.com/go-chi/binding"
- "github.com/go-chi/cors"
- )
-
- func sudo() func(ctx *context.APIContext) {
- return func(ctx *context.APIContext) {
- sudo := ctx.FormString("sudo")
- if len(sudo) == 0 {
- sudo = ctx.Req.Header.Get("Sudo")
- }
-
- if len(sudo) > 0 {
- if ctx.IsSigned && ctx.Doer.IsAdmin {
- user, err := user_model.GetUserByName(ctx, sudo)
- if err != nil {
- if user_model.IsErrUserNotExist(err) {
- ctx.APIErrorNotFound()
- } else {
- ctx.APIErrorInternal(err)
- }
- return
- }
- log.Trace("Sudo from (%s) to: %s", ctx.Doer.Name, user.Name)
- ctx.Doer = user
- } else {
- ctx.JSON(http.StatusForbidden, map[string]string{
- "message": "Only administrators allowed to sudo.",
- })
- return
- }
- }
- }
- }
-
- func repoAssignment() func(ctx *context.APIContext) {
- return func(ctx *context.APIContext) {
- userName := ctx.PathParam("username")
- repoName := ctx.PathParam("reponame")
-
- var (
- owner *user_model.User
- err error
- )
-
- // Check if the user is the same as the repository owner.
- if ctx.IsSigned && strings.EqualFold(ctx.Doer.LowerName, userName) {
- owner = ctx.Doer
- } else {
- owner, err = user_model.GetUserByName(ctx, userName)
- if err != nil {
- if user_model.IsErrUserNotExist(err) {
- if redirectUserID, err := user_model.LookupUserRedirect(ctx, userName); err == nil {
- context.RedirectToUser(ctx.Base, userName, redirectUserID)
- } else if user_model.IsErrUserRedirectNotExist(err) {
- ctx.APIErrorNotFound("GetUserByName", err)
- } else {
- ctx.APIErrorInternal(err)
- }
- } else {
- ctx.APIErrorInternal(err)
- }
- return
- }
- }
- ctx.Repo.Owner = owner
- ctx.ContextUser = owner
-
- // Get repository.
- repo, err := repo_model.GetRepositoryByName(ctx, owner.ID, repoName)
- if err != nil {
- if repo_model.IsErrRepoNotExist(err) {
- redirectRepoID, err := repo_model.LookupRedirect(ctx, owner.ID, repoName)
- if err == nil {
- context.RedirectToRepo(ctx.Base, redirectRepoID)
- } else if repo_model.IsErrRedirectNotExist(err) {
- ctx.APIErrorNotFound()
- } else {
- ctx.APIErrorInternal(err)
- }
- } else {
- ctx.APIErrorInternal(err)
- }
- return
- }
-
- repo.Owner = owner
- ctx.Repo.Repository = repo
-
- if ctx.Doer != nil && ctx.Doer.ID == user_model.ActionsUserID {
- taskID := ctx.Data["ActionsTaskID"].(int64)
- task, err := actions_model.GetTaskByID(ctx, taskID)
- if err != nil {
- ctx.APIErrorInternal(err)
- return
- }
- if task.RepoID != repo.ID {
- ctx.APIErrorNotFound()
- return
- }
-
- if task.IsForkPullRequest {
- ctx.Repo.Permission.AccessMode = perm.AccessModeRead
- } else {
- ctx.Repo.Permission.AccessMode = perm.AccessModeWrite
- }
-
- if err := ctx.Repo.Repository.LoadUnits(ctx); err != nil {
- ctx.APIErrorInternal(err)
- return
- }
- ctx.Repo.Permission.SetUnitsWithDefaultAccessMode(ctx.Repo.Repository.Units, ctx.Repo.Permission.AccessMode)
- } else {
- needTwoFactor, err := doerNeedTwoFactorAuth(ctx, ctx.Doer)
- if err != nil {
- ctx.APIErrorInternal(err)
- return
- }
- if needTwoFactor {
- ctx.Repo.Permission = access_model.PermissionNoAccess()
- } else {
- ctx.Repo.Permission, err = access_model.GetUserRepoPermission(ctx, repo, ctx.Doer)
- if err != nil {
- ctx.APIErrorInternal(err)
- return
- }
- }
- }
-
- if !ctx.Repo.Permission.HasAnyUnitAccessOrPublicAccess() {
- ctx.APIErrorNotFound()
- return
- }
- }
- }
-
- func doerNeedTwoFactorAuth(ctx gocontext.Context, doer *user_model.User) (bool, error) {
- if !setting.TwoFactorAuthEnforced {
- return false, nil
- }
- if doer == nil {
- return false, nil
- }
- has, err := auth_model.HasTwoFactorOrWebAuthn(ctx, doer.ID)
- if err != nil {
- return false, err
- }
- return !has, nil
- }
-
- func reqPackageAccess(accessMode perm.AccessMode) func(ctx *context.APIContext) {
- return func(ctx *context.APIContext) {
- if ctx.Package.AccessMode < accessMode && !ctx.IsUserSiteAdmin() {
- ctx.APIError(http.StatusForbidden, "user should have specific permission or be a site admin")
- return
- }
- }
- }
-
- func checkTokenPublicOnly() func(ctx *context.APIContext) {
- return func(ctx *context.APIContext) {
- if !ctx.PublicOnly {
- return
- }
-
- requiredScopeCategories, ok := ctx.Data["requiredScopeCategories"].([]auth_model.AccessTokenScopeCategory)
- if !ok || len(requiredScopeCategories) == 0 {
- return
- }
-
- // public Only permission check
- switch {
- case auth_model.ContainsCategory(requiredScopeCategories, auth_model.AccessTokenScopeCategoryRepository):
- if ctx.Repo.Repository != nil && ctx.Repo.Repository.IsPrivate {
- ctx.APIError(http.StatusForbidden, "token scope is limited to public repos")
- return
- }
- case auth_model.ContainsCategory(requiredScopeCategories, auth_model.AccessTokenScopeCategoryIssue):
- if ctx.Repo.Repository != nil && ctx.Repo.Repository.IsPrivate {
- ctx.APIError(http.StatusForbidden, "token scope is limited to public issues")
- return
- }
- case auth_model.ContainsCategory(requiredScopeCategories, auth_model.AccessTokenScopeCategoryOrganization):
- if ctx.Org.Organization != nil && ctx.Org.Organization.Visibility != api.VisibleTypePublic {
- ctx.APIError(http.StatusForbidden, "token scope is limited to public orgs")
- return
- }
- if ctx.ContextUser != nil && ctx.ContextUser.IsOrganization() && ctx.ContextUser.Visibility != api.VisibleTypePublic {
- ctx.APIError(http.StatusForbidden, "token scope is limited to public orgs")
- return
- }
- case auth_model.ContainsCategory(requiredScopeCategories, auth_model.AccessTokenScopeCategoryUser):
- if ctx.ContextUser != nil && ctx.ContextUser.IsTokenAccessAllowed() && ctx.ContextUser.Visibility != api.VisibleTypePublic {
- ctx.APIError(http.StatusForbidden, "token scope is limited to public users")
- return
- }
- case auth_model.ContainsCategory(requiredScopeCategories, auth_model.AccessTokenScopeCategoryActivityPub):
- if ctx.ContextUser != nil && ctx.ContextUser.IsTokenAccessAllowed() && ctx.ContextUser.Visibility != api.VisibleTypePublic {
- ctx.APIError(http.StatusForbidden, "token scope is limited to public activitypub")
- return
- }
- case auth_model.ContainsCategory(requiredScopeCategories, auth_model.AccessTokenScopeCategoryNotification):
- if ctx.Repo.Repository != nil && ctx.Repo.Repository.IsPrivate {
- ctx.APIError(http.StatusForbidden, "token scope is limited to public notifications")
- return
- }
- case auth_model.ContainsCategory(requiredScopeCategories, auth_model.AccessTokenScopeCategoryPackage):
- if ctx.Package != nil && ctx.Package.Owner.Visibility.IsPrivate() {
- ctx.APIError(http.StatusForbidden, "token scope is limited to public packages")
- return
- }
- }
- }
- }
-
- // if a token is being used for auth, we check that it contains the required scope
- // if a token is not being used, reqToken will enforce other sign in methods
- func tokenRequiresScopes(requiredScopeCategories ...auth_model.AccessTokenScopeCategory) func(ctx *context.APIContext) {
- return func(ctx *context.APIContext) {
- // no scope required
- if len(requiredScopeCategories) == 0 {
- return
- }
-
- // Need OAuth2 token to be present.
- scope, scopeExists := ctx.Data["ApiTokenScope"].(auth_model.AccessTokenScope)
- if ctx.Data["IsApiToken"] != true || !scopeExists {
- return
- }
-
- // use the http method to determine the access level
- requiredScopeLevel := auth_model.Read
- if ctx.Req.Method == http.MethodPost || ctx.Req.Method == http.MethodPut || ctx.Req.Method == http.MethodPatch || ctx.Req.Method == http.MethodDelete {
- requiredScopeLevel = auth_model.Write
- }
-
- // get the required scope for the given access level and category
- requiredScopes := auth_model.GetRequiredScopes(requiredScopeLevel, requiredScopeCategories...)
- allow, err := scope.HasScope(requiredScopes...)
- if err != nil {
- ctx.APIError(http.StatusForbidden, "checking scope failed: "+err.Error())
- return
- }
-
- if !allow {
- ctx.APIError(http.StatusForbidden, fmt.Sprintf("token does not have at least one of required scope(s), required=%v, token scope=%v", requiredScopes, scope))
- return
- }
-
- ctx.Data["requiredScopeCategories"] = requiredScopeCategories
-
- // check if scope only applies to public resources
- publicOnly, err := scope.PublicOnly()
- if err != nil {
- ctx.APIError(http.StatusForbidden, "parsing public resource scope failed: "+err.Error())
- return
- }
-
- // assign to true so that those searching should only filter public repositories/users/organizations
- ctx.PublicOnly = publicOnly
- }
- }
-
- // Contexter middleware already checks token for user sign in process.
- func reqToken() func(ctx *context.APIContext) {
- return func(ctx *context.APIContext) {
- // If actions token is present
- if true == ctx.Data["IsActionsToken"] {
- return
- }
-
- if ctx.IsSigned {
- return
- }
- ctx.APIError(http.StatusUnauthorized, "token is required")
- }
- }
-
- func reqExploreSignIn() func(ctx *context.APIContext) {
- return func(ctx *context.APIContext) {
- if (setting.Service.RequireSignInViewStrict || setting.Service.Explore.RequireSigninView) && !ctx.IsSigned {
- ctx.APIError(http.StatusUnauthorized, "you must be signed in to search for users")
- }
- }
- }
-
- func reqUsersExploreEnabled() func(ctx *context.APIContext) {
- return func(ctx *context.APIContext) {
- if setting.Service.Explore.DisableUsersPage {
- ctx.APIErrorNotFound()
- }
- }
- }
-
- func reqBasicOrRevProxyAuth() func(ctx *context.APIContext) {
- return func(ctx *context.APIContext) {
- if ctx.IsSigned && setting.Service.EnableReverseProxyAuthAPI && ctx.Data["AuthedMethod"].(string) == auth.ReverseProxyMethodName {
- return
- }
- if !ctx.IsBasicAuth {
- ctx.APIError(http.StatusUnauthorized, "auth required")
- return
- }
- }
- }
-
- // reqSiteAdmin user should be the site admin
- func reqSiteAdmin() func(ctx *context.APIContext) {
- return func(ctx *context.APIContext) {
- if !ctx.IsUserSiteAdmin() {
- ctx.APIError(http.StatusForbidden, "user should be the site admin")
- return
- }
- }
- }
-
- // reqOwner user should be the owner of the repo or site admin.
- func reqOwner() func(ctx *context.APIContext) {
- return func(ctx *context.APIContext) {
- if !ctx.Repo.IsOwner() && !ctx.IsUserSiteAdmin() {
- ctx.APIError(http.StatusForbidden, "user should be the owner of the repo")
- return
- }
- }
- }
-
- // reqSelfOrAdmin doer should be the same as the contextUser or site admin
- func reqSelfOrAdmin() func(ctx *context.APIContext) {
- return func(ctx *context.APIContext) {
- if !ctx.IsUserSiteAdmin() && ctx.ContextUser != ctx.Doer {
- ctx.APIError(http.StatusForbidden, "doer should be the site admin or be same as the contextUser")
- return
- }
- }
- }
-
- // reqAdmin user should be an owner or a collaborator with admin write of a repository, or site admin
- func reqAdmin() func(ctx *context.APIContext) {
- return func(ctx *context.APIContext) {
- if !ctx.IsUserRepoAdmin() && !ctx.IsUserSiteAdmin() {
- ctx.APIError(http.StatusForbidden, "user should be an owner or a collaborator with admin write of a repository")
- return
- }
- }
- }
-
- // reqRepoWriter user should have a permission to write to a repo, or be a site admin
- func reqRepoWriter(unitTypes ...unit.Type) func(ctx *context.APIContext) {
- return func(ctx *context.APIContext) {
- if !ctx.IsUserRepoWriter(unitTypes) && !ctx.IsUserRepoAdmin() && !ctx.IsUserSiteAdmin() {
- ctx.APIError(http.StatusForbidden, "user should have a permission to write to a repo")
- return
- }
- }
- }
-
- // reqRepoReader user should have specific read permission or be a repo admin or a site admin
- func reqRepoReader(unitType unit.Type) func(ctx *context.APIContext) {
- return func(ctx *context.APIContext) {
- if !ctx.Repo.CanRead(unitType) && !ctx.IsUserRepoAdmin() && !ctx.IsUserSiteAdmin() {
- ctx.APIError(http.StatusForbidden, "user should have specific read permission or be a repo admin or a site admin")
- return
- }
- }
- }
-
- // reqAnyRepoReader user should have any permission to read repository or permissions of site admin
- func reqAnyRepoReader() func(ctx *context.APIContext) {
- return func(ctx *context.APIContext) {
- if !ctx.Repo.Permission.HasAnyUnitAccess() && !ctx.IsUserSiteAdmin() {
- ctx.APIError(http.StatusForbidden, "user should have any permission to read repository or permissions of site admin")
- return
- }
- }
- }
-
- // reqOrgOwnership user should be an organization owner, or a site admin
- func reqOrgOwnership() func(ctx *context.APIContext) {
- return func(ctx *context.APIContext) {
- if ctx.IsUserSiteAdmin() {
- return
- }
-
- var orgID int64
- if ctx.Org.Organization != nil {
- orgID = ctx.Org.Organization.ID
- } else if ctx.Org.Team != nil {
- orgID = ctx.Org.Team.OrgID
- } else {
- setting.PanicInDevOrTesting("reqOrgOwnership: unprepared context")
- ctx.APIErrorInternal(errors.New("reqOrgOwnership: unprepared context"))
- return
- }
-
- isOwner, err := organization.IsOrganizationOwner(ctx, orgID, ctx.Doer.ID)
- if err != nil {
- ctx.APIErrorInternal(err)
- return
- } else if !isOwner {
- if ctx.Org.Organization != nil {
- ctx.APIError(http.StatusForbidden, "Must be an organization owner")
- } else {
- ctx.APIErrorNotFound()
- }
- return
- }
- }
- }
-
- // reqTeamMembership user should be an team member, or a site admin
- func reqTeamMembership() func(ctx *context.APIContext) {
- return func(ctx *context.APIContext) {
- if ctx.IsUserSiteAdmin() {
- return
- }
- if ctx.Org.Team == nil {
- setting.PanicInDevOrTesting("reqTeamMembership: unprepared context")
- ctx.APIErrorInternal(errors.New("reqTeamMembership: unprepared context"))
- return
- }
-
- orgID := ctx.Org.Team.OrgID
- isOwner, err := organization.IsOrganizationOwner(ctx, orgID, ctx.Doer.ID)
- if err != nil {
- ctx.APIErrorInternal(err)
- return
- } else if isOwner {
- return
- }
-
- if isTeamMember, err := organization.IsTeamMember(ctx, orgID, ctx.Org.Team.ID, ctx.Doer.ID); err != nil {
- ctx.APIErrorInternal(err)
- return
- } else if !isTeamMember {
- isOrgMember, err := organization.IsOrganizationMember(ctx, orgID, ctx.Doer.ID)
- if err != nil {
- ctx.APIErrorInternal(err)
- } else if isOrgMember {
- ctx.APIError(http.StatusForbidden, "Must be a team member")
- } else {
- ctx.APIErrorNotFound()
- }
- return
- }
- }
- }
-
- // reqOrgMembership user should be an organization member, or a site admin
- func reqOrgMembership() func(ctx *context.APIContext) {
- return func(ctx *context.APIContext) {
- if ctx.IsUserSiteAdmin() {
- return
- }
-
- var orgID int64
- if ctx.Org.Organization != nil {
- orgID = ctx.Org.Organization.ID
- } else if ctx.Org.Team != nil {
- orgID = ctx.Org.Team.OrgID
- } else {
- setting.PanicInDevOrTesting("reqOrgMembership: unprepared context")
- ctx.APIErrorInternal(errors.New("reqOrgMembership: unprepared context"))
- return
- }
-
- if isMember, err := organization.IsOrganizationMember(ctx, orgID, ctx.Doer.ID); err != nil {
- ctx.APIErrorInternal(err)
- return
- } else if !isMember {
- if ctx.Org.Organization != nil {
- ctx.APIError(http.StatusForbidden, "Must be an organization member")
- } else {
- ctx.APIErrorNotFound()
- }
- return
- }
- }
- }
-
- func reqGitHook() func(ctx *context.APIContext) {
- return func(ctx *context.APIContext) {
- if !ctx.Doer.CanEditGitHook() {
- ctx.APIError(http.StatusForbidden, "must be allowed to edit Git hooks")
- return
- }
- }
- }
-
- // reqWebhooksEnabled requires webhooks to be enabled by admin.
- func reqWebhooksEnabled() func(ctx *context.APIContext) {
- return func(ctx *context.APIContext) {
- if setting.DisableWebhooks {
- ctx.APIError(http.StatusForbidden, "webhooks disabled by administrator")
- return
- }
- }
- }
-
- // reqStarsEnabled requires Starring to be enabled in the config.
- func reqStarsEnabled() func(ctx *context.APIContext) {
- return func(ctx *context.APIContext) {
- if setting.Repository.DisableStars {
- ctx.APIError(http.StatusForbidden, "stars disabled by administrator")
- return
- }
- }
- }
-
- func orgAssignment(args ...bool) func(ctx *context.APIContext) {
- var (
- assignOrg bool
- assignTeam bool
- )
- if len(args) > 0 {
- assignOrg = args[0]
- }
- if len(args) > 1 {
- assignTeam = args[1]
- }
- return func(ctx *context.APIContext) {
- ctx.Org = new(context.APIOrganization)
-
- var err error
- if assignOrg {
- ctx.Org.Organization, err = organization.GetOrgByName(ctx, ctx.PathParam("org"))
- if err != nil {
- if organization.IsErrOrgNotExist(err) {
- redirectUserID, err := user_model.LookupUserRedirect(ctx, ctx.PathParam("org"))
- if err == nil {
- context.RedirectToUser(ctx.Base, ctx.PathParam("org"), redirectUserID)
- } else if user_model.IsErrUserRedirectNotExist(err) {
- ctx.APIErrorNotFound("GetOrgByName", err)
- } else {
- ctx.APIErrorInternal(err)
- }
- } else {
- ctx.APIErrorInternal(err)
- }
- return
- }
- ctx.ContextUser = ctx.Org.Organization.AsUser()
- }
-
- if assignTeam {
- ctx.Org.Team, err = organization.GetTeamByID(ctx, ctx.PathParamInt64("teamid"))
- if err != nil {
- if organization.IsErrTeamNotExist(err) {
- ctx.APIErrorNotFound()
- } else {
- ctx.APIErrorInternal(err)
- }
- return
- }
- }
- }
- }
-
- func mustEnableIssues(ctx *context.APIContext) {
- if !ctx.Repo.CanRead(unit.TypeIssues) {
- if log.IsTrace() {
- if ctx.IsSigned {
- log.Trace("Permission Denied: User %-v cannot read %-v in Repo %-v\n"+
- "User in Repo has Permissions: %-+v",
- ctx.Doer,
- unit.TypeIssues,
- ctx.Repo.Repository,
- ctx.Repo.Permission)
- } else {
- log.Trace("Permission Denied: Anonymous user cannot read %-v in Repo %-v\n"+
- "Anonymous user in Repo has Permissions: %-+v",
- unit.TypeIssues,
- ctx.Repo.Repository,
- ctx.Repo.Permission)
- }
- }
- ctx.APIErrorNotFound()
- return
- }
- }
-
- func mustAllowPulls(ctx *context.APIContext) {
- if !(ctx.Repo.Repository.CanEnablePulls() && ctx.Repo.CanRead(unit.TypePullRequests)) {
- if ctx.Repo.Repository.CanEnablePulls() && log.IsTrace() {
- if ctx.IsSigned {
- log.Trace("Permission Denied: User %-v cannot read %-v in Repo %-v\n"+
- "User in Repo has Permissions: %-+v",
- ctx.Doer,
- unit.TypePullRequests,
- ctx.Repo.Repository,
- ctx.Repo.Permission)
- } else {
- log.Trace("Permission Denied: Anonymous user cannot read %-v in Repo %-v\n"+
- "Anonymous user in Repo has Permissions: %-+v",
- unit.TypePullRequests,
- ctx.Repo.Repository,
- ctx.Repo.Permission)
- }
- }
- ctx.APIErrorNotFound()
- return
- }
- }
-
- func mustEnableIssuesOrPulls(ctx *context.APIContext) {
- if !ctx.Repo.CanRead(unit.TypeIssues) &&
- !(ctx.Repo.Repository.CanEnablePulls() && ctx.Repo.CanRead(unit.TypePullRequests)) {
- if ctx.Repo.Repository.CanEnablePulls() && log.IsTrace() {
- if ctx.IsSigned {
- log.Trace("Permission Denied: User %-v cannot read %-v and %-v in Repo %-v\n"+
- "User in Repo has Permissions: %-+v",
- ctx.Doer,
- unit.TypeIssues,
- unit.TypePullRequests,
- ctx.Repo.Repository,
- ctx.Repo.Permission)
- } else {
- log.Trace("Permission Denied: Anonymous user cannot read %-v and %-v in Repo %-v\n"+
- "Anonymous user in Repo has Permissions: %-+v",
- unit.TypeIssues,
- unit.TypePullRequests,
- ctx.Repo.Repository,
- ctx.Repo.Permission)
- }
- }
- ctx.APIErrorNotFound()
- return
- }
- }
-
- func mustEnableWiki(ctx *context.APIContext) {
- if !(ctx.Repo.CanRead(unit.TypeWiki)) {
- ctx.APIErrorNotFound()
- return
- }
- }
-
- // FIXME: for consistency, maybe most mustNotBeArchived checks should be replaced with mustEnableEditor
- func mustNotBeArchived(ctx *context.APIContext) {
- if ctx.Repo.Repository.IsArchived {
- ctx.APIError(http.StatusLocked, fmt.Errorf("%s is archived", ctx.Repo.Repository.FullName()))
- return
- }
- }
-
- func mustEnableEditor(ctx *context.APIContext) {
- if !ctx.Repo.Repository.CanEnableEditor() {
- ctx.APIError(http.StatusLocked, fmt.Errorf("%s is not allowed to edit", ctx.Repo.Repository.FullName()))
- return
- }
- }
-
- func mustEnableAttachments(ctx *context.APIContext) {
- if !setting.Attachment.Enabled {
- ctx.APIErrorNotFound()
- return
- }
- }
-
- // bind binding an obj to a func(ctx *context.APIContext)
- func bind[T any](_ T) any {
- return func(ctx *context.APIContext) {
- theObj := new(T) // create a new form obj for every request but not use obj directly
- errs := binding.Bind(ctx.Req, theObj)
- if len(errs) > 0 {
- ctx.APIError(http.StatusUnprocessableEntity, fmt.Sprintf("%s: %s", errs[0].FieldNames, errs[0].Error()))
- return
- }
- web.SetForm(ctx, theObj)
- }
- }
-
- func buildAuthGroup() *auth.Group {
- group := auth.NewGroup(
- &auth.OAuth2{},
- &auth.HTTPSign{},
- &auth.Basic{}, // FIXME: this should be removed once we don't allow basic auth in API
- )
- if setting.Service.EnableReverseProxyAuthAPI {
- group.Add(&auth.ReverseProxy{})
- }
-
- if setting.IsWindows && auth_model.IsSSPIEnabled(graceful.GetManager().ShutdownContext()) {
- group.Add(&auth.SSPI{}) // it MUST be the last, see the comment of SSPI
- }
-
- return group
- }
-
- func apiAuth(authMethod auth.Method) func(*context.APIContext) {
- return func(ctx *context.APIContext) {
- ar, err := common.AuthShared(ctx.Base, nil, authMethod)
- if err != nil {
- ctx.APIError(http.StatusUnauthorized, err)
- return
- }
- ctx.Doer = ar.Doer
- ctx.IsSigned = ar.Doer != nil
- ctx.IsBasicAuth = ar.IsBasicAuth
- }
- }
-
- // verifyAuthWithOptions checks authentication according to options
- func verifyAuthWithOptions(options *common.VerifyOptions) func(ctx *context.APIContext) {
- return func(ctx *context.APIContext) {
- // Check prohibit login users.
- if ctx.IsSigned {
- if !ctx.Doer.IsActive && setting.Service.RegisterEmailConfirm {
- ctx.Data["Title"] = ctx.Tr("auth.active_your_account")
- ctx.JSON(http.StatusForbidden, map[string]string{
- "message": "This account is not activated.",
- })
- return
- }
- if !ctx.Doer.IsActive || ctx.Doer.ProhibitLogin {
- log.Info("Failed authentication attempt for %s from %s", ctx.Doer.Name, ctx.RemoteAddr())
- ctx.Data["Title"] = ctx.Tr("auth.prohibit_login")
- ctx.JSON(http.StatusForbidden, map[string]string{
- "message": "This account is prohibited from signing in, please contact your site administrator.",
- })
- return
- }
-
- if ctx.Doer.MustChangePassword {
- ctx.JSON(http.StatusForbidden, map[string]string{
- "message": "You must change your password. Change it at: " + setting.AppURL + "/user/change_password",
- })
- return
- }
- }
-
- // Redirect to dashboard if user tries to visit any non-login page.
- if options.SignOutRequired && ctx.IsSigned && ctx.Req.URL.RequestURI() != "/" {
- ctx.Redirect(setting.AppSubURL + "/")
- return
- }
-
- if options.SignInRequired {
- if !ctx.IsSigned {
- // Restrict API calls with error message.
- ctx.JSON(http.StatusForbidden, map[string]string{
- "message": "Only signed in user is allowed to call APIs.",
- })
- return
- } else if !ctx.Doer.IsActive && setting.Service.RegisterEmailConfirm {
- ctx.Data["Title"] = ctx.Tr("auth.active_your_account")
- ctx.JSON(http.StatusForbidden, map[string]string{
- "message": "This account is not activated.",
- })
- return
- }
- }
-
- if options.AdminRequired {
- if !ctx.Doer.IsAdmin {
- ctx.JSON(http.StatusForbidden, map[string]string{
- "message": "You have no permission to request for this.",
- })
- return
- }
- }
- }
- }
-
- func individualPermsChecker(ctx *context.APIContext) {
- // org permissions have been checked in context.OrgAssignment(), but individual permissions haven't been checked.
- if ctx.ContextUser.IsIndividual() {
- switch ctx.ContextUser.Visibility {
- case api.VisibleTypePrivate:
- if ctx.Doer == nil || (ctx.ContextUser.ID != ctx.Doer.ID && !ctx.Doer.IsAdmin) {
- ctx.APIErrorNotFound("Visit Project", nil)
- return
- }
- case api.VisibleTypeLimited:
- if ctx.Doer == nil {
- ctx.APIErrorNotFound("Visit Project", nil)
- return
- }
- }
- }
- }
-
- // check for and warn against deprecated authentication options
- func checkDeprecatedAuthMethods(ctx *context.APIContext) {
- if ctx.FormString("token") != "" || ctx.FormString("access_token") != "" {
- ctx.Resp.Header().Set("X-Gitea-Warning", "token and access_token API authentication is deprecated and will be removed in gitea 1.23. Please use AuthorizationHeaderToken instead. Existing queries will continue to work but without authorization.")
- }
- }
-
- // Routes registers all v1 APIs routes to web application.
- func Routes() *web.Router {
- m := web.NewRouter()
-
- m.Use(securityHeaders())
- if setting.CORSConfig.Enabled {
- m.Use(cors.Handler(cors.Options{
- AllowedOrigins: setting.CORSConfig.AllowDomain,
- AllowedMethods: setting.CORSConfig.Methods,
- AllowCredentials: setting.CORSConfig.AllowCredentials,
- AllowedHeaders: append([]string{"Authorization", "X-Gitea-OTP"}, setting.CORSConfig.Headers...),
- MaxAge: int(setting.CORSConfig.MaxAge.Seconds()),
- }))
- }
- m.Use(context.APIContexter())
-
- m.Use(checkDeprecatedAuthMethods)
-
- // Get user from session if logged in.
- m.Use(apiAuth(buildAuthGroup()))
-
- m.Use(verifyAuthWithOptions(&common.VerifyOptions{
- SignInRequired: setting.Service.RequireSignInViewStrict,
- }))
-
- addActionsRoutes := func(
- m *web.Router,
- reqChecker func(ctx *context.APIContext),
- act actions.API,
- ) {
- m.Group("/actions", func() {
- m.Group("/secrets", func() {
- m.Get("", reqToken(), reqChecker, act.ListActionsSecrets)
- m.Combo("/{secretname}").
- Put(reqToken(), reqChecker, bind(api.CreateOrUpdateSecretOption{}), act.CreateOrUpdateSecret).
- Delete(reqToken(), reqChecker, act.DeleteSecret)
- })
-
- m.Group("/variables", func() {
- m.Get("", reqToken(), reqChecker, act.ListVariables)
- m.Combo("/{variablename}").
- Get(reqToken(), reqChecker, act.GetVariable).
- Delete(reqToken(), reqChecker, act.DeleteVariable).
- Post(reqToken(), reqChecker, bind(api.CreateVariableOption{}), act.CreateVariable).
- Put(reqToken(), reqChecker, bind(api.UpdateVariableOption{}), act.UpdateVariable)
- })
-
- m.Group("/runners", func() {
- m.Get("", reqToken(), reqChecker, act.ListRunners)
- m.Get("/registration-token", reqToken(), reqChecker, act.GetRegistrationToken)
- m.Post("/registration-token", reqToken(), reqChecker, act.CreateRegistrationToken)
- m.Get("/{runner_id}", reqToken(), reqChecker, act.GetRunner)
- m.Delete("/{runner_id}", reqToken(), reqChecker, act.DeleteRunner)
- })
- m.Get("/runs", reqToken(), reqChecker, act.ListWorkflowRuns)
- m.Get("/jobs", reqToken(), reqChecker, act.ListWorkflowJobs)
- })
- }
-
- m.Group("", func() {
- // Miscellaneous (no scope required)
- if setting.API.EnableSwagger {
- m.Get("/swagger", func(ctx *context.APIContext) {
- ctx.Redirect(setting.AppSubURL + "/api/swagger")
- })
- }
-
- if setting.Federation.Enabled {
- m.Get("/nodeinfo", misc.NodeInfo)
- m.Group("/activitypub", func() {
- // deprecated, remove in 1.20, use /user-id/{user-id} instead
- m.Group("/user/{username}", func() {
- m.Get("", activitypub.Person)
- m.Post("/inbox", activitypub.ReqHTTPSignature(), activitypub.PersonInbox)
- }, context.UserAssignmentAPI(), checkTokenPublicOnly())
- m.Group("/user-id/{user-id}", func() {
- m.Get("", activitypub.Person)
- m.Post("/inbox", activitypub.ReqHTTPSignature(), activitypub.PersonInbox)
- }, context.UserIDAssignmentAPI(), checkTokenPublicOnly())
- }, tokenRequiresScopes(auth_model.AccessTokenScopeCategoryActivityPub))
- }
-
- // Misc (public accessible)
- m.Group("", func() {
- m.Get("/version", misc.Version)
- m.Get("/signing-key.gpg", misc.SigningKeyGPG)
- m.Get("/signing-key.pub", misc.SigningKeySSH)
- m.Post("/markup", reqToken(), bind(api.MarkupOption{}), misc.Markup)
- m.Post("/markdown", reqToken(), bind(api.MarkdownOption{}), misc.Markdown)
- m.Post("/markdown/raw", reqToken(), misc.MarkdownRaw)
- m.Get("/gitignore/templates", misc.ListGitignoresTemplates)
- m.Get("/gitignore/templates/{name}", misc.GetGitignoreTemplateInfo)
- m.Get("/licenses", misc.ListLicenseTemplates)
- m.Get("/licenses/{name}", misc.GetLicenseTemplateInfo)
- m.Get("/label/templates", misc.ListLabelTemplates)
- m.Get("/label/templates/{name}", misc.GetLabelTemplate)
-
- m.Group("/settings", func() {
- m.Get("/ui", settings.GetGeneralUISettings)
- m.Get("/api", settings.GetGeneralAPISettings)
- m.Get("/attachment", settings.GetGeneralAttachmentSettings)
- m.Get("/repository", settings.GetGeneralRepoSettings)
- })
- })
-
- // Notifications (requires 'notifications' scope)
- m.Group("/notifications", func() {
- m.Combo("").
- Get(reqToken(), notify.ListNotifications).
- Put(reqToken(), notify.ReadNotifications)
- m.Get("/new", reqToken(), notify.NewAvailable)
- m.Combo("/threads/{id}").
- Get(reqToken(), notify.GetThread).
- Patch(reqToken(), notify.ReadThread)
- }, tokenRequiresScopes(auth_model.AccessTokenScopeCategoryNotification))
-
- // Users (requires user scope)
- m.Group("/users", func() {
- m.Get("/search", reqExploreSignIn(), reqUsersExploreEnabled(), user.Search)
-
- m.Group("/{username}", func() {
- m.Get("", reqExploreSignIn(), user.GetInfo)
-
- if setting.Service.EnableUserHeatmap {
- m.Get("/heatmap", user.GetUserHeatmapData)
- }
-
- m.Get("/repos", tokenRequiresScopes(auth_model.AccessTokenScopeCategoryRepository), reqExploreSignIn(), user.ListUserRepos)
- m.Group("/tokens", func() {
- m.Combo("").Get(user.ListAccessTokens).
- Post(bind(api.CreateAccessTokenOption{}), reqToken(), user.CreateAccessToken)
- m.Combo("/{id}").Delete(reqToken(), user.DeleteAccessToken)
- }, reqSelfOrAdmin(), reqBasicOrRevProxyAuth())
-
- m.Get("/activities/feeds", user.ListUserActivityFeeds)
- }, context.UserAssignmentAPI(), checkTokenPublicOnly(), individualPermsChecker)
- }, tokenRequiresScopes(auth_model.AccessTokenScopeCategoryUser))
-
- // Users (requires user scope)
- m.Group("/users", func() {
- m.Group("/{username}", func() {
- m.Get("/keys", user.ListPublicKeys)
- m.Get("/gpg_keys", user.ListGPGKeys)
-
- m.Get("/followers", user.ListFollowers)
- m.Group("/following", func() {
- m.Get("", user.ListFollowing)
- m.Get("/{target}", user.CheckFollowing)
- })
-
- m.Get("/starred", reqStarsEnabled(), user.GetStarredRepos)
-
- m.Get("/subscriptions", user.GetWatchedRepos)
- }, context.UserAssignmentAPI(), checkTokenPublicOnly())
- }, tokenRequiresScopes(auth_model.AccessTokenScopeCategoryUser), reqToken())
-
- // Users (requires user scope)
- m.Group("/user", func() {
- m.Get("", user.GetAuthenticatedUser)
- m.Group("/settings", func() {
- m.Get("", user.GetUserSettings)
- m.Patch("", bind(api.UserSettingsOptions{}), user.UpdateUserSettings)
- }, reqToken())
- m.Combo("/emails").
- Get(user.ListEmails).
- Post(bind(api.CreateEmailOption{}), user.AddEmail).
- Delete(bind(api.DeleteEmailOption{}), user.DeleteEmail)
-
- // manage user-level actions features
- m.Group("/actions", func() {
- m.Group("/secrets", func() {
- m.Combo("/{secretname}").
- Put(bind(api.CreateOrUpdateSecretOption{}), user.CreateOrUpdateSecret).
- Delete(user.DeleteSecret)
- })
-
- m.Group("/variables", func() {
- m.Get("", user.ListVariables)
- m.Combo("/{variablename}").
- Get(user.GetVariable).
- Delete(user.DeleteVariable).
- Post(bind(api.CreateVariableOption{}), user.CreateVariable).
- Put(bind(api.UpdateVariableOption{}), user.UpdateVariable)
- })
-
- m.Group("/runners", func() {
- m.Get("", reqToken(), user.ListRunners)
- m.Get("/registration-token", reqToken(), user.GetRegistrationToken)
- m.Post("/registration-token", reqToken(), user.CreateRegistrationToken)
- m.Get("/{runner_id}", reqToken(), user.GetRunner)
- m.Delete("/{runner_id}", reqToken(), user.DeleteRunner)
- })
-
- m.Get("/runs", reqToken(), user.ListWorkflowRuns)
- m.Get("/jobs", reqToken(), user.ListWorkflowJobs)
- })
-
- m.Get("/followers", user.ListMyFollowers)
- m.Group("/following", func() {
- m.Get("", user.ListMyFollowing)
- m.Group("/{username}", func() {
- m.Get("", user.CheckMyFollowing)
- m.Put("", user.Follow)
- m.Delete("", user.Unfollow)
- }, context.UserAssignmentAPI())
- })
-
- // (admin:public_key scope)
- m.Group("/keys", func() {
- m.Combo("").Get(user.ListMyPublicKeys).
- Post(bind(api.CreateKeyOption{}), user.CreatePublicKey)
- m.Combo("/{id}").Get(user.GetPublicKey).
- Delete(user.DeletePublicKey)
- })
-
- // (admin:application scope)
- m.Group("/applications", func() {
- m.Combo("/oauth2").
- Get(user.ListOauth2Applications).
- Post(bind(api.CreateOAuth2ApplicationOptions{}), user.CreateOauth2Application)
- m.Combo("/oauth2/{id}").
- Delete(user.DeleteOauth2Application).
- Patch(bind(api.CreateOAuth2ApplicationOptions{}), user.UpdateOauth2Application).
- Get(user.GetOauth2Application)
- })
-
- // (admin:gpg_key scope)
- m.Group("/gpg_keys", func() {
- m.Combo("").Get(user.ListMyGPGKeys).
- Post(bind(api.CreateGPGKeyOption{}), user.CreateGPGKey)
- m.Combo("/{id}").Get(user.GetGPGKey).
- Delete(user.DeleteGPGKey)
- })
- m.Get("/gpg_key_token", user.GetVerificationToken)
- m.Post("/gpg_key_verify", bind(api.VerifyGPGKeyOption{}), user.VerifyUserGPGKey)
-
- // (repo scope)
- m.Combo("/repos", tokenRequiresScopes(auth_model.AccessTokenScopeCategoryRepository)).Get(user.ListMyRepos).
- Post(bind(api.CreateRepoOption{}), repo.Create)
-
- // (repo scope)
- m.Group("/starred", func() {
- m.Get("", user.GetMyStarredRepos)
- m.Group("/{username}/{reponame}", func() {
- m.Get("", user.IsStarring)
- m.Put("", user.Star)
- m.Delete("", user.Unstar)
- }, repoAssignment(), checkTokenPublicOnly())
- }, reqStarsEnabled(), tokenRequiresScopes(auth_model.AccessTokenScopeCategoryRepository))
- m.Get("/times", repo.ListMyTrackedTimes)
- m.Get("/stopwatches", repo.GetStopwatches)
- m.Get("/subscriptions", user.GetMyWatchedRepos)
- m.Get("/teams", org.ListUserTeams)
- m.Group("/hooks", func() {
- m.Combo("").Get(user.ListHooks).
- Post(bind(api.CreateHookOption{}), user.CreateHook)
- m.Combo("/{id}").Get(user.GetHook).
- Patch(bind(api.EditHookOption{}), user.EditHook).
- Delete(user.DeleteHook)
- }, reqWebhooksEnabled())
-
- m.Group("/avatar", func() {
- m.Post("", bind(api.UpdateUserAvatarOption{}), user.UpdateAvatar)
- m.Delete("", user.DeleteAvatar)
- })
-
- m.Group("/blocks", func() {
- m.Get("", user.ListBlocks)
- m.Group("/{username}", func() {
- m.Get("", user.CheckUserBlock)
- m.Put("", user.BlockUser)
- m.Delete("", user.UnblockUser)
- }, context.UserAssignmentAPI(), checkTokenPublicOnly())
- })
- }, tokenRequiresScopes(auth_model.AccessTokenScopeCategoryUser), reqToken())
-
- // Repositories (requires repo scope, org scope)
- m.Post("/org/{org}/repos",
- // FIXME: we need org in context
- tokenRequiresScopes(auth_model.AccessTokenScopeCategoryOrganization, auth_model.AccessTokenScopeCategoryRepository),
- reqToken(),
- bind(api.CreateRepoOption{}),
- repo.CreateOrgRepoDeprecated)
-
- // requires repo scope
- // FIXME: Don't expose repository id outside of the system
- m.Combo("/repositories/{id}", reqToken(), tokenRequiresScopes(auth_model.AccessTokenScopeCategoryRepository)).Get(repo.GetByID)
-
- // Repos (requires repo scope)
- m.Group("/repos", func() {
- m.Get("/search", repo.Search)
-
- // (repo scope)
- m.Post("/migrate", reqToken(), bind(api.MigrateRepoOptions{}), repo.Migrate)
-
- m.Group("/{username}/{reponame}", func() {
- m.Get("/compare/*", reqRepoReader(unit.TypeCode), repo.CompareDiff)
-
- m.Combo("").Get(reqAnyRepoReader(), repo.Get).
- Delete(reqToken(), reqOwner(), repo.Delete).
- Patch(reqToken(), reqAdmin(), bind(api.EditRepoOption{}), repo.Edit)
- m.Post("/generate", reqToken(), reqRepoReader(unit.TypeCode), bind(api.GenerateRepoOption{}), repo.Generate)
- m.Group("/transfer", func() {
- m.Post("", reqOwner(), bind(api.TransferRepoOption{}), repo.Transfer)
- m.Post("/accept", repo.AcceptTransfer)
- m.Post("/reject", repo.RejectTransfer)
- }, reqToken())
-
- addActionsRoutes(m, reqOwner(), repo.NewAction()) // it adds the routes for secrets/variables and runner management
-
- m.Group("/actions/workflows", func() {
- m.Get("", repo.ActionsListRepositoryWorkflows)
- m.Get("/{workflow_id}", repo.ActionsGetWorkflow)
- m.Put("/{workflow_id}/disable", reqRepoWriter(unit.TypeActions), repo.ActionsDisableWorkflow)
- m.Put("/{workflow_id}/enable", reqRepoWriter(unit.TypeActions), repo.ActionsEnableWorkflow)
- m.Post("/{workflow_id}/dispatches", reqRepoWriter(unit.TypeActions), bind(api.CreateActionWorkflowDispatch{}), repo.ActionsDispatchWorkflow)
- }, context.ReferencesGitRepo(), reqToken(), reqRepoReader(unit.TypeActions))
-
- m.Group("/actions/jobs", func() {
- m.Get("/{job_id}", repo.GetWorkflowJob)
- m.Get("/{job_id}/logs", repo.DownloadActionsRunJobLogs)
- }, reqToken(), reqRepoReader(unit.TypeActions))
-
- m.Group("/hooks/git", func() {
- m.Combo("").Get(repo.ListGitHooks)
- m.Group("/{id}", func() {
- m.Combo("").Get(repo.GetGitHook).
- Patch(bind(api.EditGitHookOption{}), repo.EditGitHook).
- Delete(repo.DeleteGitHook)
- })
- }, reqToken(), reqAdmin(), reqGitHook(), context.ReferencesGitRepo(true))
- m.Group("/hooks", func() {
- m.Combo("").Get(repo.ListHooks).
- Post(bind(api.CreateHookOption{}), repo.CreateHook)
- m.Group("/{id}", func() {
- m.Combo("").Get(repo.GetHook).
- Patch(bind(api.EditHookOption{}), repo.EditHook).
- Delete(repo.DeleteHook)
- m.Post("/tests", context.ReferencesGitRepo(), context.RepoRefForAPI, repo.TestHook)
- })
- }, reqToken(), reqAdmin(), reqWebhooksEnabled())
- m.Group("/collaborators", func() {
- m.Get("", reqAnyRepoReader(), repo.ListCollaborators)
- m.Group("/{collaborator}", func() {
- m.Combo("").Get(reqAnyRepoReader(), repo.IsCollaborator).
- Put(reqAdmin(), bind(api.AddCollaboratorOption{}), repo.AddOrUpdateCollaborator).
- Delete(reqAdmin(), repo.DeleteCollaborator)
- m.Get("/permission", repo.GetRepoPermissions)
- })
- }, reqToken())
- m.Get("/assignees", reqToken(), reqAnyRepoReader(), repo.GetAssignees)
- m.Get("/reviewers", reqToken(), reqAnyRepoReader(), repo.GetReviewers)
- m.Group("/teams", func() {
- m.Get("", reqAnyRepoReader(), repo.ListTeams)
- m.Combo("/{team}").Get(reqAnyRepoReader(), repo.IsTeam).
- Put(reqAdmin(), repo.AddTeam).
- Delete(reqAdmin(), repo.DeleteTeam)
- }, reqToken())
- m.Get("/raw/*", context.ReferencesGitRepo(), context.RepoRefForAPI, reqRepoReader(unit.TypeCode), repo.GetRawFile)
- m.Get("/media/*", context.ReferencesGitRepo(), context.RepoRefForAPI, reqRepoReader(unit.TypeCode), repo.GetRawFileOrLFS)
- m.Methods("HEAD,GET", "/archive/*", reqRepoReader(unit.TypeCode), context.ReferencesGitRepo(true), repo.GetArchive)
- m.Combo("/forks").Get(repo.ListForks).
- Post(reqToken(), reqRepoReader(unit.TypeCode), bind(api.CreateForkOption{}), repo.CreateFork)
- m.Post("/merge-upstream", reqToken(), mustNotBeArchived, reqRepoWriter(unit.TypeCode), bind(api.MergeUpstreamRequest{}), repo.MergeUpstream)
- m.Group("/branches", func() {
- m.Get("", repo.ListBranches)
- m.Get("/*", repo.GetBranch)
- m.Delete("/*", reqToken(), reqRepoWriter(unit.TypeCode), mustNotBeArchived, repo.DeleteBranch)
- m.Post("", reqToken(), reqRepoWriter(unit.TypeCode), mustNotBeArchived, bind(api.CreateBranchRepoOption{}), repo.CreateBranch)
- m.Patch("/*", reqToken(), reqRepoWriter(unit.TypeCode), mustNotBeArchived, bind(api.RenameBranchRepoOption{}), repo.RenameBranch)
- }, context.ReferencesGitRepo(), reqRepoReader(unit.TypeCode))
- m.Group("/branch_protections", func() {
- m.Get("", repo.ListBranchProtections)
- m.Post("", bind(api.CreateBranchProtectionOption{}), mustNotBeArchived, repo.CreateBranchProtection)
- m.Group("/{name}", func() {
- m.Get("", repo.GetBranchProtection)
- m.Patch("", bind(api.EditBranchProtectionOption{}), mustNotBeArchived, repo.EditBranchProtection)
- m.Delete("", repo.DeleteBranchProtection)
- })
- m.Post("/priority", bind(api.UpdateBranchProtectionPriories{}), mustNotBeArchived, repo.UpdateBranchProtectionPriories)
- }, reqToken(), reqAdmin())
- m.Group("/tags", func() {
- m.Get("", repo.ListTags)
- m.Get("/*", repo.GetTag)
- m.Post("", reqToken(), reqRepoWriter(unit.TypeCode), mustNotBeArchived, bind(api.CreateTagOption{}), repo.CreateTag)
- m.Delete("/*", reqToken(), reqRepoWriter(unit.TypeCode), mustNotBeArchived, repo.DeleteTag)
- }, reqRepoReader(unit.TypeCode), context.ReferencesGitRepo(true))
- m.Group("/tag_protections", func() {
- m.Combo("").Get(repo.ListTagProtection).
- Post(bind(api.CreateTagProtectionOption{}), mustNotBeArchived, repo.CreateTagProtection)
- m.Group("/{id}", func() {
- m.Combo("").Get(repo.GetTagProtection).
- Patch(bind(api.EditTagProtectionOption{}), mustNotBeArchived, repo.EditTagProtection).
- Delete(repo.DeleteTagProtection)
- })
- }, reqToken(), reqAdmin())
- m.Group("/actions", func() {
- m.Get("/tasks", repo.ListActionTasks)
- m.Group("/runs", func() {
- m.Group("/{run}", func() {
- m.Get("", repo.GetWorkflowRun)
- m.Delete("", reqToken(), reqRepoWriter(unit.TypeActions), repo.DeleteActionRun)
- m.Get("/jobs", repo.ListWorkflowRunJobs)
- m.Get("/artifacts", repo.GetArtifactsOfRun)
- })
- })
- m.Get("/artifacts", repo.GetArtifacts)
- m.Group("/artifacts/{artifact_id}", func() {
- m.Get("", repo.GetArtifact)
- m.Delete("", reqRepoWriter(unit.TypeActions), repo.DeleteArtifact)
- })
- m.Get("/artifacts/{artifact_id}/zip", repo.DownloadArtifact)
- }, reqRepoReader(unit.TypeActions), context.ReferencesGitRepo(true))
- m.Group("/keys", func() {
- m.Combo("").Get(repo.ListDeployKeys).
- Post(bind(api.CreateKeyOption{}), repo.CreateDeployKey)
- m.Combo("/{id}").Get(repo.GetDeployKey).
- Delete(repo.DeleteDeploykey)
- }, reqToken(), reqAdmin())
- m.Group("/times", func() {
- m.Combo("").Get(repo.ListTrackedTimesByRepository)
- m.Combo("/{timetrackingusername}").Get(repo.ListTrackedTimesByUser)
- }, mustEnableIssues, reqToken())
- m.Group("/wiki", func() {
- m.Combo("/page/{pageName}").
- Get(repo.GetWikiPage).
- Patch(mustNotBeArchived, reqToken(), reqRepoWriter(unit.TypeWiki), bind(api.CreateWikiPageOptions{}), repo.EditWikiPage).
- Delete(mustNotBeArchived, reqToken(), reqRepoWriter(unit.TypeWiki), repo.DeleteWikiPage)
- m.Get("/revisions/{pageName}", repo.ListPageRevisions)
- m.Post("/new", reqToken(), mustNotBeArchived, reqRepoWriter(unit.TypeWiki), bind(api.CreateWikiPageOptions{}), repo.NewWikiPage)
- m.Get("/pages", repo.ListWikiPages)
- }, mustEnableWiki)
- m.Post("/markup", reqToken(), bind(api.MarkupOption{}), misc.Markup)
- m.Post("/markdown", reqToken(), bind(api.MarkdownOption{}), misc.Markdown)
- m.Post("/markdown/raw", reqToken(), misc.MarkdownRaw)
- m.Get("/stargazers", reqStarsEnabled(), repo.ListStargazers)
- m.Get("/subscribers", repo.ListSubscribers)
- m.Group("/subscription", func() {
- m.Get("", user.IsWatching)
- m.Put("", user.Watch)
- m.Delete("", user.Unwatch)
- }, reqToken())
- m.Group("/releases", func() {
- m.Combo("").Get(repo.ListReleases).
- Post(reqToken(), reqRepoWriter(unit.TypeReleases), context.ReferencesGitRepo(), bind(api.CreateReleaseOption{}), repo.CreateRelease)
- m.Combo("/latest").Get(repo.GetLatestRelease)
- m.Group("/{id}", func() {
- m.Combo("").Get(repo.GetRelease).
- Patch(reqToken(), reqRepoWriter(unit.TypeReleases), context.ReferencesGitRepo(), bind(api.EditReleaseOption{}), repo.EditRelease).
- Delete(reqToken(), reqRepoWriter(unit.TypeReleases), repo.DeleteRelease)
- m.Group("/assets", func() {
- m.Combo("").Get(repo.ListReleaseAttachments).
- Post(reqToken(), reqRepoWriter(unit.TypeReleases), repo.CreateReleaseAttachment)
- m.Combo("/{attachment_id}").Get(repo.GetReleaseAttachment).
- Patch(reqToken(), reqRepoWriter(unit.TypeReleases), bind(api.EditAttachmentOptions{}), repo.EditReleaseAttachment).
- Delete(reqToken(), reqRepoWriter(unit.TypeReleases), repo.DeleteReleaseAttachment)
- })
- })
- m.Group("/tags", func() {
- m.Combo("/{tag}").
- Get(repo.GetReleaseByTag).
- Delete(reqToken(), reqRepoWriter(unit.TypeReleases), repo.DeleteReleaseByTag)
- })
- }, reqRepoReader(unit.TypeReleases))
- m.Post("/mirror-sync", reqToken(), reqRepoWriter(unit.TypeCode), mustNotBeArchived, repo.MirrorSync)
- m.Post("/push_mirrors-sync", reqAdmin(), reqToken(), mustNotBeArchived, repo.PushMirrorSync)
- m.Group("/push_mirrors", func() {
- m.Combo("").Get(repo.ListPushMirrors).
- Post(mustNotBeArchived, bind(api.CreatePushMirrorOption{}), repo.AddPushMirror)
- m.Combo("/{name}").
- Delete(mustNotBeArchived, repo.DeletePushMirrorByRemoteName).
- Get(repo.GetPushMirrorByName)
- }, reqAdmin(), reqToken())
-
- m.Get("/editorconfig/{filename}", context.ReferencesGitRepo(), context.RepoRefForAPI, reqRepoReader(unit.TypeCode), repo.GetEditorconfig)
- m.Group("/pulls", func() {
- m.Combo("").Get(repo.ListPullRequests).
- Post(reqToken(), mustNotBeArchived, bind(api.CreatePullRequestOption{}), repo.CreatePullRequest)
- m.Get("/pinned", repo.ListPinnedPullRequests)
- m.Group("/{index}", func() {
- m.Combo("").Get(repo.GetPullRequest).
- Patch(reqToken(), bind(api.EditPullRequestOption{}), repo.EditPullRequest)
- m.Get(".{diffType:diff|patch}", repo.DownloadPullDiffOrPatch)
- m.Post("/update", reqToken(), repo.UpdatePullRequest)
- m.Get("/commits", repo.GetPullRequestCommits)
- m.Get("/files", repo.GetPullRequestFiles)
- m.Combo("/merge").Get(repo.IsPullRequestMerged).
- Post(reqToken(), mustNotBeArchived, bind(forms.MergePullRequestForm{}), repo.MergePullRequest).
- Delete(reqToken(), mustNotBeArchived, repo.CancelScheduledAutoMerge)
- m.Group("/reviews", func() {
- m.Combo("").
- Get(repo.ListPullReviews).
- Post(reqToken(), bind(api.CreatePullReviewOptions{}), repo.CreatePullReview)
- m.Group("/{id}", func() {
- m.Combo("").
- Get(repo.GetPullReview).
- Delete(reqToken(), repo.DeletePullReview).
- Post(reqToken(), bind(api.SubmitPullReviewOptions{}), repo.SubmitPullReview)
- m.Combo("/comments").
- Get(repo.GetPullReviewComments)
- m.Post("/dismissals", reqToken(), bind(api.DismissPullReviewOptions{}), repo.DismissPullReview)
- m.Post("/undismissals", reqToken(), repo.UnDismissPullReview)
- })
- })
- m.Combo("/requested_reviewers", reqToken()).
- Delete(bind(api.PullReviewRequestOptions{}), repo.DeleteReviewRequests).
- Post(bind(api.PullReviewRequestOptions{}), repo.CreateReviewRequests)
- })
- m.Get("/{base}/*", repo.GetPullRequestByBaseHead)
- }, mustAllowPulls, reqRepoReader(unit.TypeCode), context.ReferencesGitRepo())
- m.Group("/statuses", func() {
- m.Combo("/{sha}").Get(repo.GetCommitStatuses).
- Post(reqToken(), reqRepoWriter(unit.TypeCode), bind(api.CreateStatusOption{}), repo.NewCommitStatus)
- }, reqRepoReader(unit.TypeCode))
- m.Group("/commits", func() {
- m.Get("", context.ReferencesGitRepo(), repo.GetAllCommits)
- m.Group("/{ref}", func() {
- m.Get("/status", repo.GetCombinedCommitStatusByRef)
- m.Get("/statuses", repo.GetCommitStatusesByRef)
- }, context.ReferencesGitRepo())
- m.Group("/{sha}", func() {
- m.Get("/pull", repo.GetCommitPullRequest)
- }, context.ReferencesGitRepo())
- }, reqRepoReader(unit.TypeCode))
- m.Group("/git", func() {
- m.Group("/commits", func() {
- m.Get("/{sha}", repo.GetSingleCommit)
- m.Get("/{sha}.{diffType:diff|patch}", repo.DownloadCommitDiffOrPatch)
- })
- m.Get("/refs", repo.GetGitAllRefs)
- m.Get("/refs/*", repo.GetGitRefs)
- m.Get("/trees/{sha}", repo.GetTree)
- m.Get("/blobs/{sha}", repo.GetBlob)
- m.Get("/tags/{sha}", repo.GetAnnotatedTag)
- m.Get("/notes/{sha}", repo.GetNote)
- }, context.ReferencesGitRepo(true), reqRepoReader(unit.TypeCode))
- m.Group("/contents", func() {
- m.Get("", repo.GetContentsList)
- m.Get("/*", repo.GetContents)
- m.Group("", func() {
- // "change file" operations, need permission to write to the target branch provided by the form
- m.Post("", bind(api.ChangeFilesOptions{}), repo.ReqChangeRepoFileOptionsAndCheck, repo.ChangeFiles)
- m.Group("/*", func() {
- m.Post("", bind(api.CreateFileOptions{}), repo.ReqChangeRepoFileOptionsAndCheck, repo.CreateFile)
- m.Put("", bind(api.UpdateFileOptions{}), repo.ReqChangeRepoFileOptionsAndCheck, repo.UpdateFile)
- m.Delete("", bind(api.DeleteFileOptions{}), repo.ReqChangeRepoFileOptionsAndCheck, repo.DeleteFile)
- })
- m.Post("/diffpatch", bind(api.ApplyDiffPatchFileOptions{}), repo.ReqChangeRepoFileOptionsAndCheck, repo.ApplyDiffPatch)
- }, mustEnableEditor, reqToken())
- }, reqRepoReader(unit.TypeCode), context.ReferencesGitRepo())
- m.Group("/contents-ext", func() {
- m.Get("", repo.GetContentsExt)
- m.Get("/*", repo.GetContentsExt)
- }, reqRepoReader(unit.TypeCode), context.ReferencesGitRepo())
- m.Combo("/file-contents", reqRepoReader(unit.TypeCode), context.ReferencesGitRepo()).
- Get(repo.GetFileContentsGet).
- Post(bind(api.GetFilesOptions{}), repo.GetFileContentsPost) // the POST method requires "write" permission, so we also support "GET" method above
- m.Get("/signing-key.gpg", misc.SigningKeyGPG)
- m.Get("/signing-key.pub", misc.SigningKeySSH)
- m.Group("/topics", func() {
- m.Combo("").Get(repo.ListTopics).
- Put(reqToken(), reqAdmin(), bind(api.RepoTopicOptions{}), repo.UpdateTopics)
- m.Group("/{topic}", func() {
- m.Combo("").Put(reqToken(), repo.AddTopic).
- Delete(reqToken(), repo.DeleteTopic)
- }, reqAdmin())
- }, reqAnyRepoReader())
- m.Get("/issue_templates", context.ReferencesGitRepo(), repo.GetIssueTemplates)
- m.Get("/issue_config", context.ReferencesGitRepo(), repo.GetIssueConfig)
- m.Get("/issue_config/validate", context.ReferencesGitRepo(), repo.ValidateIssueConfig)
- m.Get("/languages", reqRepoReader(unit.TypeCode), repo.GetLanguages)
- m.Get("/licenses", reqRepoReader(unit.TypeCode), repo.GetLicenses)
- m.Get("/activities/feeds", repo.ListRepoActivityFeeds)
- m.Get("/new_pin_allowed", repo.AreNewIssuePinsAllowed)
- m.Group("/avatar", func() {
- m.Post("", bind(api.UpdateRepoAvatarOption{}), repo.UpdateAvatar)
- m.Delete("", repo.DeleteAvatar)
- }, reqAdmin(), reqToken())
-
- m.Methods("HEAD,GET", "/{ball_type:tarball|zipball|bundle}/*", reqRepoReader(unit.TypeCode), context.ReferencesGitRepo(true), repo.DownloadArchive)
- }, repoAssignment(), checkTokenPublicOnly())
- }, tokenRequiresScopes(auth_model.AccessTokenScopeCategoryRepository))
-
- // Artifacts direct download endpoint authenticates via signed url
- // it is protected by the "sig" parameter (to help to access private repo), so no need to use other middlewares
- m.Get("/repos/{username}/{reponame}/actions/artifacts/{artifact_id}/zip/raw", repo.DownloadArtifactRaw)
-
- // Notifications (requires notifications scope)
- m.Group("/repos", func() {
- m.Group("/{username}/{reponame}", func() {
- m.Combo("/notifications", reqToken()).
- Get(notify.ListRepoNotifications).
- Put(notify.ReadRepoNotifications)
- }, repoAssignment(), checkTokenPublicOnly())
- }, tokenRequiresScopes(auth_model.AccessTokenScopeCategoryNotification))
-
- // Issue (requires issue scope)
- m.Group("/repos", func() {
- m.Get("/issues/search", repo.SearchIssues)
-
- m.Group("/{username}/{reponame}", func() {
- m.Group("/issues", func() {
- m.Combo("").Get(repo.ListIssues).
- Post(reqToken(), mustNotBeArchived, bind(api.CreateIssueOption{}), reqRepoReader(unit.TypeIssues), repo.CreateIssue)
- m.Get("/pinned", reqRepoReader(unit.TypeIssues), repo.ListPinnedIssues)
- m.Group("/comments", func() {
- m.Get("", repo.ListRepoIssueComments)
- m.Group("/{id}", func() {
- m.Combo("").
- Get(repo.GetIssueComment).
- Patch(mustNotBeArchived, reqToken(), bind(api.EditIssueCommentOption{}), repo.EditIssueComment).
- Delete(reqToken(), repo.DeleteIssueComment)
- m.Combo("/reactions").
- Get(repo.GetIssueCommentReactions).
- Post(reqToken(), bind(api.EditReactionOption{}), repo.PostIssueCommentReaction).
- Delete(reqToken(), bind(api.EditReactionOption{}), repo.DeleteIssueCommentReaction)
- m.Group("/assets", func() {
- m.Combo("").
- Get(repo.ListIssueCommentAttachments).
- Post(reqToken(), mustNotBeArchived, repo.CreateIssueCommentAttachment)
- m.Combo("/{attachment_id}").
- Get(repo.GetIssueCommentAttachment).
- Patch(reqToken(), mustNotBeArchived, bind(api.EditAttachmentOptions{}), repo.EditIssueCommentAttachment).
- Delete(reqToken(), mustNotBeArchived, repo.DeleteIssueCommentAttachment)
- }, mustEnableAttachments)
- })
- })
- m.Group("/{index}", func() {
- m.Combo("").Get(repo.GetIssue).
- Patch(reqToken(), bind(api.EditIssueOption{}), repo.EditIssue).
- Delete(reqToken(), reqAdmin(), context.ReferencesGitRepo(), repo.DeleteIssue)
- m.Group("/comments", func() {
- m.Combo("").Get(repo.ListIssueComments).
- Post(reqToken(), mustNotBeArchived, bind(api.CreateIssueCommentOption{}), repo.CreateIssueComment)
- m.Combo("/{id}", reqToken()).Patch(bind(api.EditIssueCommentOption{}), repo.EditIssueCommentDeprecated).
- Delete(repo.DeleteIssueCommentDeprecated)
- })
- m.Get("/timeline", repo.ListIssueCommentsAndTimeline)
- m.Group("/labels", func() {
- m.Combo("").Get(repo.ListIssueLabels).
- Post(reqToken(), bind(api.IssueLabelsOption{}), repo.AddIssueLabels).
- Put(reqToken(), bind(api.IssueLabelsOption{}), repo.ReplaceIssueLabels).
- Delete(reqToken(), repo.ClearIssueLabels)
- m.Delete("/{id}", reqToken(), repo.DeleteIssueLabel)
- })
- m.Group("/times", func() {
- m.Combo("").
- Get(repo.ListTrackedTimes).
- Post(bind(api.AddTimeOption{}), repo.AddTime).
- Delete(repo.ResetIssueTime)
- m.Delete("/{id}", repo.DeleteTime)
- }, reqToken())
- m.Combo("/deadline").Post(reqToken(), bind(api.EditDeadlineOption{}), repo.UpdateIssueDeadline)
- m.Group("/stopwatch", func() {
- m.Post("/start", repo.StartIssueStopwatch)
- m.Post("/stop", repo.StopIssueStopwatch)
- m.Delete("/delete", repo.DeleteIssueStopwatch)
- }, reqToken())
- m.Group("/subscriptions", func() {
- m.Get("", repo.GetIssueSubscribers)
- m.Get("/check", reqToken(), repo.CheckIssueSubscription)
- m.Put("/{user}", reqToken(), repo.AddIssueSubscription)
- m.Delete("/{user}", reqToken(), repo.DelIssueSubscription)
- })
- m.Combo("/reactions").
- Get(repo.GetIssueReactions).
- Post(reqToken(), bind(api.EditReactionOption{}), repo.PostIssueReaction).
- Delete(reqToken(), bind(api.EditReactionOption{}), repo.DeleteIssueReaction)
- m.Group("/assets", func() {
- m.Combo("").
- Get(repo.ListIssueAttachments).
- Post(reqToken(), mustNotBeArchived, repo.CreateIssueAttachment)
- m.Combo("/{attachment_id}").
- Get(repo.GetIssueAttachment).
- Patch(reqToken(), mustNotBeArchived, bind(api.EditAttachmentOptions{}), repo.EditIssueAttachment).
- Delete(reqToken(), mustNotBeArchived, repo.DeleteIssueAttachment)
- }, mustEnableAttachments)
- m.Combo("/dependencies").
- Get(repo.GetIssueDependencies).
- Post(reqToken(), mustNotBeArchived, bind(api.IssueMeta{}), repo.CreateIssueDependency).
- Delete(reqToken(), mustNotBeArchived, bind(api.IssueMeta{}), repo.RemoveIssueDependency)
- m.Combo("/blocks").
- Get(repo.GetIssueBlocks).
- Post(reqToken(), bind(api.IssueMeta{}), repo.CreateIssueBlocking).
- Delete(reqToken(), bind(api.IssueMeta{}), repo.RemoveIssueBlocking)
- m.Group("/pin", func() {
- m.Combo("").
- Post(reqToken(), reqAdmin(), repo.PinIssue).
- Delete(reqToken(), reqAdmin(), repo.UnpinIssue)
- m.Patch("/{position}", reqToken(), reqAdmin(), repo.MoveIssuePin)
- })
- m.Group("/lock", func() {
- m.Combo("").
- Put(bind(api.LockIssueOption{}), repo.LockIssue).
- Delete(repo.UnlockIssue)
- }, reqToken(), reqAdmin())
- })
- }, mustEnableIssuesOrPulls)
- m.Group("/labels", func() {
- m.Combo("").Get(repo.ListLabels).
- Post(reqToken(), reqRepoWriter(unit.TypeIssues, unit.TypePullRequests), bind(api.CreateLabelOption{}), repo.CreateLabel)
- m.Combo("/{id}").Get(repo.GetLabel).
- Patch(reqToken(), reqRepoWriter(unit.TypeIssues, unit.TypePullRequests), bind(api.EditLabelOption{}), repo.EditLabel).
- Delete(reqToken(), reqRepoWriter(unit.TypeIssues, unit.TypePullRequests), repo.DeleteLabel)
- })
- m.Group("/milestones", func() {
- m.Combo("").Get(repo.ListMilestones).
- Post(reqToken(), reqRepoWriter(unit.TypeIssues, unit.TypePullRequests), bind(api.CreateMilestoneOption{}), repo.CreateMilestone)
- m.Combo("/{id}").Get(repo.GetMilestone).
- Patch(reqToken(), reqRepoWriter(unit.TypeIssues, unit.TypePullRequests), bind(api.EditMilestoneOption{}), repo.EditMilestone).
- Delete(reqToken(), reqRepoWriter(unit.TypeIssues, unit.TypePullRequests), repo.DeleteMilestone)
- })
- }, repoAssignment(), checkTokenPublicOnly())
- }, tokenRequiresScopes(auth_model.AccessTokenScopeCategoryIssue))
-
- // NOTE: these are Gitea package management API - see packages.CommonRoutes and packages.DockerContainerRoutes for endpoints that implement package manager APIs
- m.Group("/packages/{username}", func() {
- m.Group("/{type}/{name}", func() {
- m.Get("/", packages.ListPackageVersions)
-
- m.Group("/{version}", func() {
- m.Get("", packages.GetPackage)
- m.Delete("", reqPackageAccess(perm.AccessModeWrite), packages.DeletePackage)
- m.Get("/files", packages.ListPackageFiles)
- })
-
- m.Group("/-", func() {
- m.Get("/latest", packages.GetLatestPackageVersion)
- m.Post("/link/{repo_name}", reqPackageAccess(perm.AccessModeWrite), packages.LinkPackage)
- m.Post("/unlink", reqPackageAccess(perm.AccessModeWrite), packages.UnlinkPackage)
- })
- })
-
- m.Get("/", packages.ListPackages)
- }, reqToken(), tokenRequiresScopes(auth_model.AccessTokenScopeCategoryPackage), context.UserAssignmentAPI(), context.PackageAssignmentAPI(), reqPackageAccess(perm.AccessModeRead), checkTokenPublicOnly())
-
- // Organizations
- m.Get("/user/orgs", reqToken(), tokenRequiresScopes(auth_model.AccessTokenScopeCategoryUser, auth_model.AccessTokenScopeCategoryOrganization), org.ListMyOrgs)
- 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.UserAssignmentAPI(), checkTokenPublicOnly())
- m.Post("/orgs", tokenRequiresScopes(auth_model.AccessTokenScopeCategoryOrganization), reqToken(), bind(api.CreateOrgOption{}), org.Create)
- m.Get("/orgs", org.GetAll, tokenRequiresScopes(auth_model.AccessTokenScopeCategoryOrganization))
- m.Group("/orgs/{org}", func() {
- m.Combo("").Get(org.Get).
- Patch(reqToken(), reqOrgOwnership(), bind(api.EditOrgOption{}), org.Edit).
- Delete(reqToken(), reqOrgOwnership(), org.Delete)
- m.Post("/rename", reqToken(), reqOrgOwnership(), bind(api.RenameOrgOption{}), org.Rename)
- m.Combo("/repos").Get(user.ListOrgRepos).
- Post(reqToken(), bind(api.CreateRepoOption{}), repo.CreateOrgRepo)
- m.Group("/members", func() {
- m.Get("", reqToken(), org.ListMembers)
- m.Combo("/{username}").Get(reqToken(), org.IsMember).
- Delete(reqToken(), reqOrgOwnership(), org.DeleteMember)
- })
- addActionsRoutes(
- m,
- reqOrgOwnership(),
- org.NewAction(),
- )
- m.Group("/public_members", func() {
- m.Get("", org.ListPublicMembers)
- m.Combo("/{username}").Get(org.IsPublicMember).
- Put(reqToken(), reqOrgMembership(), org.PublicizeMember).
- Delete(reqToken(), reqOrgMembership(), org.ConcealMember)
- })
- m.Group("/teams", func() {
- m.Get("", org.ListTeams)
- m.Post("", reqOrgOwnership(), bind(api.CreateTeamOption{}), org.CreateTeam)
- m.Get("/search", org.SearchTeam)
- }, reqToken(), reqOrgMembership())
- m.Group("/labels", func() {
- m.Get("", org.ListLabels)
- m.Post("", reqToken(), reqOrgOwnership(), bind(api.CreateLabelOption{}), org.CreateLabel)
- m.Combo("/{id}").Get(reqToken(), org.GetLabel).
- Patch(reqToken(), reqOrgOwnership(), bind(api.EditLabelOption{}), org.EditLabel).
- Delete(reqToken(), reqOrgOwnership(), org.DeleteLabel)
- })
- m.Group("/hooks", func() {
- m.Combo("").Get(org.ListHooks).
- Post(bind(api.CreateHookOption{}), org.CreateHook)
- m.Combo("/{id}").Get(org.GetHook).
- Patch(bind(api.EditHookOption{}), org.EditHook).
- Delete(org.DeleteHook)
- }, reqToken(), reqOrgOwnership(), reqWebhooksEnabled())
- m.Group("/avatar", func() {
- m.Post("", bind(api.UpdateUserAvatarOption{}), org.UpdateAvatar)
- m.Delete("", org.DeleteAvatar)
- }, reqToken(), reqOrgOwnership())
- m.Get("/activities/feeds", org.ListOrgActivityFeeds)
-
- m.Group("/blocks", func() {
- m.Get("", org.ListBlocks)
- m.Group("/{username}", func() {
- m.Get("", org.CheckUserBlock)
- m.Put("", org.BlockUser)
- m.Delete("", org.UnblockUser)
- })
- }, reqToken(), reqOrgOwnership())
- }, tokenRequiresScopes(auth_model.AccessTokenScopeCategoryOrganization), orgAssignment(true), checkTokenPublicOnly())
- m.Group("/teams/{teamid}", func() {
- m.Combo("").Get(reqToken(), org.GetTeam).
- Patch(reqToken(), reqOrgOwnership(), bind(api.EditTeamOption{}), org.EditTeam).
- Delete(reqToken(), reqOrgOwnership(), org.DeleteTeam)
- m.Group("/members", func() {
- m.Get("", reqToken(), org.GetTeamMembers)
- m.Combo("/{username}").
- Get(reqToken(), org.GetTeamMember).
- Put(reqToken(), reqOrgOwnership(), org.AddTeamMember).
- Delete(reqToken(), reqOrgOwnership(), org.RemoveTeamMember)
- })
- m.Group("/repos", func() {
- m.Get("", reqToken(), org.GetTeamRepos)
- m.Combo("/{org}/{reponame}").
- Put(reqToken(), org.AddTeamRepository).
- Delete(reqToken(), org.RemoveTeamRepository).
- Get(reqToken(), org.GetTeamRepo)
- })
- m.Get("/activities/feeds", org.ListTeamActivityFeeds)
- }, tokenRequiresScopes(auth_model.AccessTokenScopeCategoryOrganization), orgAssignment(false, true), reqToken(), reqTeamMembership(), checkTokenPublicOnly())
-
- m.Group("/admin", func() {
- m.Group("/cron", func() {
- m.Get("", admin.ListCronTasks)
- m.Post("/{task}", admin.PostCronTask)
- })
- m.Get("/orgs", admin.GetAllOrgs)
- m.Group("/users", func() {
- m.Get("", admin.SearchUsers)
- m.Post("", bind(api.CreateUserOption{}), admin.CreateUser)
- m.Group("/{username}", func() {
- m.Combo("").Patch(bind(api.EditUserOption{}), admin.EditUser).
- Delete(admin.DeleteUser)
- m.Group("/keys", func() {
- m.Post("", bind(api.CreateKeyOption{}), admin.CreatePublicKey)
- m.Delete("/{id}", admin.DeleteUserPublicKey)
- })
- m.Get("/orgs", org.ListUserOrgs)
- m.Post("/orgs", bind(api.CreateOrgOption{}), admin.CreateOrg)
- m.Post("/repos", bind(api.CreateRepoOption{}), admin.CreateRepo)
- m.Post("/rename", bind(api.RenameUserOption{}), admin.RenameUser)
- m.Get("/badges", admin.ListUserBadges)
- m.Post("/badges", bind(api.UserBadgeOption{}), admin.AddUserBadges)
- m.Delete("/badges", bind(api.UserBadgeOption{}), admin.DeleteUserBadges)
- }, context.UserAssignmentAPI())
- })
- m.Group("/emails", func() {
- m.Get("", admin.GetAllEmails)
- m.Get("/search", admin.SearchEmail)
- })
- m.Group("/unadopted", func() {
- m.Get("", admin.ListUnadoptedRepositories)
- m.Post("/{username}/{reponame}", admin.AdoptRepository)
- m.Delete("/{username}/{reponame}", admin.DeleteUnadoptedRepository)
- })
- m.Group("/hooks", func() {
- m.Combo("").Get(admin.ListHooks).
- Post(bind(api.CreateHookOption{}), admin.CreateHook)
- m.Combo("/{id}").Get(admin.GetHook).
- Patch(bind(api.EditHookOption{}), admin.EditHook).
- Delete(admin.DeleteHook)
- })
- m.Group("/actions", func() {
- m.Group("/runners", func() {
- m.Get("", admin.ListRunners)
- m.Post("/registration-token", admin.CreateRegistrationToken)
- m.Get("/{runner_id}", admin.GetRunner)
- m.Delete("/{runner_id}", admin.DeleteRunner)
- })
- m.Get("/runs", admin.ListWorkflowRuns)
- m.Get("/jobs", admin.ListWorkflowJobs)
- })
- m.Group("/runners", func() {
- m.Get("/registration-token", admin.GetRegistrationToken)
- })
- }, tokenRequiresScopes(auth_model.AccessTokenScopeCategoryAdmin), reqToken(), reqSiteAdmin())
-
- m.Group("/topics", func() {
- m.Get("/search", repo.TopicSearch)
- }, tokenRequiresScopes(auth_model.AccessTokenScopeCategoryRepository))
- }, sudo())
-
- return m
- }
-
- func securityHeaders() func(http.Handler) http.Handler {
- return func(next http.Handler) http.Handler {
- return http.HandlerFunc(func(resp http.ResponseWriter, req *http.Request) {
- // CORB: https://www.chromium.org/Home/chromium-security/corb-for-developers
- // http://stackoverflow.com/a/3146618/244009
- resp.Header().Set("x-content-type-options", "nosniff")
- next.ServeHTTP(resp, req)
- })
- }
- }
|