12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523 |
- // 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: http, https
- // BasePath: /api/v1
- // Version: {{AppVer | JSEscape | Safe}}
- // 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 (
- "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/context"
- "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/auth"
- context_service "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.NotFound()
- } else {
- ctx.Error(http.StatusInternalServerError, "GetUserByName", 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.Params("username")
- repoName := ctx.Params("reponame")
-
- var (
- owner *user_model.User
- err error
- )
-
- // Check if the user is the same as the repository owner.
- if ctx.IsSigned && ctx.Doer.LowerName == strings.ToLower(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.NotFound("GetUserByName", err)
- } else {
- ctx.Error(http.StatusInternalServerError, "LookupUserRedirect", err)
- }
- } else {
- ctx.Error(http.StatusInternalServerError, "GetUserByName", err)
- }
- return
- }
- }
- ctx.Repo.Owner = owner
- ctx.ContextUser = owner
-
- // Get repository.
- repo, err := repo_model.GetRepositoryByName(owner.ID, repoName)
- if err != nil {
- if repo_model.IsErrRepoNotExist(err) {
- redirectRepoID, err := repo_model.LookupRedirect(owner.ID, repoName)
- if err == nil {
- context.RedirectToRepo(ctx.Base, redirectRepoID)
- } else if repo_model.IsErrRedirectNotExist(err) {
- ctx.NotFound()
- } else {
- ctx.Error(http.StatusInternalServerError, "LookupRepoRedirect", err)
- }
- } else {
- ctx.Error(http.StatusInternalServerError, "GetRepositoryByName", 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.Error(http.StatusInternalServerError, "actions_model.GetTaskByID", err)
- return
- }
- if task.RepoID != repo.ID {
- ctx.NotFound()
- 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.Error(http.StatusInternalServerError, "LoadUnits", err)
- return
- }
- ctx.Repo.Permission.Units = ctx.Repo.Repository.Units
- ctx.Repo.Permission.UnitsMode = make(map[unit.Type]perm.AccessMode)
- for _, u := range ctx.Repo.Repository.Units {
- ctx.Repo.Permission.UnitsMode[u.Type] = ctx.Repo.Permission.AccessMode
- }
- } else {
- ctx.Repo.Permission, err = access_model.GetUserRepoPermission(ctx, repo, ctx.Doer)
- if err != nil {
- ctx.Error(http.StatusInternalServerError, "GetUserRepoPermission", err)
- return
- }
- }
-
- if !ctx.Repo.HasAccess() {
- ctx.NotFound()
- return
- }
- }
- }
-
- func reqPackageAccess(accessMode perm.AccessMode) func(ctx *context.APIContext) {
- return func(ctx *context.APIContext) {
- if ctx.Package.AccessMode < accessMode && !ctx.IsUserSiteAdmin() {
- ctx.Error(http.StatusForbidden, "reqPackageAccess", "user should have specific permission or be a site admin")
- 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
- }
-
- ctx.Data["ApiTokenScopePublicRepoOnly"] = false
- ctx.Data["ApiTokenScopePublicOrgOnly"] = false
-
- // use the http method to determine the access level
- requiredScopeLevel := auth_model.Read
- if ctx.Req.Method == "POST" || ctx.Req.Method == "PUT" || ctx.Req.Method == "PATCH" || ctx.Req.Method == "DELETE" {
- requiredScopeLevel = auth_model.Write
- }
-
- // get the required scope for the given access level and category
- requiredScopes := auth_model.GetRequiredScopes(requiredScopeLevel, requiredScopeCategories...)
-
- // check if scope only applies to public resources
- publicOnly, err := scope.PublicOnly()
- if err != nil {
- ctx.Error(http.StatusForbidden, "tokenRequiresScope", "parsing public resource scope failed: "+err.Error())
- return
- }
-
- // this context is used by the middleware in the specific route
- ctx.Data["ApiTokenScopePublicRepoOnly"] = publicOnly && auth_model.ContainsCategory(requiredScopeCategories, auth_model.AccessTokenScopeCategoryRepository)
- ctx.Data["ApiTokenScopePublicOrgOnly"] = publicOnly && auth_model.ContainsCategory(requiredScopeCategories, auth_model.AccessTokenScopeCategoryOrganization)
-
- allow, err := scope.HasScope(requiredScopes...)
- if err != nil {
- ctx.Error(http.StatusForbidden, "tokenRequiresScope", "checking scope failed: "+err.Error())
- return
- }
-
- if allow {
- return
- }
-
- ctx.Error(http.StatusForbidden, "tokenRequiresScope", fmt.Sprintf("token does not have at least one of required scope(s): %v", requiredScopes))
- }
- }
-
- // 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 true == ctx.Data["IsApiToken"] {
- publicRepo, pubRepoExists := ctx.Data["ApiTokenScopePublicRepoOnly"]
- publicOrg, pubOrgExists := ctx.Data["ApiTokenScopePublicOrgOnly"]
-
- if pubRepoExists && publicRepo.(bool) &&
- ctx.Repo.Repository != nil && ctx.Repo.Repository.IsPrivate {
- ctx.Error(http.StatusForbidden, "reqToken", "token scope is limited to public repos")
- return
- }
-
- if pubOrgExists && publicOrg.(bool) &&
- ctx.Org.Organization != nil && ctx.Org.Organization.Visibility != api.VisibleTypePublic {
- ctx.Error(http.StatusForbidden, "reqToken", "token scope is limited to public orgs")
- return
- }
-
- return
- }
-
- if ctx.IsSigned {
- return
- }
- ctx.Error(http.StatusUnauthorized, "reqToken", "token is required")
- }
- }
-
- func reqExploreSignIn() func(ctx *context.APIContext) {
- return func(ctx *context.APIContext) {
- if setting.Service.Explore.RequireSigninView && !ctx.IsSigned {
- ctx.Error(http.StatusUnauthorized, "reqExploreSignIn", "you must be signed in to search for users")
- }
- }
- }
-
- 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.Error(http.StatusUnauthorized, "reqBasicAuth", "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.Error(http.StatusForbidden, "reqSiteAdmin", "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.Error(http.StatusForbidden, "reqOwner", "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.Error(http.StatusForbidden, "reqSelfOrAdmin", "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.Error(http.StatusForbidden, "reqAdmin", "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.Error(http.StatusForbidden, "reqRepoWriter", "user should have a permission to write to a repo")
- return
- }
- }
- }
-
- // reqRepoBranchWriter user should have a permission to write to a branch, or be a site admin
- func reqRepoBranchWriter(ctx *context.APIContext) {
- options, ok := web.GetForm(ctx).(api.FileOptionInterface)
- if !ok || (!ctx.Repo.CanWriteToBranch(ctx, ctx.Doer, options.Branch()) && !ctx.IsUserSiteAdmin()) {
- ctx.Error(http.StatusForbidden, "reqRepoBranchWriter", "user should have a permission to write to this branch")
- 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.Error(http.StatusForbidden, "reqRepoReader", "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.HasAccess() && !ctx.IsUserSiteAdmin() {
- ctx.Error(http.StatusForbidden, "reqAnyRepoReader", "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 {
- ctx.Error(http.StatusInternalServerError, "", "reqOrgOwnership: unprepared context")
- return
- }
-
- isOwner, err := organization.IsOrganizationOwner(ctx, orgID, ctx.Doer.ID)
- if err != nil {
- ctx.Error(http.StatusInternalServerError, "IsOrganizationOwner", err)
- return
- } else if !isOwner {
- if ctx.Org.Organization != nil {
- ctx.Error(http.StatusForbidden, "", "Must be an organization owner")
- } else {
- ctx.NotFound()
- }
- 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 {
- ctx.Error(http.StatusInternalServerError, "", "reqTeamMembership: unprepared context")
- return
- }
-
- orgID := ctx.Org.Team.OrgID
- isOwner, err := organization.IsOrganizationOwner(ctx, orgID, ctx.Doer.ID)
- if err != nil {
- ctx.Error(http.StatusInternalServerError, "IsOrganizationOwner", err)
- return
- } else if isOwner {
- return
- }
-
- if isTeamMember, err := organization.IsTeamMember(ctx, orgID, ctx.Org.Team.ID, ctx.Doer.ID); err != nil {
- ctx.Error(http.StatusInternalServerError, "IsTeamMember", err)
- return
- } else if !isTeamMember {
- isOrgMember, err := organization.IsOrganizationMember(ctx, orgID, ctx.Doer.ID)
- if err != nil {
- ctx.Error(http.StatusInternalServerError, "IsOrganizationMember", err)
- } else if isOrgMember {
- ctx.Error(http.StatusForbidden, "", "Must be a team member")
- } else {
- ctx.NotFound()
- }
- 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 {
- ctx.Error(http.StatusInternalServerError, "", "reqOrgMembership: unprepared context")
- return
- }
-
- if isMember, err := organization.IsOrganizationMember(ctx, orgID, ctx.Doer.ID); err != nil {
- ctx.Error(http.StatusInternalServerError, "IsOrganizationMember", err)
- return
- } else if !isMember {
- if ctx.Org.Organization != nil {
- ctx.Error(http.StatusForbidden, "", "Must be an organization member")
- } else {
- ctx.NotFound()
- }
- return
- }
- }
- }
-
- func reqGitHook() func(ctx *context.APIContext) {
- return func(ctx *context.APIContext) {
- if !ctx.Doer.CanEditGitHook() {
- ctx.Error(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.Error(http.StatusForbidden, "", "webhooks 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.Params(":org"))
- if err != nil {
- if organization.IsErrOrgNotExist(err) {
- redirectUserID, err := user_model.LookupUserRedirect(ctx, ctx.Params(":org"))
- if err == nil {
- context.RedirectToUser(ctx.Base, ctx.Params(":org"), redirectUserID)
- } else if user_model.IsErrUserRedirectNotExist(err) {
- ctx.NotFound("GetOrgByName", err)
- } else {
- ctx.Error(http.StatusInternalServerError, "LookupUserRedirect", err)
- }
- } else {
- ctx.Error(http.StatusInternalServerError, "GetOrgByName", err)
- }
- return
- }
- ctx.ContextUser = ctx.Org.Organization.AsUser()
- }
-
- if assignTeam {
- ctx.Org.Team, err = organization.GetTeamByID(ctx, ctx.ParamsInt64(":teamid"))
- if err != nil {
- if organization.IsErrTeamNotExist(err) {
- ctx.NotFound()
- } else {
- ctx.Error(http.StatusInternalServerError, "GetTeamById", 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.NotFound()
- 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.NotFound()
- 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.NotFound()
- return
- }
- }
-
- func mustEnableWiki(ctx *context.APIContext) {
- if !(ctx.Repo.CanRead(unit.TypeWiki)) {
- ctx.NotFound()
- return
- }
- }
-
- func mustNotBeArchived(ctx *context.APIContext) {
- if ctx.Repo.Repository.IsArchived {
- ctx.NotFound()
- return
- }
- }
-
- func mustEnableAttachments(ctx *context.APIContext) {
- if !setting.Attachment.Enabled {
- ctx.NotFound()
- 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.Error(http.StatusUnprocessableEntity, "validationError", 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() {
- 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.Error(http.StatusUnauthorized, "APIAuth", 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
- }
- }
- }
- }
-
- // 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("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.Route {
- m := web.NewRoute()
-
- m.Use(securityHeaders())
- if setting.CORSConfig.Enabled {
- m.Use(cors.Handler(cors.Options{
- // Scheme: setting.CORSConfig.Scheme, // FIXME: the cors middleware needs scheme option
- AllowedOrigins: setting.CORSConfig.AllowDomain,
- // setting.CORSConfig.AllowSubdomain // FIXME: the cors middleware needs allowSubdomain option
- 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.RequireSignInView,
- }))
-
- 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_service.UserAssignmentAPI())
- m.Group("/user-id/{user-id}", func() {
- m.Get("", activitypub.Person)
- m.Post("/inbox", activitypub.ReqHTTPSignature(), activitypub.PersonInbox)
- }, context_service.UserIDAssignmentAPI())
- }, tokenRequiresScopes(auth_model.AccessTokenScopeCategoryActivityPub))
- }
-
- // Misc (public accessible)
- m.Group("", func() {
- m.Get("/version", misc.Version)
- m.Get("/signing-key.gpg", misc.SigningKey)
- 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(), 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_service.UserAssignmentAPI())
- }, 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", user.GetStarredRepos)
-
- m.Get("/subscriptions", user.GetWatchedRepos)
- }, context_service.UserAssignmentAPI())
- }, 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)
-
- // create or update a user's actions secrets
- m.Group("/actions/secrets", func() {
- m.Combo("/{secretname}").
- Put(bind(api.CreateOrUpdateSecretOption{}), user.CreateOrUpdateSecret).
- Delete(user.DeleteSecret)
- })
-
- 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_service.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())
- }, 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)
- }, reqToken())
- }, tokenRequiresScopes(auth_model.AccessTokenScopeCategoryUser), reqToken())
-
- // Repositories (requires repo scope, org scope)
- m.Post("/org/{org}/repos",
- tokenRequiresScopes(auth_model.AccessTokenScopeCategoryOrganization, auth_model.AccessTokenScopeCategoryRepository),
- reqToken(),
- bind(api.CreateRepoOption{}),
- repo.CreateOrgRepoDeprecated)
-
- // requires repo scope
- 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.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())
- m.Group("/actions/secrets", func() {
- m.Combo("/{secretname}").
- Put(reqToken(), reqOwner(), bind(api.CreateOrUpdateSecretOption{}), repo.CreateOrUpdateSecret).
- Delete(reqToken(), reqOwner(), repo.DeleteSecret)
- })
- 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.AddCollaborator).
- 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.Get("/archive/*", reqRepoReader(unit.TypeCode), repo.GetArchive)
- m.Combo("/forks").Get(repo.ListForks).
- Post(reqToken(), reqRepoReader(unit.TypeCode), bind(api.CreateForkOption{}), repo.CreateFork)
- m.Group("/branches", func() {
- m.Get("", repo.ListBranches)
- m.Get("/*", repo.GetBranch)
- m.Delete("/*", reqToken(), reqRepoWriter(unit.TypeCode), repo.DeleteBranch)
- m.Post("", reqToken(), reqRepoWriter(unit.TypeCode), bind(api.CreateBranchRepoOption{}), repo.CreateBranch)
- }, context.ReferencesGitRepo(), reqRepoReader(unit.TypeCode))
- m.Group("/branch_protections", func() {
- m.Get("", repo.ListBranchProtections)
- m.Post("", bind(api.CreateBranchProtectionOption{}), repo.CreateBranchProtection)
- m.Group("/{name}", func() {
- m.Get("", repo.GetBranchProtection)
- m.Patch("", bind(api.EditBranchProtectionOption{}), repo.EditBranchProtection)
- m.Delete("", repo.DeleteBranchProtection)
- })
- }, reqToken(), reqAdmin())
- m.Group("/tags", func() {
- m.Get("", repo.ListTags)
- m.Get("/*", repo.GetTag)
- m.Post("", reqToken(), reqRepoWriter(unit.TypeCode), bind(api.CreateTagOption{}), repo.CreateTag)
- m.Delete("/*", reqToken(), repo.DeleteTag)
- }, reqRepoReader(unit.TypeCode), 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", repo.ListStargazers)
- m.Get("/subscribers", repo.ListSubscribers)
- m.Group("/subscription", func() {
- m.Get("", user.IsWatching)
- m.Put("", reqToken(), user.Watch)
- m.Delete("", reqToken(), user.Unwatch)
- })
- 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), repo.MirrorSync)
- m.Post("/push_mirrors-sync", reqAdmin(), reqToken(), repo.PushMirrorSync)
- m.Group("/push_mirrors", func() {
- m.Combo("").Get(repo.ListPushMirrors).
- Post(bind(api.CreatePushMirrorOption{}), repo.AddPushMirror)
- m.Combo("/{name}").
- Delete(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)
- })
- }, 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())
- }, 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.Post("/diffpatch", reqRepoWriter(unit.TypeCode), reqToken(), bind(api.ApplyDiffPatchFileOptions{}), repo.ApplyDiffPatch)
- m.Group("/contents", func() {
- m.Get("", repo.GetContentsList)
- m.Post("", reqToken(), bind(api.ChangeFilesOptions{}), reqRepoBranchWriter, repo.ChangeFiles)
- m.Get("/*", repo.GetContents)
- m.Group("/*", func() {
- m.Post("", bind(api.CreateFileOptions{}), reqRepoBranchWriter, repo.CreateFile)
- m.Put("", bind(api.UpdateFileOptions{}), reqRepoBranchWriter, repo.UpdateFile)
- m.Delete("", bind(api.DeleteFileOptions{}), reqRepoBranchWriter, repo.DeleteFile)
- }, reqToken())
- }, reqRepoReader(unit.TypeCode))
- m.Get("/signing-key.gpg", misc.SigningKey)
- 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("/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())
- }, repoAssignment())
- }, tokenRequiresScopes(auth_model.AccessTokenScopeCategoryRepository))
-
- // Notifications (requires notifications scope)
- m.Group("/repos", func() {
- m.Group("/{username}/{reponame}", func() {
- m.Combo("/notifications", reqToken()).
- Get(notify.ListRepoNotifications).
- Put(notify.ReadRepoNotifications)
- }, repoAssignment())
- }, 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)
- })
- })
- }, 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())
- }, 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}/{version}", func() {
- m.Get("", reqToken(), packages.GetPackage)
- m.Delete("", reqToken(), reqPackageAccess(perm.AccessModeWrite), packages.DeletePackage)
- m.Get("/files", reqToken(), packages.ListPackageFiles)
- })
- m.Get("/", reqToken(), packages.ListPackages)
- }, tokenRequiresScopes(auth_model.AccessTokenScopeCategoryPackage), context_service.UserAssignmentAPI(), context.PackageAssignmentAPI(), reqPackageAccess(perm.AccessModeRead))
-
- // 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_service.UserAssignmentAPI())
- 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.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)
- })
- m.Group("/actions/secrets", func() {
- m.Get("", reqToken(), reqOrgOwnership(), org.ListActionsSecrets)
- m.Combo("/{secretname}").
- Put(reqToken(), reqOrgOwnership(), bind(api.CreateOrUpdateSecretOption{}), org.CreateOrUpdateSecret).
- Delete(reqToken(), reqOrgOwnership(), org.DeleteSecret)
- })
- 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)
- }, tokenRequiresScopes(auth_model.AccessTokenScopeCategoryOrganization), orgAssignment(true))
- 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())
-
- 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)
- }, context_service.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)
- })
- }, 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)
- })
- }
- }
|