mirror of
				https://gitee.com/gitea/gitea
				synced 2025-11-04 08:30:25 +08:00 
			
		
		
		
	Deprecate query string auth tokens (#28390)
## Changes - Add deprecation warning to `Token` and `AccessToken` authentication methods in swagger. - Add deprecation warning header to API response. Example: ``` HTTP/1.1 200 OK ... Warning: token and access_token API authentication is deprecated ... ``` - Add setting `DISABLE_QUERY_AUTH_TOKEN` to reject query string auth tokens entirely. Default is `false` ## Next steps - `DISABLE_QUERY_AUTH_TOKEN` should be true in a subsequent release and the methods should be removed in swagger - `DISABLE_QUERY_AUTH_TOKEN` should be removed and the implementation of the auth methods in question should be removed ## Open questions - Should there be further changes to the swagger documentation? Deprecation is not yet supported for security definitions (coming in [OpenAPI Spec version 3.2.0](https://github.com/OAI/OpenAPI-Specification/issues/2506)) - Should the API router logger sanitize urls that use `token` or `access_token`? (This is obviously an insufficient solution on its own) --------- Co-authored-by: delvh <dev.lh@web.de>
This commit is contained in:
		@@ -34,6 +34,7 @@ var (
 | 
			
		||||
	PasswordHashAlgo                   string
 | 
			
		||||
	PasswordCheckPwn                   bool
 | 
			
		||||
	SuccessfulTokensCacheSize          int
 | 
			
		||||
	DisableQueryAuthToken              bool
 | 
			
		||||
	CSRFCookieName                     = "_csrf"
 | 
			
		||||
	CSRFCookieHTTPOnly                 = true
 | 
			
		||||
)
 | 
			
		||||
@@ -157,4 +158,11 @@ func loadSecurityFrom(rootCfg ConfigProvider) {
 | 
			
		||||
			PasswordComplexity = append(PasswordComplexity, name)
 | 
			
		||||
		}
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	// TODO: default value should be true in future releases
 | 
			
		||||
	DisableQueryAuthToken = sec.Key("DISABLE_QUERY_AUTH_TOKEN").MustBool(false)
 | 
			
		||||
 | 
			
		||||
	if !DisableQueryAuthToken {
 | 
			
		||||
		log.Warn("Enabling Query API Auth tokens is not recommended. DISABLE_QUERY_AUTH_TOKEN will default to true in gitea 1.23 and will be removed in gitea 1.24.")
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user