-
-
Notifications
You must be signed in to change notification settings - Fork 5.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add nodeinfo endpoint for federation purposes (#16953)
Nodeinfo is a way to expose certain metadata about a server for use of discovery regarding functionality of its federation capabilities. Two endpoints are required: 1. `/.well-known/nodeinfo` which informs client where it can find the location of the location of its metadata (including which version of the schema is used) 2. the endpoint which exposes the metadata in json format according to schema. Notes: * `openRegistrations` is a required field, but I propose to set to false as default in case someone writes a crawler to discover "open" gitea instances * to limit data leakage I also propose to not include the `usage` field (note it is required so it should be included, but left as empty). More info: https://github.com/jhass/nodeinfo https://github.com/jhass/nodeinfo/tree/main/schemas/2.1 http://nodeinfo.diaspora.software/protocol.html
- Loading branch information
1 parent
f48dce3
commit babab0b
Showing
11 changed files
with
324 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| // Copyright 2021 The Gitea Authors. All rights reserved. | ||
| // Use of this source code is governed by a MIT-style | ||
| // license that can be found in the LICENSE file. | ||
|
|
||
| package setting | ||
|
|
||
| import "code.gitea.io/gitea/modules/log" | ||
|
|
||
| // Federation settings | ||
| var ( | ||
| Federation = struct { | ||
| Enabled bool | ||
| }{ | ||
| Enabled: true, | ||
| } | ||
| ) | ||
|
|
||
| func newFederationService() { | ||
| if err := Cfg.Section("federation").MapTo(&Federation); err != nil { | ||
| log.Fatal("Failed to map Federation settings: %v", err) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| // Copyright 2021 The Gitea Authors. All rights reserved. | ||
| // Use of this source code is governed by a MIT-style | ||
| // license that can be found in the LICENSE file. | ||
|
|
||
| package structs | ||
|
|
||
| // NodeInfo contains standardized way of exposing metadata about a server running one of the distributed social networks | ||
| type NodeInfo struct { | ||
| Version string `json:"version"` | ||
| Software NodeInfoSoftware `json:"software"` | ||
| Protocols []string `json:"protocols"` | ||
| Services NodeInfoServices `json:"services"` | ||
| OpenRegistrations bool `json:"openRegistrations"` | ||
| Usage NodeInfoUsage `json:"usage"` | ||
| Metadata struct{} `json:"metadata"` | ||
| } | ||
|
|
||
| // NodeInfoSoftware contains Metadata about server software in use | ||
| type NodeInfoSoftware struct { | ||
| Name string `json:"name"` | ||
| Version string `json:"version"` | ||
| Repository string `json:"repository"` | ||
| Homepage string `json:"homepage"` | ||
| } | ||
|
|
||
| // NodeInfoServices contains the third party sites this server can connect to via their application API | ||
| type NodeInfoServices struct { | ||
| Inbound []string `json:"inbound"` | ||
| Outbound []string `json:"outbound"` | ||
| } | ||
|
|
||
| // NodeInfoUsage contains usage statistics for this server | ||
| type NodeInfoUsage struct { | ||
| Users NodeInfoUsageUsers `json:"users"` | ||
| LocalPosts int `json:"localPosts,omitempty"` | ||
| LocalComments int `json:"localComments,omitempty"` | ||
| } | ||
|
|
||
| // NodeInfoUsageUsers contains statistics about the users of this server | ||
| type NodeInfoUsageUsers struct { | ||
| Total int `json:"total,omitempty"` | ||
| ActiveHalfyear int `json:"activeHalfyear,omitempty"` | ||
| ActiveMonth int `json:"activeMonth,omitempty"` | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| // Copyright 2021 The Gitea Authors. All rights reserved. | ||
| // Use of this source code is governed by a MIT-style | ||
| // license that can be found in the LICENSE file. | ||
|
|
||
| package misc | ||
|
|
||
| import ( | ||
| "net/http" | ||
|
|
||
| "code.gitea.io/gitea/modules/context" | ||
| "code.gitea.io/gitea/modules/setting" | ||
| "code.gitea.io/gitea/modules/structs" | ||
| ) | ||
|
|
||
| // NodeInfo returns the NodeInfo for the Gitea instance to allow for federation | ||
| func NodeInfo(ctx *context.APIContext) { | ||
| // swagger:operation GET /nodeinfo miscellaneous getNodeInfo | ||
| // --- | ||
| // summary: Returns the nodeinfo of the Gitea application | ||
| // produces: | ||
| // - application/json | ||
| // responses: | ||
| // "200": | ||
| // "$ref": "#/responses/NodeInfo" | ||
|
|
||
| nodeInfo := &structs.NodeInfo{ | ||
| Version: "2.1", | ||
| Software: structs.NodeInfoSoftware{ | ||
| Name: "gitea", | ||
| Version: setting.AppVer, | ||
| Repository: "https://github.com/go-gitea/gitea.git", | ||
| Homepage: "https://gitea.io/", | ||
| }, | ||
| Protocols: []string{"activitypub"}, | ||
| Services: structs.NodeInfoServices{ | ||
| Inbound: []string{}, | ||
| Outbound: []string{}, | ||
| }, | ||
| OpenRegistrations: setting.Service.ShowRegistrationButton, | ||
| Usage: structs.NodeInfoUsage{ | ||
| Users: structs.NodeInfoUsageUsers{}, | ||
| }, | ||
| } | ||
| ctx.JSON(http.StatusOK, nodeInfo) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| // Copyright 2021 The Gitea Authors. All rights reserved. | ||
| // Use of this source code is governed by a MIT-style | ||
| // license that can be found in the LICENSE file. | ||
|
|
||
| package swagger | ||
|
|
||
| import ( | ||
| api "code.gitea.io/gitea/modules/structs" | ||
| ) | ||
|
|
||
| // NodeInfo | ||
| // swagger:response NodeInfo | ||
| type swaggerResponseNodeInfo struct { | ||
| // in:body | ||
| Body api.NodeInfo `json:"body"` | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| // Copyright 2021 The Gitea Authors. All rights reserved. | ||
| // Use of this source code is governed by a MIT-style | ||
| // license that can be found in the LICENSE file. | ||
|
|
||
| package web | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "net/http" | ||
|
|
||
| "code.gitea.io/gitea/modules/context" | ||
| "code.gitea.io/gitea/modules/setting" | ||
| ) | ||
|
|
||
| type nodeInfoLinks struct { | ||
| Links []nodeInfoLink `json:"links"` | ||
| } | ||
|
|
||
| type nodeInfoLink struct { | ||
| Href string `json:"href"` | ||
| Rel string `json:"rel"` | ||
| } | ||
|
|
||
| // NodeInfoLinks returns links to the node info endpoint | ||
| func NodeInfoLinks(ctx *context.Context) { | ||
| nodeinfolinks := &nodeInfoLinks{ | ||
| Links: []nodeInfoLink{{ | ||
| fmt.Sprintf("%sapi/v1/nodeinfo", setting.AppURL), | ||
| "http://nodeinfo.diaspora.software/ns/schema/2.1", | ||
| }}, | ||
| } | ||
| ctx.JSON(http.StatusOK, nodeinfolinks) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters