User keypairs and HTTP signatures for ActivityPub federation using go-ap #19133
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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,133 @@ | ||
| // Copyright 2022 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 integrations | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "net/http" | ||
| "net/http/httptest" | ||
| "net/url" | ||
| "testing" | ||
|
|
||
| user_model "code.gitea.io/gitea/models/user" | ||
| "code.gitea.io/gitea/modules/activitypub" | ||
| "code.gitea.io/gitea/modules/json" | ||
| "code.gitea.io/gitea/modules/setting" | ||
|
|
||
| "github.com/go-fed/activity/pub" | ||
| "github.com/go-fed/activity/streams" | ||
| "github.com/go-fed/activity/streams/vocab" | ||
| "github.com/stretchr/testify/assert" | ||
| ) | ||
|
|
||
| func TestActivityPubPerson(t *testing.T) { | ||
| onGiteaRun(t, func(*testing.T, *url.URL) { | ||
| setting.Federation.Enabled = true | ||
| defer func() { | ||
| setting.Federation.Enabled = false | ||
| }() | ||
|
|
||
| username := "user2" | ||
| req := NewRequestf(t, "GET", fmt.Sprintf("/api/v1/activitypub/user/%s", username)) | ||
| resp := MakeRequest(t, req, http.StatusOK) | ||
| assert.Contains(t, resp.Body.String(), "@context") | ||
| var m map[string]interface{} | ||
| err := json.Unmarshal(resp.Body.Bytes(), &m) | ||
This conversation was marked as resolved.
Show resolved
Hide resolved
|
||
| assert.Equal(t, err, nil) | ||
This conversation was marked as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| var person vocab.ActivityStreamsPerson | ||
| resolver, _ := streams.NewJSONResolver(func(c context.Context, p vocab.ActivityStreamsPerson) error { | ||
| person = p | ||
| return nil | ||
| }) | ||
| ctx := context.Background() | ||
| err = resolver.Resolve(ctx, m) | ||
| assert.Equal(t, err, nil) | ||
This conversation was marked as resolved.
Show resolved
Hide resolved
|
||
| assert.Equal(t, "Person", person.GetTypeName()) | ||
| assert.Equal(t, username, person.GetActivityStreamsName().Begin().GetXMLSchemaString()) | ||
| keyID := person.GetJSONLDId().GetIRI().String() | ||
| assert.Regexp(t, fmt.Sprintf("activitypub/user/%s$", username), keyID) | ||
This conversation was marked as resolved.
Show resolved
Hide resolved
|
||
| assert.Regexp(t, fmt.Sprintf("activitypub/user/%s/outbox$", username), person.GetActivityStreamsOutbox().GetIRI().String()) | ||
| assert.Regexp(t, fmt.Sprintf("activitypub/user/%s/inbox$", username), person.GetActivityStreamsInbox().GetIRI().String()) | ||
|
|
||
| pkp := person.GetW3IDSecurityV1PublicKey() | ||
This conversation was marked as resolved.
Show resolved
Hide resolved
|
||
| assert.NotNil(t, pkp) | ||
| publicKeyID := keyID + "/#main-key" | ||
| var pkpFound vocab.W3IDSecurityV1PublicKey | ||
| for pkpIter := pkp.Begin(); pkpIter != pkp.End(); pkpIter = pkpIter.Next() { | ||
| if !pkpIter.IsW3IDSecurityV1PublicKey() { | ||
| continue | ||
| } | ||
| pkValue := pkpIter.Get() | ||
| var pkID *url.URL | ||
| pkID, err = pub.GetId(pkValue) | ||
| if err != nil { | ||
| return | ||
| } | ||
| assert.Equal(t, pkID.String(), publicKeyID) | ||
This conversation was marked as resolved.
Show resolved
Hide resolved
|
||
| if pkID.String() != publicKeyID { | ||
| continue | ||
| } | ||
| pkpFound = pkValue | ||
| break | ||
| } | ||
| assert.NotNil(t, pkpFound) | ||
|
|
||
| pkPemProp := pkpFound.GetW3IDSecurityV1PublicKeyPem() | ||
| assert.NotNil(t, pkPemProp) | ||
| assert.True(t, pkPemProp.IsXMLSchemaString()) | ||
|
|
||
| pubKeyPem := pkPemProp.Get() | ||
| assert.Regexp(t, "^-----BEGIN PUBLIC KEY-----", pubKeyPem) | ||
| }) | ||
| } | ||
|
|
||
| func TestActivityPubMissingPerson(t *testing.T) { | ||
| onGiteaRun(t, func(*testing.T, *url.URL) { | ||
| setting.Federation.Enabled = true | ||
| defer func() { | ||
| setting.Federation.Enabled = false | ||
| }() | ||
|
|
||
| req := NewRequestf(t, "GET", "/api/v1/activitypub/user/nonexistentuser") | ||
| resp := MakeRequest(t, req, http.StatusNotFound) | ||
| assert.Contains(t, resp.Body.String(), "GetUserByName") | ||
| }) | ||
| } | ||
|
|
||
| func TestActivityPubPersonInbox(t *testing.T) { | ||
| srv := httptest.NewServer(c) | ||
| defer srv.Close() | ||
|
|
||
| onGiteaRun(t, func(*testing.T, *url.URL) { | ||
| appURL := setting.AppURL | ||
| setting.Federation.Enabled = true | ||
| setting.Database.LogSQL = true | ||
This conversation was marked as resolved.
Show resolved
Hide resolved
|
||
| setting.AppURL = srv.URL | ||
| defer func() { | ||
| setting.Federation.Enabled = false | ||
| setting.Database.LogSQL = false | ||
| setting.AppURL = appURL | ||
| }() | ||
| username1 := "user1" | ||
| user1, err := user_model.GetUserByName(username1) | ||
| assert.NoError(t, err) | ||
| user1url := fmt.Sprintf("%s/api/v1/activitypub/user/%s/#main-key", srv.URL, username1) | ||
| c, err := activitypub.NewClient(user1, user1url) | ||
| assert.NoError(t, err) | ||
| username2 := "user2" | ||
| user2inboxurl := fmt.Sprintf("%s/api/v1/activitypub/user/%s/inbox", srv.URL, username2) | ||
|
|
||
| // Signed request succeeds | ||
| resp, err := c.Post([]byte{}, user2inboxurl) | ||
| assert.NoError(t, err) | ||
| assert.Equal(t, 204, resp.StatusCode) | ||
This conversation was marked as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| // Unsigned request fails | ||
| req := NewRequest(t, "POST", user2inboxurl) | ||
| MakeRequest(t, req, 500) | ||
This conversation was marked as resolved.
Show resolved
Hide resolved
|
||
| }) | ||
| } | ||
This file contains hidden or 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,127 @@ | ||
| // Copyright 2022 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 activitypub | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "crypto/rsa" | ||
| "crypto/x509" | ||
| "encoding/pem" | ||
| "fmt" | ||
| "net/http" | ||
|
|
||
| user_model "code.gitea.io/gitea/models/user" | ||
| "code.gitea.io/gitea/modules/setting" | ||
|
|
||
| "github.com/go-fed/activity/pub" | ||
| "github.com/go-fed/httpsig" | ||
| ) | ||
|
|
||
| const ( | ||
| // ActivityStreamsContentType const | ||
| ActivityStreamsContentType = "application/ld+json; profile=\"https://www.w3.org/ns/activitystreams\"" | ||
This conversation was marked as resolved.
Show resolved
Hide resolved
|
||
| ) | ||
|
|
||
| func containsRequiredHTTPHeaders(method string, headers []string) error { | ||
| var hasRequestTarget, hasDate, hasDigest bool | ||
| for _, header := range headers { | ||
| hasRequestTarget = hasRequestTarget || header == httpsig.RequestTarget | ||
| hasDate = hasDate || header == "Date" | ||
| hasDigest = method == "GET" || hasDigest || header == "Digest" | ||
| } | ||
| if !hasRequestTarget { | ||
| return fmt.Errorf("missing http header for %s: %s", method, httpsig.RequestTarget) | ||
| } else if !hasDate { | ||
| return fmt.Errorf("missing http header for %s: Date", method) | ||
| } else if !hasDigest { | ||
| return fmt.Errorf("missing http header for %s: Digest", method) | ||
This conversation was marked as resolved.
Show resolved
Hide resolved
|
||
| } | ||
| return nil | ||
| } | ||
|
|
||
| // Client struct | ||
| type Client struct { | ||
| clock pub.Clock | ||
| client *http.Client | ||
| algs []httpsig.Algorithm | ||
| digestAlg httpsig.DigestAlgorithm | ||
| getHeaders []string | ||
| postHeaders []string | ||
| priv *rsa.PrivateKey | ||
| pubID string | ||
| } | ||
|
|
||
| // NewClient function | ||
| func NewClient(user *user_model.User, pubID string) (c *Client, err error) { | ||
| if err = containsRequiredHTTPHeaders(http.MethodGet, setting.Federation.GetHeaders); err != nil { | ||
| return | ||
|
There was a problem hiding this comment. Given that there is currently a PR that attempts to get rid of naked returns, I think you should convert them. |
||
| } else if err = containsRequiredHTTPHeaders(http.MethodPost, setting.Federation.PostHeaders); err != nil { | ||
| return | ||
| } else if !httpsig.IsSupportedDigestAlgorithm(setting.Federation.DigestAlgorithm) { | ||
| err = fmt.Errorf("unsupported digest algorithm: %s", setting.Federation.DigestAlgorithm) | ||
| return | ||
| } | ||
This conversation was marked as resolved.
Show resolved
Hide resolved
|
||
| algos := make([]httpsig.Algorithm, len(setting.Federation.Algorithms)) | ||
| for i, algo := range setting.Federation.Algorithms { | ||
| algos[i] = httpsig.Algorithm(algo) | ||
| } | ||
This conversation was marked as resolved.
Show resolved
Hide resolved
|
||
| clock, err := NewClock() | ||
| if err != nil { | ||
| return | ||
| } | ||
|
|
||
| priv, err := GetPrivateKey(user) | ||
| if err != nil { | ||
| return | ||
| } | ||
| privPem, _ := pem.Decode([]byte(priv)) | ||
| privParsed, err := x509.ParsePKCS1PrivateKey(privPem.Bytes) | ||
| if err != nil { | ||
| return | ||
| } | ||
|
|
||
| c = &Client{ | ||
| clock: clock, | ||
| client: &http.Client{}, | ||
This conversation was marked as resolved.
Show resolved
Hide resolved
|
||
| algs: algos, | ||
| digestAlg: httpsig.DigestAlgorithm(setting.Federation.DigestAlgorithm), | ||
| getHeaders: setting.Federation.GetHeaders, | ||
| postHeaders: setting.Federation.PostHeaders, | ||
| priv: privParsed, | ||
| pubID: pubID, | ||
| } | ||
| return | ||
| } | ||
|
|
||
| // NewRequest function | ||
| func (c *Client) NewRequest(b []byte, to string) (req *http.Request, err error) { | ||
| byteCopy := make([]byte, len(b)) | ||
| copy(byteCopy, b) | ||
| buf := bytes.NewBuffer(byteCopy) | ||
This conversation was marked as resolved.
Show resolved
Hide resolved
|
||
| req, err = http.NewRequest(http.MethodPost, to, buf) | ||
| if err != nil { | ||
| return | ||
| } | ||
| req.Header.Add("Content-Type", ActivityStreamsContentType) | ||
| req.Header.Add("Accept-Charset", "utf-8") | ||
| req.Header.Add("Date", fmt.Sprintf("%s GMT", c.clock.Now().UTC().Format("Mon, 02 Jan 2006 15:04:05"))) | ||
This conversation was marked as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| signer, _, err := httpsig.NewSigner(c.algs, c.digestAlg, c.postHeaders, httpsig.Signature, 60) | ||
This conversation was marked as resolved.
Show resolved
Hide resolved
|
||
| if err != nil { | ||
| return | ||
| } | ||
| err = signer.SignRequest(c.priv, c.pubID, req, b) | ||
| return | ||
| } | ||
|
|
||
| // Post function | ||
| func (c *Client) Post(b []byte, to string) (resp *http.Response, err error) { | ||
| var req *http.Request | ||
| if req, err = c.NewRequest(b, to); err != nil { | ||
| return | ||
| } | ||
| resp, err = c.client.Do(req) | ||
| return | ||
| } | ||
This file contains hidden or 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,49 @@ | ||
| // Copyright 2022 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 activitypub | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "io" | ||
| "net/http" | ||
| "net/http/httptest" | ||
| "regexp" | ||
| "testing" | ||
|
|
||
| "code.gitea.io/gitea/models/unittest" | ||
| user_model "code.gitea.io/gitea/models/user" | ||
| "code.gitea.io/gitea/modules/setting" | ||
|
|
||
| _ "code.gitea.io/gitea/models" // https://discourse.gitea.io/t/testfixtures-could-not-clean-table-access-no-such-table-access/4137/4 | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
| ) | ||
|
|
||
| func TestActivityPubSignedPost(t *testing.T) { | ||
| assert.NoError(t, unittest.PrepareTestDatabase()) | ||
| user := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 1}).(*user_model.User) | ||
| pubID := "https://example.com/pubID" | ||
| c, err := NewClient(user, pubID) | ||
| assert.NoError(t, err) | ||
|
|
||
| expected := "BODY" | ||
| srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { | ||
| assert.Regexp(t, regexp.MustCompile("^"+setting.Federation.DigestAlgorithm), r.Header.Get("Digest")) | ||
| assert.Contains(t, r.Header.Get("Signature"), pubID) | ||
| assert.Equal(t, r.Header.Get("Content-Type"), ActivityStreamsContentType) | ||
| body, err := io.ReadAll(r.Body) | ||
| assert.NoError(t, err) | ||
| assert.Equal(t, expected, string(body)) | ||
| fmt.Fprintf(w, expected) | ||
| })) | ||
| defer srv.Close() | ||
|
|
||
| r, err := c.Post([]byte(expected), srv.URL) | ||
| assert.NoError(t, err) | ||
| defer r.Body.Close() | ||
| body, err := io.ReadAll(r.Body) | ||
| assert.NoError(t, err) | ||
| assert.Equal(t, expected, string(body)) | ||
| } |
This file contains hidden or 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,29 @@ | ||
| // Copyright 2022 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 activitypub | ||
|
|
||
| import ( | ||
| "time" | ||
|
|
||
| "code.gitea.io/gitea/modules/setting" | ||
|
|
||
| "github.com/go-fed/activity/pub" | ||
| ) | ||
|
|
||
| var _ pub.Clock = &Clock{} | ||
|
|
||
| // Clock struct | ||
| type Clock struct{} | ||
This conversation was marked as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| // NewClock function | ||
| func NewClock() (c *Clock, err error) { | ||
| c = &Clock{} | ||
| return | ||
| } | ||
|
|
||
| // Now function | ||
| func (c *Clock) Now() time.Time { | ||
| return time.Now().In(setting.DefaultUILocation) | ||
This conversation was marked as resolved.
Show resolved
Hide resolved
|
||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.