forgejo/routers/api/v1/activitypub/repository.go

341 lines
9.9 KiB
Go
Raw Normal View History

// Copyright 2023 The forgejo Authors. All rights reserved.
2023-10-20 15:16:04 +02:00
// SPDX-License-Identifier: MIT
package activitypub
import (
"fmt"
2023-11-29 15:34:02 +01:00
"io"
2023-10-20 15:16:04 +02:00
"net/http"
2023-12-05 14:49:27 +01:00
"net/url"
"strings"
2023-12-07 13:54:07 +01:00
"time"
2023-10-20 15:16:04 +02:00
2023-12-01 17:06:39 +01:00
"code.gitea.io/gitea/models/db"
2023-12-09 14:27:29 +01:00
"code.gitea.io/gitea/models/forgefed"
2023-12-07 13:17:51 +01:00
repo_model "code.gitea.io/gitea/models/repo"
user_model "code.gitea.io/gitea/models/user"
2023-11-28 13:03:45 +01:00
api "code.gitea.io/gitea/modules/activitypub"
2023-10-20 15:16:04 +02:00
"code.gitea.io/gitea/modules/context"
"code.gitea.io/gitea/modules/log"
"code.gitea.io/gitea/modules/setting"
2023-12-05 10:37:51 +01:00
"code.gitea.io/gitea/modules/util"
2023-11-10 14:26:13 +01:00
"code.gitea.io/gitea/modules/web"
2023-12-05 10:37:51 +01:00
"github.com/google/uuid"
ap "github.com/go-ap/activitypub"
2023-12-05 11:38:36 +01:00
pwd_gen "github.com/sethvargo/go-password/password"
2023-10-20 15:16:04 +02:00
)
2023-12-12 11:04:03 +01:00
// TODO: remove this global var!
2023-12-05 14:49:27 +01:00
var actionsUser = user_model.NewActionsUser()
func generateUUIDMail(person ap.Actor) (string, error) {
// UUID@remote.host
id := uuid.New().String()
//url, err := url.Parse(person.URL.GetID().String())
//host := url.Host
return strings.Join([]string{id, "example.com"}, "@"), nil
}
func generateRemoteUserName(person ap.Actor) (string, error) {
u, err := url.Parse(person.URL.GetID().String())
if err != nil {
return "", err
}
host := strings.Split(u.Host, ":")[0] // no port in username
if name := person.PreferredUsername.String(); name != "" {
return strings.Join([]string{name, host}, "_"), nil
}
if name := person.Name.String(); name != "" {
return strings.Join([]string{name, host}, "_"), nil
}
return "", fmt.Errorf("empty name, preferredUsername field")
}
func generateRandomPassword() (string, error) {
// Generate a password that is 64 characters long with 10 digits, 10 symbols,
// allowing upper and lower case letters, disallowing repeat characters.
res, err := pwd_gen.Generate(32, 10, 10, false, false)
if err != nil {
return "", err
}
return res, err
}
2023-12-12 11:04:03 +01:00
// TODO: Move this to model.user.search ? or to model.user.externalLoginUser ?
func SearchUsersByLoginName(loginName string) ([]*user_model.User, error) {
2023-12-05 14:49:27 +01:00
actionsUser.IsAdmin = true
options := &user_model.SearchUserOptions{
2023-12-12 11:04:03 +01:00
LoginName: loginName,
2023-12-05 14:49:27 +01:00
Actor: actionsUser,
Type: user_model.UserTypeRemoteUser,
OrderBy: db.SearchOrderByAlphabetically,
ListOptions: db.ListOptions{PageSize: 1},
IsActive: util.OptionalBoolFalse,
IncludeReserved: true,
}
users, _, err := user_model.SearchUsers(db.DefaultContext, options)
if err != nil {
return []*user_model.User{}, fmt.Errorf("search failed: %v", err)
}
log.Info("local found users: %v", len(users))
return users, nil
}
2023-12-12 11:04:03 +01:00
// TODO: Move most of this fkt to http client
2023-12-08 11:54:07 +01:00
func getBody(remoteStargazer, starReceiver string, ctx *context.APIContext) ([]byte, error) { // ToDo: We could split this: move body reading to unmarshall
2023-12-06 15:13:53 +01:00
2023-12-06 18:32:26 +01:00
// TODO: The star receiver signs the http get request will maybe not work.
// The remote repo has probably diferent keys as the local one.
// > The local user signs the request with their private key, the public key is publicly available to anyone. I do not see an issue here.
2023-12-06 18:32:26 +01:00
// Why should we use a signed request here at all?
// > To provide an extra layer of security against in flight tampering: https://github.com/go-fed/httpsig/blob/55836744818e/httpsig.go#L116
2023-12-08 11:54:07 +01:00
client, err := api.NewClient(ctx, actionsUser, starReceiver) // ToDo: Do we get a publicKeyId of owner or repo?
2023-12-06 15:13:53 +01:00
if err != nil {
return []byte{0}, err
2023-12-06 15:13:53 +01:00
}
// get_person_by_rest
response, err := client.Get([]byte{0}, remoteStargazer)
2023-12-06 15:13:53 +01:00
if err != nil {
return []byte{0}, err
2023-12-06 15:13:53 +01:00
}
defer response.Body.Close()
body, err := io.ReadAll(response.Body)
if err != nil {
return []byte{0}, err
2023-12-06 15:13:53 +01:00
}
log.Info("remoteStargazer: %v", remoteStargazer)
log.Info("http client. %v", client)
log.Info("response: %v\n error: ", response, err)
return body, nil
}
2023-12-12 11:04:03 +01:00
// TODO: move this to Person or actor
func unmarshallPersonJSON(body []byte) (ap.Person, error) {
2023-12-06 15:13:53 +01:00
// parse response
person := ap.Person{}
err := person.UnmarshalJSON(body)
2023-12-06 15:13:53 +01:00
if err != nil {
return ap.Person{}, err
}
log.Info("Person is: %v", person)
log.Info("Person Name is: %v", person.PreferredUsername)
log.Info("Person URL is: %v", person.URL)
return person, nil
}
2023-12-12 11:04:03 +01:00
// TODO: move this to model.user somwhere ?
func createFederatedUserFromPerson(person ap.Person, remoteStargazer string) (*user_model.User, error) {
2023-12-06 15:56:26 +01:00
email, err := generateUUIDMail(person)
if err != nil {
return &user_model.User{}, err
2023-12-06 15:56:26 +01:00
}
username, err := generateRemoteUserName(person)
if err != nil {
return &user_model.User{}, err
2023-12-06 15:56:26 +01:00
}
password, err := generateRandomPassword()
if err != nil {
return &user_model.User{}, err
2023-12-06 15:56:26 +01:00
}
user := &user_model.User{
LowerName: strings.ToLower(username),
Name: username,
Email: email,
EmailNotificationsPreference: "disabled",
Passwd: password,
MustChangePassword: false,
LoginName: remoteStargazer,
Type: user_model.UserTypeRemoteUser,
IsAdmin: false,
}
return user, nil
}
2023-12-06 15:56:26 +01:00
2023-12-12 11:04:03 +01:00
// TODO: move this to model.user somwhere ?
func saveFederatedUserRecord(ctx *context.APIContext, user *user_model.User) error {
2023-12-06 15:56:26 +01:00
overwriteDefault := &user_model.CreateUserOverwriteOptions{
IsActive: util.OptionalBoolFalse,
IsRestricted: util.OptionalBoolFalse,
}
if err := user_model.CreateUser(ctx, user, overwriteDefault); err != nil {
return err
}
log.Info("User created!")
return nil
}
2023-10-20 15:16:04 +02:00
// Repository function returns the Repository actor for a repo
func Repository(ctx *context.APIContext) {
// swagger:operation GET /activitypub/repository-id/{repository-id} activitypub activitypubRepository
// ---
// summary: Returns the Repository actor for a repo
// produces:
// - application/json
// parameters:
// - name: repository-id
// in: path
// description: repository ID of the repo
// type: integer
// required: true
// responses:
// "200":
// "$ref": "#/responses/ActivityPub"
2023-11-15 12:10:31 +01:00
link := fmt.Sprintf("%s/api/v1/activitypub/repository-id/%d", strings.TrimSuffix(setting.AppURL, "/"), ctx.Repo.Repository.ID)
2023-11-06 18:29:48 +01:00
repo := forgefed.RepositoryNew(ap.IRI(link))
2023-11-06 18:29:48 +01:00
repo.Name = ap.NaturalLanguageValuesNew()
err := repo.Name.Set("en", ap.Content(ctx.Repo.Repository.Name))
if err != nil {
2023-11-06 18:29:48 +01:00
ctx.ServerError("Set Name", err)
return
}
2023-11-06 18:29:48 +01:00
response(ctx, repo)
2023-10-20 15:16:04 +02:00
}
// PersonInbox function handles the incoming data for a repository inbox
func RepositoryInbox(ctx *context.APIContext) {
// swagger:operation POST /activitypub/repository-id/{repository-id}/inbox activitypub activitypubRepository
// ---
// summary: Send to the inbox
// produces:
// - application/json
// parameters:
// - name: repository-id
// in: path
// description: repository ID of the repo
// type: integer
// required: true
2023-11-08 08:56:22 +01:00
// - name: body
// in: body
// schema:
// "$ref": "#/definitions/Star"
2023-10-20 15:16:04 +02:00
// responses:
// "204":
// "$ref": "#/responses/empty"
var user *user_model.User
2023-12-08 18:09:22 +01:00
repository := ctx.Repo.Repository
log.Info("RepositoryInbox: repo: %v, owned by: %v", repository.Name, repository.OwnerName)
2023-12-01 17:06:39 +01:00
activity := web.GetForm(ctx).(*forgefed.Star)
2023-12-08 18:09:22 +01:00
log.Info("RepositoryInbox: Activity.Source: %v, Activity.Actor %v, Activity.Actor.Id %v", activity.Source, activity.Actor, activity.Actor.GetID().String())
2023-11-03 17:45:53 +01:00
2023-12-09 19:11:38 +01:00
// parse actorId (person)
2023-12-09 14:53:40 +01:00
actorId, err := forgefed.NewPersonId(activity.Actor.GetID().String(), string(activity.Source))
if err != nil {
2023-12-08 19:52:09 +01:00
ctx.ServerError("Validate actorId", err)
2023-12-08 18:09:22 +01:00
return
}
2023-12-09 19:11:38 +01:00
log.Info("RepositoryInbox: actorId parsed: %v", actorId)
// parse objectId (repository)
objectId, err := forgefed.NewRepositoryId(activity.Object.GetID().String(), string(activity.Source))
if err != nil {
2023-12-12 11:04:03 +01:00
ctx.ServerError("Validate objectId", err)
return
}
if objectId.Id != fmt.Sprint(repository.ID) {
ctx.ServerError("Validate objectId", err)
2023-12-09 19:11:38 +01:00
return
}
log.Info("RepositoryInbox: objectId parsed: %v", objectId)
2023-12-12 11:04:03 +01:00
adctorAsWebfinger := actorId.AsWebfinger() // used as LoginName in newly created user
log.Info("remotStargazer: %v", adctorAsWebfinger)
2023-11-15 12:29:17 +01:00
2023-12-01 15:07:13 +01:00
// Check if user already exists
2023-12-12 11:04:03 +01:00
users, err := SearchUsersByLoginName(adctorAsWebfinger)
2023-12-05 10:37:51 +01:00
if err != nil {
panic(fmt.Errorf("searching for user failed: %v", err))
2023-12-05 10:37:51 +01:00
}
switch len(users) {
case 0:
{
2023-12-12 11:04:03 +01:00
body, err := getBody(adctorAsWebfinger, "does not exist yet", ctx) // ToDo: We would need to insert the repo or its owners key here
if err != nil {
panic(fmt.Errorf("http get failed: %v", err))
}
person, err := unmarshallPersonJSON(body)
if err != nil {
panic(fmt.Errorf("getting user failed: %v", err))
}
2023-12-12 11:04:03 +01:00
user, err = createFederatedUserFromPerson(person, adctorAsWebfinger)
if err != nil {
panic(fmt.Errorf("create federated user: %w", err))
}
err = saveFederatedUserRecord(ctx, user)
if err != nil {
panic(fmt.Errorf("save user: %w", err))
}
}
case 1:
{
user = users[0]
2023-12-08 15:44:00 +01:00
log.Info("Found user full name was: %v", user.FullName)
log.Info("Found user name was: %v", user.Name)
2023-12-09 19:11:38 +01:00
log.Info("Found user loginname was: %v", user.LoginName)
log.Info("%v", user)
2023-12-06 15:37:58 +01:00
}
default:
{
panic(fmt.Errorf("found more than one matches for federated users"))
2023-12-05 10:37:51 +01:00
}
}
2023-12-06 15:56:26 +01:00
2023-12-09 19:11:38 +01:00
// TODO: why should we search user for a second time from db?
2023-12-07 13:24:01 +01:00
remoteUser, err := user_model.GetUserByEmail(ctx, user.Email)
if err != nil {
ctx.Error(http.StatusInternalServerError, "StarRepo", err)
return
2023-12-01 11:56:12 +01:00
}
2023-12-05 10:37:51 +01:00
2023-12-07 13:24:01 +01:00
// check if already starred by this user
2023-12-08 18:09:22 +01:00
alreadyStared := repo_model.IsStaring(ctx, remoteUser.ID, repository.ID)
2023-12-07 13:24:01 +01:00
switch alreadyStared {
case true: // execute unstar action
{
2023-12-08 18:09:22 +01:00
err = repo_model.StarRepo(ctx, remoteUser.ID, repository.ID, false)
2023-12-07 13:24:01 +01:00
if err != nil {
ctx.Error(http.StatusInternalServerError, "StarRepo", err)
return
}
}
case false: // execute star action
{
2023-12-08 18:09:22 +01:00
err = repo_model.StarRepo(ctx, remoteUser.ID, repository.ID, true)
2023-12-07 13:24:01 +01:00
if err != nil {
ctx.Error(http.StatusInternalServerError, "StarRepo", err)
return
}
}
}
2023-11-30 16:10:26 +01:00
2023-12-07 13:54:07 +01:00
// wait 5 sec.
time.Sleep(5 * time.Second)
2023-11-10 14:10:23 +01:00
2023-10-20 15:16:04 +02:00
ctx.Status(http.StatusNoContent)
}