Skip to content
  • Categories
  • Recent
  • Tags
  • Popular
  • World
  • Users
  • Groups
Skins
  • Light
  • Cerulean
  • Cosmo
  • Flatly
  • Journal
  • Litera
  • Lumen
  • Lux
  • Materia
  • Minty
  • Morph
  • Pulse
  • Sandstone
  • Simplex
  • Sketchy
  • Spacelab
  • United
  • Yeti
  • Zephyr
  • Dark
  • Cyborg
  • Darkly
  • Quartz
  • Slate
  • Solar
  • Superhero
  • Vapor

  • Default (No Skin)
  • No Skin
Collapse
We Distribute
  1. Home
  2. General Discussion
  3. I think the #ActivityPub client-to-server API is extremely important and underrated.

I think the #ActivityPub client-to-server API is extremely important and underrated.

Scheduled Pinned Locked Moved General Discussion
activitypubfediverse
115 Posts 13 Posters 0 Views
  • Oldest to Newest
  • Newest to Oldest
  • Most Votes
Reply
  • Reply as topic
Log in to reply
This topic has been deleted. Only users with topic management privileges can see it.
  • mariusor@metalhead.clubM mariusor@metalhead.club

    @steve OK, but why?

    I feel like I explained my position relatively clearly, I would like to understand yours, even though I feel some animosity has started to crop up.

    @smallcircles @evan

    steve@social.technoetic.comS This user is from outside of this forum
    steve@social.technoetic.comS This user is from outside of this forum
    steve@social.technoetic.com
    wrote last edited by
    #78

    @mariusor @smallcircles @evan No animosity here. However, I’m not sure how to explain it more clearly. I’m referring to C2S as described in chapter 6 of the ActivityPub specification (and the conformance profiles in Section 2.1). It sounded to me like you’re using a more general definition of “client”, which is fine, just different in significant ways (if it only dereferences and renders AP data).

    smallcircles@social.coopS 1 Reply Last reply
    0
    • evan@cosocial.caE evan@cosocial.ca

      @smallcircles @steve maybe? I guess you could consider the `sharedInbox` to be like that.

      I think that activities sent to the API by a client are kind of like commands, but they can also be events that happened on a different system.

      If I got an achievement in a game, and that was sent as an activity to the API, it's more like an event notification than a command.

      smallcircles@social.coopS This user is from outside of this forum
      smallcircles@social.coopS This user is from outside of this forum
      smallcircles@social.coop
      wrote last edited by
      #79

      @evan @steve

      Rather than sharedInbox I was more thinking that by implementing the HTTP API and msg exchanges in a well-prescribed manner, these would effectively model an event bus conceptually. After which you can talk about it as a higher abstraction that exists, and not get lost in the reeds of the impl details anymore.

      evan@cosocial.caE 1 Reply Last reply
      0
      • steve@social.technoetic.comS steve@social.technoetic.com

        @mariusor @smallcircles @evan No animosity here. However, I’m not sure how to explain it more clearly. I’m referring to C2S as described in chapter 6 of the ActivityPub specification (and the conformance profiles in Section 2.1). It sounded to me like you’re using a more general definition of “client”, which is fine, just different in significant ways (if it only dereferences and renders AP data).

        smallcircles@social.coopS This user is from outside of this forum
        smallcircles@social.coopS This user is from outside of this forum
        smallcircles@social.coop
        wrote last edited by
        #80

        @steve @mariusor @evan

        He he, language is hard. A case of terminology overload and clashing terms. Domain driven design has the clearly defined bounded context here which is the scope within which terms are valid. Forming a consistency boundary. These context lines are blurred in fediverse talk. 😅

        evan@cosocial.caE 1 Reply Last reply
        0
        • mariusor@metalhead.clubM mariusor@metalhead.club

          @thisismissem I have just implemented that for the GoActivityPub servers and it's easier than it sounds.

          The only important step required is to convert the client authorization token (presumably an OAuth2 bearer token) to a valid actor and then further to a valid Private Key with which to sign the remote request. After that the only thing remaining is to pipe verbatim the received response to the client...

          @steve @smallcircles @evan

          thisismissem@hachyderm.ioT This user is from outside of this forum
          thisismissem@hachyderm.ioT This user is from outside of this forum
          thisismissem@hachyderm.io
          wrote last edited by
          #81

          @mariusor @steve @smallcircles @evan well, your server *knows* it's access token to user mapping, so then you're just doing authorised fetch as that actor from server side

          mariusor@metalhead.clubM 1 Reply Last reply
          0
          • benpate@mastodon.socialB benpate@mastodon.social

            @thisismissem @steve @mariusor @smallcircles @evan

            Just checking my memory.. this concept exists already, yes?

            Link Preview Image
            ActivityPub/Primer/proxyUrl endpoint - W3C Wiki

            favicon

            (www.w3.org)

            Are you just saying that the new API spec should include this? Or am I missing something?

            thisismissem@hachyderm.ioT This user is from outside of this forum
            thisismissem@hachyderm.ioT This user is from outside of this forum
            thisismissem@hachyderm.io
            wrote last edited by
            #82

            @benpate @steve @mariusor @smallcircles @evan i'm not sure proxyUrl does what I'm thinking of here

            1 Reply Last reply
            0
            • evan@cosocial.caE evan@cosocial.ca

              @benpate @thisismissem @steve @mariusor @smallcircles

              Yes, proxyUrl already exists. There's a use case here:

              Link Preview Image
              Remote object access · Issue #10 · swicg/activitypub-api

              "As an ActivityPub client developer, I want a reliable method for accessing objects on remote servers with the user's authorization, so I can read private or followers-only data."

              favicon

              GitHub (github.com)

              The only other way I've seen this use case discussed is with client-side HTTP Signature keys. There's some kind of negotiation between the server and the client, and then the client can make requests to remote servers using HTTP Signature and a key it controls.

              thisismissem@hachyderm.ioT This user is from outside of this forum
              thisismissem@hachyderm.ioT This user is from outside of this forum
              thisismissem@hachyderm.io
              wrote last edited by
              #83

              @evan @benpate @steve @mariusor @smallcircles my understanding of proxyUrl is that it's just fetching a remote object, but without forwarding authorization

              For many cases you want to forward the request as the authenticated user to the remote server, not doing the request anonymously

              mariusor@metalhead.clubM 1 Reply Last reply
              0
              • thisismissem@hachyderm.ioT thisismissem@hachyderm.io

                @mariusor @steve @smallcircles @evan well, your server *knows* it's access token to user mapping, so then you're just doing authorised fetch as that actor from server side

                mariusor@metalhead.clubM This user is from outside of this forum
                mariusor@metalhead.clubM This user is from outside of this forum
                mariusor@metalhead.club
                wrote last edited by
                #84

                @thisismissem which is what proxyUrl is supposed to do, right?

                Did you mean it in a different way?

                @steve @smallcircles @evan

                1 Reply Last reply
                0
                • thisismissem@hachyderm.ioT thisismissem@hachyderm.io

                  @evan @benpate @steve @mariusor @smallcircles my understanding of proxyUrl is that it's just fetching a remote object, but without forwarding authorization

                  For many cases you want to forward the request as the authenticated user to the remote server, not doing the request anonymously

                  mariusor@metalhead.clubM This user is from outside of this forum
                  mariusor@metalhead.clubM This user is from outside of this forum
                  mariusor@metalhead.club
                  wrote last edited by
                  #85

                  @thisismissem it's not explicitly saying to forward authorization, but to me that's implied from "require authentication":

                  proxyUrl: Endpoint URI so this actor's clients may access remote ActivityStreams objects which require authentication to access

                  Link Preview Image
                  ActivityPub

                  favicon

                  (w3c.github.io)

                  @evan @benpate @steve @smallcircles

                  evan@cosocial.caE 1 Reply Last reply
                  0
                  • smallcircles@social.coopS smallcircles@social.coop

                    @evan @steve

                    Rather than sharedInbox I was more thinking that by implementing the HTTP API and msg exchanges in a well-prescribed manner, these would effectively model an event bus conceptually. After which you can talk about it as a higher abstraction that exists, and not get lost in the reeds of the impl details anymore.

                    evan@cosocial.caE This user is from outside of this forum
                    evan@cosocial.caE This user is from outside of this forum
                    evan@cosocial.ca
                    wrote last edited by
                    #86

                    @smallcircles @steve sure. I am not a fan of the idea that AP is a message-passing system; it's a read-write API.

                    smallcircles@social.coopS 1 Reply Last reply
                    0
                    • evan@cosocial.caE evan@cosocial.ca

                      @smallcircles @steve sure. I am not a fan of the idea that AP is a message-passing system; it's a read-write API.

                      smallcircles@social.coopS This user is from outside of this forum
                      smallcircles@social.coopS This user is from outside of this forum
                      smallcircles@social.coop
                      wrote last edited by
                      #87

                      @evan @steve

                      It is both, like in that diagram draft.. or at least could be considered such (the notes apply to Protosocial musings).

                      Link Preview Image
                      🫧 socialcoding.. (@smallcircles@social.coop)

                      Attached: 1 image @julian@activitypub.space @evan@cosocial.ca Btw, some time ago in a matrix discussion I sketched how I'd like to conceptually 'see' the social network. Not Mastodon-compliant per se (though it might be via a Profile or Bridge) but back to "promised land". Where the protocol is expressed in familiar architecture patterns and borrows concepts from message queuing, actor model, event-driven architecture, etc. Then as a "Solution designer" I am a stakeholder that wants to be completely shielded from all that jazz. That should all be encapsulated by the protocol libraries and SDK's that are offered in language variants across the ecosystem. #ActivityPub et al is a black box. I can directly start modeling what should be exchanged on the bus, and I can apply domain driven design here. And if I have a semantic web part of my app I'd use linked data modeling best-practices. I would have power tools like #EventCatalog and methods like #EventModeling. https://www.eventcatalog.dev/features/visualization https://eventmodeling.org/

                      favicon

                      social.coop (social.coop)

                      smallcircles@social.coopS 1 Reply Last reply
                      0
                      • mariusor@metalhead.clubM mariusor@metalhead.club

                        @thisismissem it's not explicitly saying to forward authorization, but to me that's implied from "require authentication":

                        proxyUrl: Endpoint URI so this actor's clients may access remote ActivityStreams objects which require authentication to access

                        Link Preview Image
                        ActivityPub

                        favicon

                        (w3c.github.io)

                        @evan @benpate @steve @smallcircles

                        evan@cosocial.caE This user is from outside of this forum
                        evan@cosocial.caE This user is from outside of this forum
                        evan@cosocial.ca
                        wrote last edited by
                        #88

                        @mariusor I have implemented it requiring OAuth on one side and using HTTP Signature on the other. I think you need to use the user's authorization for private content or to respect personal blocks. It sucks for caching but ¯\_(ツ)_/¯

                        @thisismissem @benpate @steve @smallcircles

                        mariusor@metalhead.clubM benpate@mastodon.socialB thisismissem@hachyderm.ioT 3 Replies Last reply
                        0
                        • evan@cosocial.caE evan@cosocial.ca

                          @mariusor I have implemented it requiring OAuth on one side and using HTTP Signature on the other. I think you need to use the user's authorization for private content or to respect personal blocks. It sucks for caching but ¯\_(ツ)_/¯

                          @thisismissem @benpate @steve @smallcircles

                          mariusor@metalhead.clubM This user is from outside of this forum
                          mariusor@metalhead.clubM This user is from outside of this forum
                          mariusor@metalhead.club
                          wrote last edited by
                          #89

                          @evan yes, that's how I did it too, only in my case the private key of the actor that is authorized by OAuth2 token is used to generate the signature for the proxy fetch. This makes it that servers that implement object ACLs based on the recipients list (which GoActivityPub servers are) are not serving 403s for fetches.

                          1 Reply Last reply
                          0
                          • evan@cosocial.caE evan@cosocial.ca

                            @mariusor I have implemented it requiring OAuth on one side and using HTTP Signature on the other. I think you need to use the user's authorization for private content or to respect personal blocks. It sucks for caching but ¯\_(ツ)_/¯

                            @thisismissem @benpate @steve @smallcircles

                            benpate@mastodon.socialB This user is from outside of this forum
                            benpate@mastodon.socialB This user is from outside of this forum
                            benpate@mastodon.social
                            wrote last edited by
                            #90

                            Yeah, this is how I'd expect it to work (with the possible addition of *also* allowing cookie auth on the client side)

                            But yeah. Locally authenticated user from my client -> my server, then HTTP signature from my server -> your server

                            @evan @mariusor @thisismissem @steve @smallcircles

                            evan@cosocial.caE 1 Reply Last reply
                            0
                            • deadsuperhero@social.wedistribute.orgD deadsuperhero@social.wedistribute.org

                              @evan@cosocial.ca Yeah, I mostly agree with this. It's just that the buy-in is a little bit of a chicken and egg problem. You need servers to adopt it, but you need a compelling first mover. Bonfire, maybe?

                              The spec definitely needs love, too. I think one of the harder things is building a timeline out of inbox activities. I feel like maybe a future version of the API could specify timelines somehow, whether it's an endpoint or some kind of basic query? Maybe there's even a way to implement alternative timelines at that level?

                              These are all just guesses on my part, but I feel like this could be a gateway to universal custom feeds.

                              evan@cosocial.caE This user is from outside of this forum
                              evan@cosocial.caE This user is from outside of this forum
                              evan@cosocial.ca
                              wrote last edited by
                              #91

                              @deadsuperhero so, it's a two-sided market -- clients and servers. The traditional mechanism is a "ratchet" -- build up one side, then build up the other, and then build up the first.

                              So, yes, servers first, then clients, then more servers, more clients, and so on back and forth.

                              1 Reply Last reply
                              0
                              • benpate@mastodon.socialB benpate@mastodon.social

                                Yeah, this is how I'd expect it to work (with the possible addition of *also* allowing cookie auth on the client side)

                                But yeah. Locally authenticated user from my client -> my server, then HTTP signature from my server -> your server

                                @evan @mariusor @thisismissem @steve @smallcircles

                                evan@cosocial.caE This user is from outside of this forum
                                evan@cosocial.caE This user is from outside of this forum
                                evan@cosocial.ca
                                wrote last edited by
                                #92

                                @benpate

                                With all the standard warnings around proxies!

                                @mariusor @thisismissem @steve @smallcircles

                                1 Reply Last reply
                                0
                                • smallcircles@social.coopS smallcircles@social.coop

                                  @steve @mariusor @evan

                                  He he, language is hard. A case of terminology overload and clashing terms. Domain driven design has the clearly defined bounded context here which is the scope within which terms are valid. Forming a consistency boundary. These context lines are blurred in fediverse talk. 😅

                                  evan@cosocial.caE This user is from outside of this forum
                                  evan@cosocial.caE This user is from outside of this forum
                                  evan@cosocial.ca
                                  wrote last edited by
                                  #93

                                  @smallcircles @steve @mariusor

                                  I think in particular the terms "publisher" and "consumer" from AS2 and "client" and "server" from AP don't always map cleanly, especially with HTTP POST requests.

                                  When a client delivers an activity to the actor's outbox, the client is the publisher of that activity, and the server is the consumer.

                                  Same when a sending server (publisher) delivers an activity to a receiving server (consumer).

                                  1 Reply Last reply
                                  0
                                  • evan@cosocial.caE evan@cosocial.ca

                                    @mariusor I have implemented it requiring OAuth on one side and using HTTP Signature on the other. I think you need to use the user's authorization for private content or to respect personal blocks. It sucks for caching but ¯\_(ツ)_/¯

                                    @thisismissem @benpate @steve @smallcircles

                                    thisismissem@hachyderm.ioT This user is from outside of this forum
                                    thisismissem@hachyderm.ioT This user is from outside of this forum
                                    thisismissem@hachyderm.io
                                    wrote last edited by
                                    #94

                                    @evan @mariusor @benpate @steve @smallcircles yeah, it's the only way to do it.

                                    But this infrastructure actually is what enables things like the AT Protocol "proxy through my PDS to the bluesky app view" or "proxy through my PDS to a custom feed generator" functionality.

                                    That's how that all works.

                                    1 Reply Last reply
                                    0
                                    • smallcircles@social.coopS smallcircles@social.coop

                                      @evan @steve

                                      It is both, like in that diagram draft.. or at least could be considered such (the notes apply to Protosocial musings).

                                      Link Preview Image
                                      🫧 socialcoding.. (@smallcircles@social.coop)

                                      Attached: 1 image @julian@activitypub.space @evan@cosocial.ca Btw, some time ago in a matrix discussion I sketched how I'd like to conceptually 'see' the social network. Not Mastodon-compliant per se (though it might be via a Profile or Bridge) but back to "promised land". Where the protocol is expressed in familiar architecture patterns and borrows concepts from message queuing, actor model, event-driven architecture, etc. Then as a "Solution designer" I am a stakeholder that wants to be completely shielded from all that jazz. That should all be encapsulated by the protocol libraries and SDK's that are offered in language variants across the ecosystem. #ActivityPub et al is a black box. I can directly start modeling what should be exchanged on the bus, and I can apply domain driven design here. And if I have a semantic web part of my app I'd use linked data modeling best-practices. I would have power tools like #EventCatalog and methods like #EventModeling. https://www.eventcatalog.dev/features/visualization https://eventmodeling.org/

                                      favicon

                                      social.coop (social.coop)

                                      smallcircles@social.coopS This user is from outside of this forum
                                      smallcircles@social.coopS This user is from outside of this forum
                                      smallcircles@social.coop
                                      wrote last edited by
                                      #95

                                      @evan @steve

                                      Another issue: Unclear protocol layers.

                                      > I am not a fan of the idea that #ActivityPub is a message-passing system; it's a read-write API.

                                      I'm not sure what a "read-write API" is, really. It 's a fuzzy term, whereas message based systems have well-defined architecture patterns and a body of IT knowledge and practice to apply them in robust communication systems. A 'Message API' has a generic, consistent interface.

                                      The overarching goal of AS/AP should be empowerment of the Solution developer so they can directly focus on building use cases for their application or business domain. They should not have to think about any of the intrinsics of the protocol, like particular GETs and POSTs used to model protocol capabilities in the HTTP transport layer.

                                      Solution design then involves:

                                      0. Model the domain
                                      1. Data modeling, msg formats + validation
                                      2. Define actor msg exchange patterns
                                      3. Document design
                                      --
                                      4. Improve these steps. Add native protocol + tool support over time.

                                      evan@cosocial.caE 1 Reply Last reply
                                      0
                                      • smallcircles@social.coopS smallcircles@social.coop

                                        @evan @steve

                                        Another issue: Unclear protocol layers.

                                        > I am not a fan of the idea that #ActivityPub is a message-passing system; it's a read-write API.

                                        I'm not sure what a "read-write API" is, really. It 's a fuzzy term, whereas message based systems have well-defined architecture patterns and a body of IT knowledge and practice to apply them in robust communication systems. A 'Message API' has a generic, consistent interface.

                                        The overarching goal of AS/AP should be empowerment of the Solution developer so they can directly focus on building use cases for their application or business domain. They should not have to think about any of the intrinsics of the protocol, like particular GETs and POSTs used to model protocol capabilities in the HTTP transport layer.

                                        Solution design then involves:

                                        0. Model the domain
                                        1. Data modeling, msg formats + validation
                                        2. Define actor msg exchange patterns
                                        3. Document design
                                        --
                                        4. Improve these steps. Add native protocol + tool support over time.

                                        evan@cosocial.caE This user is from outside of this forum
                                        evan@cosocial.caE This user is from outside of this forum
                                        evan@cosocial.ca
                                        wrote last edited by
                                        #96

                                        @smallcircles @steve it's ok if you haven't heard of a REST API. It's an API that uses HTTP for reading and writing data. Wikipedia has a good
                                        article about it:

                                        Link Preview Image
                                        REST - Wikipedia

                                        favicon

                                        (en.wikipedia.org)

                                        evan@cosocial.caE 1 Reply Last reply
                                        0
                                        • evan@cosocial.caE evan@cosocial.ca

                                          @smallcircles @steve it's ok if you haven't heard of a REST API. It's an API that uses HTTP for reading and writing data. Wikipedia has a good
                                          article about it:

                                          Link Preview Image
                                          REST - Wikipedia

                                          favicon

                                          (en.wikipedia.org)

                                          evan@cosocial.caE This user is from outside of this forum
                                          evan@cosocial.caE This user is from outside of this forum
                                          evan@cosocial.ca
                                          wrote last edited by
                                          #97

                                          @smallcircles @steve one anti-pattern I dislike seeing in ActivityPub discussions is that only one interaction defined in the ActivityPub spec is valid: an HTTP POST to an actor's `inbox` for server-to-server interactions.

                                          We can use HTTP GET to fetch additional data about objects, actors and collections.

                                          evan@cosocial.caE 1 Reply Last reply
                                          0
                                          Reply
                                          • Reply as topic
                                          Log in to reply
                                          • Oldest to Newest
                                          • Newest to Oldest
                                          • Most Votes


                                          • Login

                                          • Don't have an account? Register

                                          • Login or register to search.
                                          Powered by NodeBB Contributors
                                          • First post
                                            Last post
                                          0
                                          • Categories
                                          • Recent
                                          • Tags
                                          • Popular
                                          • World
                                          • Users
                                          • Groups