Initial commit; nothing works yet

This commit is contained in:
Simon Brooke 2022-12-19 13:23:38 +00:00
commit a599d133f4
20 changed files with 954 additions and 0 deletions

19
.gitignore vendored Normal file
View file

@ -0,0 +1,19 @@
*.class
*.jar
*~
.hg/
.hgignore
/.calva
/.clj-kondo
/.lein-*
/.lsp
/.nrepl-port
/.prepl-port
/checkouts
/classes
/keys
/resources/activitystreams-test-documents
/target
pom.xml
pom.xml.asc
profiles.clj

24
CHANGELOG.md Normal file
View file

@ -0,0 +1,24 @@
# Change Log
All notable changes to this project will be documented in this file. This change log follows the conventions of [keepachangelog.com](http://keepachangelog.com/).
## [Unreleased]
### Changed
- Add a new arity to `make-widget-async` to provide a different widget shape.
## [0.1.1] - 2022-12-12
### Changed
- Documentation on how to make the widgets.
### Removed
- `make-widget-sync` - we're all async, all the time.
### Fixed
- Fixed widget maker to keep working when daylight savings switches over.
## 0.1.0 - 2022-12-12
### Added
- Files from the new template.
- Widget maker public API - `make-widget-sync`.
[Unreleased]: https://sourcehost.site/your-name/dog-and-duck/compare/0.1.1...HEAD
[0.1.1]: https://sourcehost.site/your-name/dog-and-duck/compare/0.1.0...0.1.1

280
LICENSE Normal file
View file

@ -0,0 +1,280 @@
Eclipse Public License - v 2.0
THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE
PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION
OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
1. DEFINITIONS
"Contribution" means:
a) in the case of the initial Contributor, the initial content
Distributed under this Agreement, and
b) in the case of each subsequent Contributor:
i) changes to the Program, and
ii) additions to the Program;
where such changes and/or additions to the Program originate from
and are Distributed by that particular Contributor. A Contribution
"originates" from a Contributor if it was added to the Program by
such Contributor itself or anyone acting on such Contributor's behalf.
Contributions do not include changes or additions to the Program that
are not Modified Works.
"Contributor" means any person or entity that Distributes the Program.
"Licensed Patents" mean patent claims licensable by a Contributor which
are necessarily infringed by the use or sale of its Contribution alone
or when combined with the Program.
"Program" means the Contributions Distributed in accordance with this
Agreement.
"Recipient" means anyone who receives the Program under this Agreement
or any Secondary License (as applicable), including Contributors.
"Derivative Works" shall mean any work, whether in Source Code or other
form, that is based on (or derived from) the Program and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship.
"Modified Works" shall mean any work in Source Code or other form that
results from an addition to, deletion from, or modification of the
contents of the Program, including, for purposes of clarity any new file
in Source Code form that contains any contents of the Program. Modified
Works shall not include works that contain only declarations,
interfaces, types, classes, structures, or files of the Program solely
in each case in order to link to, bind by name, or subclass the Program
or Modified Works thereof.
"Distribute" means the acts of a) distributing or b) making available
in any manner that enables the transfer of a copy.
"Source Code" means the form of a Program preferred for making
modifications, including but not limited to software source code,
documentation source, and configuration files.
"Secondary License" means either the GNU General Public License,
Version 2.0, or any later versions of that license, including any
exceptions or additional permissions as identified by the initial
Contributor.
2. GRANT OF RIGHTS
a) Subject to the terms of this Agreement, each Contributor hereby
grants Recipient a non-exclusive, worldwide, royalty-free copyright
license to reproduce, prepare Derivative Works of, publicly display,
publicly perform, Distribute and sublicense the Contribution of such
Contributor, if any, and such Derivative Works.
b) Subject to the terms of this Agreement, each Contributor hereby
grants Recipient a non-exclusive, worldwide, royalty-free patent
license under Licensed Patents to make, use, sell, offer to sell,
import and otherwise transfer the Contribution of such Contributor,
if any, in Source Code or other form. This patent license shall
apply to the combination of the Contribution and the Program if, at
the time the Contribution is added by the Contributor, such addition
of the Contribution causes such combination to be covered by the
Licensed Patents. The patent license shall not apply to any other
combinations which include the Contribution. No hardware per se is
licensed hereunder.
c) Recipient understands that although each Contributor grants the
licenses to its Contributions set forth herein, no assurances are
provided by any Contributor that the Program does not infringe the
patent or other intellectual property rights of any other entity.
Each Contributor disclaims any liability to Recipient for claims
brought by any other entity based on infringement of intellectual
property rights or otherwise. As a condition to exercising the
rights and licenses granted hereunder, each Recipient hereby
assumes sole responsibility to secure any other intellectual
property rights needed, if any. For example, if a third party
patent license is required to allow Recipient to Distribute the
Program, it is Recipient's responsibility to acquire that license
before distributing the Program.
d) Each Contributor represents that to its knowledge it has
sufficient copyright rights in its Contribution, if any, to grant
the copyright license set forth in this Agreement.
e) Notwithstanding the terms of any Secondary License, no
Contributor makes additional grants to any Recipient (other than
those set forth in this Agreement) as a result of such Recipient's
receipt of the Program under the terms of a Secondary License
(if permitted under the terms of Section 3).
3. REQUIREMENTS
3.1 If a Contributor Distributes the Program in any form, then:
a) the Program must also be made available as Source Code, in
accordance with section 3.2, and the Contributor must accompany
the Program with a statement that the Source Code for the Program
is available under this Agreement, and informs Recipients how to
obtain it in a reasonable manner on or through a medium customarily
used for software exchange; and
b) the Contributor may Distribute the Program under a license
different than this Agreement, provided that such license:
i) effectively disclaims on behalf of all other Contributors all
warranties and conditions, express and implied, including
warranties or conditions of title and non-infringement, and
implied warranties or conditions of merchantability and fitness
for a particular purpose;
ii) effectively excludes on behalf of all other Contributors all
liability for damages, including direct, indirect, special,
incidental and consequential damages, such as lost profits;
iii) does not attempt to limit or alter the recipients' rights
in the Source Code under section 3.2; and
iv) requires any subsequent distribution of the Program by any
party to be under a license that satisfies the requirements
of this section 3.
3.2 When the Program is Distributed as Source Code:
a) it must be made available under this Agreement, or if the
Program (i) is combined with other material in a separate file or
files made available under a Secondary License, and (ii) the initial
Contributor attached to the Source Code the notice described in
Exhibit A of this Agreement, then the Program may be made available
under the terms of such Secondary Licenses, and
b) a copy of this Agreement must be included with each copy of
the Program.
3.3 Contributors may not remove or alter any copyright, patent,
trademark, attribution notices, disclaimers of warranty, or limitations
of liability ("notices") contained within the Program from any copy of
the Program which they Distribute, provided that Contributors may add
their own appropriate notices.
4. COMMERCIAL DISTRIBUTION
Commercial distributors of software may accept certain responsibilities
with respect to end users, business partners and the like. While this
license is intended to facilitate the commercial use of the Program,
the Contributor who includes the Program in a commercial product
offering should do so in a manner which does not create potential
liability for other Contributors. Therefore, if a Contributor includes
the Program in a commercial product offering, such Contributor
("Commercial Contributor") hereby agrees to defend and indemnify every
other Contributor ("Indemnified Contributor") against any losses,
damages and costs (collectively "Losses") arising from claims, lawsuits
and other legal actions brought by a third party against the Indemnified
Contributor to the extent caused by the acts or omissions of such
Commercial Contributor in connection with its distribution of the Program
in a commercial product offering. The obligations in this section do not
apply to any claims or Losses relating to any actual or alleged
intellectual property infringement. In order to qualify, an Indemnified
Contributor must: a) promptly notify the Commercial Contributor in
writing of such claim, and b) allow the Commercial Contributor to control,
and cooperate with the Commercial Contributor in, the defense and any
related settlement negotiations. The Indemnified Contributor may
participate in any such claim at its own expense.
For example, a Contributor might include the Program in a commercial
product offering, Product X. That Contributor is then a Commercial
Contributor. If that Commercial Contributor then makes performance
claims, or offers warranties related to Product X, those performance
claims and warranties are such Commercial Contributor's responsibility
alone. Under this section, the Commercial Contributor would have to
defend claims against the other Contributors related to those performance
claims and warranties, and if a court requires any other Contributor to
pay any damages as a result, the Commercial Contributor must pay
those damages.
5. NO WARRANTY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT
PERMITTED BY APPLICABLE LAW, THE PROGRAM IS PROVIDED ON AN "AS IS"
BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR
IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF
TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR
PURPOSE. Each Recipient is solely responsible for determining the
appropriateness of using and distributing the Program and assumes all
risks associated with its exercise of rights under this Agreement,
including but not limited to the risks and costs of program errors,
compliance with applicable laws, damage to or loss of data, programs
or equipment, and unavailability or interruption of operations.
6. DISCLAIMER OF LIABILITY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT
PERMITTED BY APPLICABLE LAW, NEITHER RECIPIENT NOR ANY CONTRIBUTORS
SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST
PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE
EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.
7. GENERAL
If any provision of this Agreement is invalid or unenforceable under
applicable law, it shall not affect the validity or enforceability of
the remainder of the terms of this Agreement, and without further
action by the parties hereto, such provision shall be reformed to the
minimum extent necessary to make such provision valid and enforceable.
If Recipient institutes patent litigation against any entity
(including a cross-claim or counterclaim in a lawsuit) alleging that the
Program itself (excluding combinations of the Program with other software
or hardware) infringes such Recipient's patent(s), then such Recipient's
rights granted under Section 2(b) shall terminate as of the date such
litigation is filed.
All Recipient's rights under this Agreement shall terminate if it
fails to comply with any of the material terms or conditions of this
Agreement and does not cure such failure in a reasonable period of
time after becoming aware of such noncompliance. If all Recipient's
rights under this Agreement terminate, Recipient agrees to cease use
and distribution of the Program as soon as reasonably practicable.
However, Recipient's obligations under this Agreement and any licenses
granted by Recipient relating to the Program shall continue and survive.
Everyone is permitted to copy and distribute copies of this Agreement,
but in order to avoid inconsistency the Agreement is copyrighted and
may only be modified in the following manner. The Agreement Steward
reserves the right to publish new versions (including revisions) of
this Agreement from time to time. No one other than the Agreement
Steward has the right to modify this Agreement. The Eclipse Foundation
is the initial Agreement Steward. The Eclipse Foundation may assign the
responsibility to serve as the Agreement Steward to a suitable separate
entity. Each new version of the Agreement will be given a distinguishing
version number. The Program (including Contributions) may always be
Distributed subject to the version of the Agreement under which it was
received. In addition, after a new version of the Agreement is published,
Contributor may elect to Distribute the Program (including its
Contributions) under the new version.
Except as expressly stated in Sections 2(a) and 2(b) above, Recipient
receives no rights or licenses to the intellectual property of any
Contributor under this Agreement, whether expressly, by implication,
estoppel or otherwise. All rights in the Program not expressly granted
under this Agreement are reserved. Nothing in this Agreement is intended
to be enforceable by any entity that is not a Contributor or Recipient.
No third-party beneficiary rights are created under this Agreement.
Exhibit A - Form of Secondary Licenses Notice
"This Source Code may also be made available under the following
Secondary Licenses when the conditions for such availability set forth
in the Eclipse Public License, v. 2.0 are satisfied: GNU General Public
License as published by the Free Software Foundation, either version 2
of the License, or (at your option) any later version, with the GNU
Classpath Exception which is available at
https://www.gnu.org/software/classpath/license.html."
Simply including a copy of this Agreement, including this Exhibit A
is not sufficient to license the Source Code under Secondary Licenses.
If it is not possible or desirable to put the notice in a particular
file, then You may include the notice in a location (such as a LICENSE
file in a relevant directory) where a recipient would be likely to
look for such a notice.
You may add additional accurate notices of copyright ownership.

71
README.md Normal file
View file

@ -0,0 +1,71 @@
# The Old Dog and Duck
A Clojure library designed to implement the ActivityPub protocol, obviously.
## Introduction
The Old Dog and Duck is clearly a pub, and it's a pub related to an activity; to whit, hunting ducks with dogs. Yes, of course one could also hunt dogs with ducks, but in practice that doesn't work so well. The point isn't whether or not I approve of hunting ducks with dogs (or vice versa); to be clear, I don't. The point is that it's a pub related to an activity, and is therefore an [ActivityPub](https://www.w3.org/TR/activitypub/).
Are we clear?
Good.
Let us proceed.
**The Old Dog and Duck** is intended to be a set of libraries to enable people to build stuff which interacts with ActivityPub. It isn't intended to be a replacement for, or clone of, Mastodon. I do think I might implement my own ActivityPub server on top of The Old Dog and Duck, that specifically might allow for user-pluggable feed-sorting algorithms and with my own user interface/user experience take, but that project is not this project.
## Architecture
There are a number of separate concerns required to implement ActivityPub. They include
1. Parsing ActivityStreams messages received from peers and from clients;
2. Persisting ActivityStreams objects;
3. Delivering ActivityStreams objects to peers;
4. Delivering ActivityStreams objects to clients.
**NOTE THAT** what Mastodon delivers to clients is not actually in ActivityStreams format; this seems to be an ad-hoc hack that's just never been fixed and has therefore become a de-facto standard for communication between ActivityPub hosts and their clients.
My proposal would be to deliver exactly the same ActivityStreams format to my client as to other servers. There may be a valid reason for not doing this, but if there is I will discover it in due course.
## Proposed dog-and-duck libraries
**NOTE THAT** at the present stage all the proposed libraries are in one package, namely this package, but that it is proposed that in future they will form separate libraries in separate packages.
### Bar
Where conversations happen. Handle interactions with clients.
### Cellar
Where things are stored. Persistance for ActivityStreams objects; I may at least initially simply copy the Mastodon postgres schema, but equally I may not.
### Pantry
Where deliveries are ordered and arrive; and from where deliveries onwards are despatched. Handle interactions with peers.
### Quack
Duck-typing for ActivityStreams objects.
### Scratch
What the dog does when bored. Essentially, a place where I can learn how to make this stuff work, but perhaps eventually an ActivityPub server in its own right.
## Usage
FIXME
## License
Copyright © 2022 FIXME
This program and the accompanying materials are made available under the
terms of the Eclipse Public License 2.0 which is available at
http://www.eclipse.org/legal/epl-2.0.
This Source Code may also be made available under the following Secondary
Licenses when the conditions for such availability set forth in the Eclipse
Public License, v. 2.0 are satisfied: GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or (at your
option) any later version, with the GNU Classpath Exception which is available
at https://www.gnu.org/software/classpath/license.html.

110
doc/Using_ActivityPub.md Normal file
View file

@ -0,0 +1,110 @@
# Using ActivityPub
user=> (require '[clj-activitypub.core :as activitypub])
nil
user=> (require '[clj-activitypub.webfinger :as webfinger])
nil
user=> (require '[clojure.walk :refer [keywordize-keys]])
nil
user=> (require '[clojure.pprint :refer [pprint]])
nil
user=> (def base-domain "mastodon.scot")
#'user/base-domain
user=> (def account-handle "@simon_brooke@mastodon.scot")
#'user/account-handle
user=> (in-ns 'user)
#object[clojure.lang.Namespace 0x525575 "user"]
user=> (activitypub/parse-account account-handle )
{:domain "mastodon.scot", :username "simon_brooke"}
user=> (map *1 [:domain :username])
("mastodon.scot" "simon_brooke")
user=> (apply webfinger/fetch-user-id *1)
"https://mastodon.scot/users/simon_brooke"
user=> (activitypub/fetch-user *1)
{"followers" "https://mastodon.scot/users/simon_brooke/followers", "inbox" "https://mastodon.scot/users/simon_brooke/inbox", "url" "https://mastodon.scot/@simon_brooke", "@context" ["https://www.w3.org/ns/activitystreams" "https://w3id.org/security/v1" {"identityKey" {"@type" "@id", "@id" "toot:identityKey"}, "EncryptedMessage" "toot:EncryptedMessage", "Ed25519Key" "toot:Ed25519Key", "devices" {"@type" "@id", "@id" "toot:devices"}, "manuallyApprovesFollowers" "as:manuallyApprovesFollowers", "schema" "http://schema.org#", "PropertyValue" "schema:PropertyValue", "Curve25519Key" "toot:Curve25519Key", "claim" {"@type" "@id", "@id" "toot:claim"}, "value" "schema:value", "Hashtag" "as:Hashtag", "movedTo" {"@id" "as:movedTo", "@type" "@id"}, "discoverable" "toot:discoverable", "messageType" "toot:messageType", "messageFranking" "toot:messageFranking", "cipherText" "toot:cipherText", "toot" "http://joinmastodon.org/ns#", "alsoKnownAs" {"@id" "as:alsoKnownAs", "@type" "@id"}, "featured" {"@id" "toot:featured", "@type" "@id"}, "featuredTags" {"@id" "toot:featuredTags", "@type" "@id"}, "Ed25519Signature" "toot:Ed25519Signature", "focalPoint" {"@container" "@list", "@id" "toot:focalPoint"}, "fingerprintKey" {"@type" "@id", "@id" "toot:fingerprintKey"}, "Device" "toot:Device", "publicKeyBase64" "toot:publicKeyBase64", "deviceId" "toot:deviceId", "suspended" "toot:suspended"}], "devices" "https://mastodon.scot/users/simon_brooke/collections/devices", "manuallyApprovesFollowers" false, "image" {"type" "Image", "mediaType" "image/jpeg", "url" "https://media.mastodon.scot/mastodon-scot-public/accounts/headers/109/252/274/874/045/781/original/e1f1823c4361fa27.jpg"}, "endpoints" {"sharedInbox" "https://mastodon.scot/inbox"}, "id" "https://mastodon.scot/users/simon_brooke", "publicKey" {"id" "https://mastodon.scot/users/simon_brooke#main-key", "owner" "https://mastodon.scot/users/simon_brooke", "publicKeyPem" "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA2/6GgLJgJlPhhqFm1tUQ\noSLnWxhDwq4HlZIHrBsVjkSvUAnHKqq42Q/hta+fkWB8rmTFpmjLXDj/Fi0uejvT\nBc+KrLwfX/yR8+G87afGCRS3CaumoLJ7zkBIlsFzIKMoIke1D3QuHX95yGGXs+hp\nmyxt/+CXRyZjK7u9NG7SMRUlpwvOlpD12Aei35Nb8NSr03JvY8/WVMIbWrecyI0b\nAlwj6axxHx7J15Yo+aEtKzZ2OFKXf+sh0QF9BEnYcmVKYlR6kiOglLFHKdCBUSYi\ni9Flv00TydqlGvR5fpShBqORiy0M/FVtNXlz2sNBEsGB2meipkjh+cRLzTbYo4KL\nJwIDAQAB\n-----END PUBLIC KEY-----\n"}, "summary" "<p>Anarcho-syndicalist, autistic, crofter, cyclist, depressive, entrepreneur, geek, Zapatista. Politics &amp; environment, especially <a href=\"https://mastodon.scot/tags/LandReform\" class=\"mention hashtag\" rel=\"tag\">#<span>LandReform</span></a>. he/him.</p><p>Twitter: <span class=\"h-card\"><a href=\"https://mastodon.scot/@simon_brooke\" class=\"u-url mention\">@<span>simon_brooke</span></a></span><br />GitHub: simon-brooke<br />FetLife: Simon_Brooke</p><p>Credo: Life is harsh. What we can do - and what we should do - is strive to make it less harsh for the people around us.</p>", "attachment" [{"type" "PropertyValue", "name" "Home Page", "value" "<a href=\"https://www.journeyman.cc/~simon/\" target=\"_blank\" rel=\"nofollow noopener noreferrer me\"><span class=\"invisible\">https://www.</span><span class=\"\">journeyman.cc/~simon/</span><span class=\"invisible\"></span></a>"}], "name" "Simon Brooke", "tag" [{"type" "Hashtag", "href" "https://mastodon.scot/tags/landreform", "name" "#landreform"}], "published" "2022-10-29T00:00:00Z", "preferredUsername" "simon_brooke", "discoverable" true, "alsoKnownAs" ["https://mastodon.social/users/simon_brooke"], "featured" "https://mastodon.scot/users/simon_brooke/collections/featured", "featuredTags" "https://mastodon.scot/users/simon_brooke/collections/tags", "type" "Person", "outbox" "https://mastodon.scot/users/simon_brooke/outbox", "following" "https://mastodon.scot/users/simon_brooke/following", "icon" {"type" "Image", "mediaType" "image/png", "url" "https://media.mastodon.scot/mastodon-scot-public/accounts/avatars/109/252/274/874/045/781/original/172e8f7530627e87.png"}}
user=> (def sb (keywordize-keys *1))
#'user/sb
user=> (:outbox sb)
"https://mastodon.scot/users/simon_brooke/outbox"
user=> (require '[clojure.data.json :as json])
nil
user=> (slurp (:outbox sb))
Execution error (IOException) at sun.net.www.protocol.http.HttpURLConnection/getInputStream0 (HttpURLConnection.java:1894).
Server returned HTTP response code: 403 for URL: https://mastodon.scot/users/simon_brooke/outbox
user=> (pprint sb)
{:inbox "https://mastodon.scot/users/simon_brooke/inbox",
:name "Simon Brooke",
:@context
["https://www.w3.org/ns/activitystreams"
"https://w3id.org/security/v1"
{:schema "http://schema.org#",
:messageType "toot:messageType",
:messageFranking "toot:messageFranking",
:identityKey {:@type "@id", :@id "toot:identityKey"},
:Hashtag "as:Hashtag",
:deviceId "toot:deviceId",
:publicKeyBase64 "toot:publicKeyBase64",
:value "schema:value",
:Ed25519Key "toot:Ed25519Key",
:featured {:@id "toot:featured", :@type "@id"},
:Curve25519Key "toot:Curve25519Key",
:discoverable "toot:discoverable",
:focalPoint {:@container "@list", :@id "toot:focalPoint"},
:suspended "toot:suspended",
:fingerprintKey {:@type "@id", :@id "toot:fingerprintKey"},
:Ed25519Signature "toot:Ed25519Signature",
:cipherText "toot:cipherText",
:EncryptedMessage "toot:EncryptedMessage",
:alsoKnownAs {:@id "as:alsoKnownAs", :@type "@id"},
:featuredTags {:@id "toot:featuredTags", :@type "@id"},
:devices {:@type "@id", :@id "toot:devices"},
:toot "http://joinmastodon.org/ns#",
:movedTo {:@id "as:movedTo", :@type "@id"},
:Device "toot:Device",
:PropertyValue "schema:PropertyValue",
:manuallyApprovesFollowers "as:manuallyApprovesFollowers",
:claim {:@type "@id", :@id "toot:claim"}}],
:featured
"https://mastodon.scot/users/simon_brooke/collections/featured",
:type "Person",
:discoverable true,
:icon
{:type "Image",
:mediaType "image/png",
:url
"https://media.mastodon.scot/mastodon-scot-public/accounts/avatars/109/252/274/874/045/781/original/172e8f7530627e87.png"},
:following "https://mastodon.scot/users/simon_brooke/following",
:summary
"<p>Anarcho-syndicalist, autistic, crofter, cyclist, depressive, entrepreneur, geek, Zapatista. Politics &amp; environment, especially <a href=\"https://mastodon.scot/tags/LandReform\" class=\"mention hashtag\" rel=\"tag\">#<span>LandReform</span></a>. he/him.</p><p>Twitter: <span class=\"h-card\"><a href=\"https://mastodon.scot/@simon_brooke\" class=\"u-url mention\">@<span>simon_brooke</span></a></span><br />GitHub: simon-brooke<br />FetLife: Simon_Brooke</p><p>Credo: Life is harsh. What we can do - and what we should do - is strive to make it less harsh for the people around us.</p>",
:publicKey
{:id "https://mastodon.scot/users/simon_brooke#main-key",
:owner "https://mastodon.scot/users/simon_brooke",
:publicKeyPem
"-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA2/6GgLJgJlPhhqFm1tUQ\noSLnWxhDwq4HlZIHrBsVjkSvUAnHKqq42Q/hta+fkWB8rmTFpmjLXDj/Fi0uejvT\nBc+KrLwfX/yR8+G87afGCRS3CaumoLJ7zkBIlsFzIKMoIke1D3QuHX95yGGXs+hp\nmyxt/+CXRyZjK7u9NG7SMRUlpwvOlpD12Aei35Nb8NSr03JvY8/WVMIbWrecyI0b\nAlwj6axxHx7J15Yo+aEtKzZ2OFKXf+sh0QF9BEnYcmVKYlR6kiOglLFHKdCBUSYi\ni9Flv00TydqlGvR5fpShBqORiy0M/FVtNXlz2sNBEsGB2meipkjh+cRLzTbYo4KL\nJwIDAQAB\n-----END PUBLIC KEY-----\n"},
:endpoints {:sharedInbox "https://mastodon.scot/inbox"},
:preferredUsername "simon_brooke",
:id "https://mastodon.scot/users/simon_brooke",
:alsoKnownAs ["https://mastodon.social/users/simon_brooke"],
:outbox "https://mastodon.scot/users/simon_brooke/outbox",
:url "https://mastodon.scot/@simon_brooke",
:featuredTags
"https://mastodon.scot/users/simon_brooke/collections/tags",
:devices
"https://mastodon.scot/users/simon_brooke/collections/devices",
:image
{:type "Image",
:mediaType "image/jpeg",
:url
"https://media.mastodon.scot/mastodon-scot-public/accounts/headers/109/252/274/874/045/781/original/e1f1823c4361fa27.jpg"},
:tag
[{:type "Hashtag",
:href "https://mastodon.scot/tags/landreform",
:name "#landreform"}],
:followers "https://mastodon.scot/users/simon_brooke/followers",
:published "2022-10-29T00:00:00Z",
:manuallyApprovesFollowers false,
:attachment
[{:type "PropertyValue",
:name "Home Page",
:value
"<a href=\"https://www.journeyman.cc/~simon/\" target=\"_blank\" rel=\"nofollow noopener noreferrer me\"><span class=\"invisible\">https://www.</span><span class=\"\">journeyman.cc/~simon/</span><span class=\"invisible\"></span></a>"}]}

3
doc/intro.md Normal file
View file

@ -0,0 +1,3 @@
# Introduction to dog-and-duck
TODO: write [great documentation](http://jacobian.org/writing/what-to-write/)

15
project.clj Normal file
View file

@ -0,0 +1,15 @@
(defproject dog-and-duck "0.1.0-SNAPSHOT"
:description "FIXME: write description"
:url "http://example.com/FIXME"
:license {:name "EPL-2.0 OR GPL-2.0-or-later WITH Classpath-exception-2.0"
:url "https://www.eclipse.org/legal/epl-2.0/"}
:dependencies [[org.clojure/clojure "1.10.3"]
[org.clojure/data.json "2.4.0"]
[org.clojure/math.numeric-tower "0.0.5"]
[org.clojure/spec.alpha "0.3.218"]
[mvxcvi/clj-pgp "1.1.0"]
[org.bouncycastle/bcpkix-jdk18on "1.72"] ;; required by clj-activitypub
[clj-http "3.12.3"] ;; required by clj-activitypub
[cheshire "5.11.0"] ;; if this is not present, clj-http/client errors with 'json-enabled?'
]
:repl-options {:init-ns dog-and-duck.scratch.core})

4
resources/README.md Normal file
View file

@ -0,0 +1,4 @@
# dog-and-duck/resources
You should clone git@github.com:w3c-social/activitystreams-test-documents.git
into this directory.

1
resources/feed.json Normal file

File diff suppressed because one or more lines are too long

View file

@ -0,0 +1,3 @@
# NOTE
Files in this directory are copied from [Jahfer's clj-activitypub library](https://github.com/jahfer/clj-activitypub). If and when Jahfer issues a release of that library, this directory will be deleted and a dependency on that library will be added to the project.

View file

@ -0,0 +1,147 @@
(ns clj-activitypub.core
(:require [clj-activitypub.internal.crypto :as crypto]
[clj-activitypub.internal.thread-cache :as thread-cache]
[clj-activitypub.internal.http-util :as http]
[clj-http.client :as client]
[clojure.string :as str]))
(defn config
"Creates hash of computed data relevant for most ActivityPub utilities."
[{:keys [domain username username-route public-key private-key]
:or {username-route "/users/"
public-key nil
private-key nil}}]
(let [base-url (str "https://" domain)]
{:domain domain
:base-url base-url
:username username
:user-id (str base-url username-route username)
:public-key public-key
:private-key (when private-key
(crypto/private-key private-key))}))
(defn parse-account
"Given an ActivityPub handle (e.g. @jahfer@mastodon.social), produces
a map containing {:domain ... :username ...}."
[handle]
(let [[username domain] (filter #(not (str/blank? %))
(str/split handle #"@"))]
{:domain domain :username username}))
(def ^:private user-cache (thread-cache/make))
(defn fetch-user
"Fetches the customer account details located at user-id from a remote
server. Will return cached results if they exist in memory."
[user-id]
((:get-v user-cache)
user-id
#(:body
(client/get user-id {:as :json-string-keys
:throw-exceptions false
:ignore-unknown-host? true
:headers {"Accept" "application/activity+json"}}))))
(defn actor
"Accepts a config, and returns a map in the form expected by the ActivityPub
spec. See https://www.w3.org/TR/activitypub/#actor-objects for reference."
[{:keys [user-id username public-key]}]
{"@context" ["https://www.w3.org/ns/activitystreams"
"https://w3id.org/security/v1"]
:id user-id
:type "Person"
:preferredUsername username
:inbox (str user-id "/inbox")
:outbox (str user-id "/outbox")
:publicKey {:id (str user-id "#main-key")
:owner user-id
:publicKeyPem (or public-key "")}})
(def signature-headers ["(request-target)" "host" "date" "digest"])
(defn- str-for-signature [headers]
(let [headers-xf (reduce-kv
(fn [m k v]
(assoc m (str/lower-case k) v)) {} headers)]
(->> signature-headers
(select-keys headers-xf)
(reduce-kv (fn [coll k v] (conj coll (str k ": " v))) [])
(interpose "\n")
(apply str))))
(defn gen-signature-header
"Generates a HTTP Signature string based on the provided map of headers."
[config headers]
(let [{:keys [user-id private-key]} config
string-to-sign (str-for-signature headers)
signature (crypto/base64-encode (crypto/sign string-to-sign private-key))
sig-header-keys {"keyId" user-id
"headers" (str/join " " signature-headers)
"signature" signature}]
(->> sig-header-keys
(reduce-kv (fn [m k v]
(conj m (str k "=" "\"" v "\""))) [])
(interpose ",")
(apply str))))
(defn auth-headers
"Given a config and request map of {:body ... :headers ...}, returns the
original set of headers with Signature and Digest attributes appended."
[config {:keys [body headers]}]
(let [digest (http/digest body)
h (-> headers
(assoc "Digest" digest)
(assoc "(request-target)" "post /inbox"))]
(assoc headers
"Signature" (gen-signature-header config h)
"Digest" digest)))
(defmulti obj
"Produces a map representing an ActivityPub object which can be serialized
directly to JSON in the form expected by the ActivityStreams 2.0 spec.
See https://www.w3.org/TR/activitystreams-vocabulary/ for reference."
(fn [_config object-data] (:type object-data)))
(defmethod obj :note
[{:keys [user-id]}
{:keys [id published inReplyTo content to]
:or {published (http/date)
inReplyTo ""
to "https://www.w3.org/ns/activitystreams#Public"}}]
{"id" (str user-id "/notes/" id)
"type" "Note"
"published" published
"attributedTo" user-id
"inReplyTo" inReplyTo
"content" content
"to" to})
(defmulti activity
"Produces a map representing an ActivityPub activity which can be serialized
directly to JSON in the form expected by the ActivityStreams 2.0 spec.
See https://www.w3.org/TR/activitystreams-vocabulary/ for reference."
(fn [_config activity-type _data] activity-type))
(defmethod activity :create [{:keys [user-id]} _ data]
{"@context" ["https://www.w3.org/ns/activitystreams"
"https://w3id.org/security/v1"]
"type" "Create"
"actor" user-id
"object" data})
(defmethod activity :delete [{:keys [user-id]} _ data]
{"@context" ["https://www.w3.org/ns/activitystreams"
"https://w3id.org/security/v1"]
"type" "Delete"
"actor" user-id
"object" data})
(defn with-config
"Returns curried forms of the #activity and #obj multimethods in the form
{:activity ... :obj ...}, with the initial parameter set to config."
[config]
(let [f (juxt
#(partial activity %)
#(partial obj %))
[activity-fn obj-fn] (f config)]
{:activity activity-fn
:obj obj-fn}))

View file

@ -0,0 +1,36 @@
(ns clj-activitypub.internal.crypto
(:require [clojure.java.io :as io])
(:import (java.util Base64)
(java.security MessageDigest SecureRandom Signature)))
(java.security.Security/addProvider
(org.bouncycastle.jce.provider.BouncyCastleProvider.))
(defn- keydata [reader]
(->> reader
(org.bouncycastle.openssl.PEMParser.)
(.readObject)))
(defn- pem-string->key-pair [string]
(let [kd (keydata (io/reader (.getBytes string)))]
(.getKeyPair (org.bouncycastle.openssl.jcajce.JcaPEMKeyConverter.) kd)))
(defn private-key [private-pem-str]
(-> private-pem-str
(pem-string->key-pair)
(.getPrivate)))
(defn base64-encode [bytes]
(.encodeToString (Base64/getEncoder) bytes))
(defn sha256-base64 [data]
(let [digest (.digest (MessageDigest/getInstance "SHA-256") (.getBytes data))]
(base64-encode digest)))
(defn sign [data private-key]
(let [bytes (.getBytes data)
signer (doto (Signature/getInstance "SHA256withRSA")
(.initSign private-key (SecureRandom.))
(.update bytes))]
(.sign signer)))

View file

@ -0,0 +1,25 @@
(ns clj-activitypub.internal.http-util
(:require [clj-activitypub.internal.crypto :as crypto])
(:import (java.net URLEncoder)
(java.time OffsetDateTime ZoneOffset)
(java.time.format DateTimeFormatter)))
(defn encode-url-params [params]
(->> params
(reduce-kv
(fn [coll k v]
(conj coll
(str (URLEncoder/encode (name k)) "=" (URLEncoder/encode (str v)))))
[])
(interpose "&")
(apply str)))
(defn date []
(-> (OffsetDateTime/now (ZoneOffset/UTC))
(.format DateTimeFormatter/RFC_1123_DATE_TIME)))
(defn digest
"Accepts body from HTTP request and generates string
for use in HTTP `Digest` request header."
[body]
(str "sha-256=" (crypto/sha256-base64 body)))

View file

@ -0,0 +1,44 @@
(ns clj-activitypub.internal.thread-cache)
(defn- current-time
"Returns current time using UNIX epoch."
[]
(System/currentTimeMillis))
(defn- update-read-at [store k v]
(dosync
(commute store assoc k
(merge v {:read-at (current-time)}))))
(defn make
"Creates a thread-local cache."
([] (make false))
([cache-if-nil]
(let [store (ref {})]
(letfn [(cache-kv ([k v]
(dosync
(commute store assoc k
{:write-at (current-time)
:read-at (current-time)
:value v})
v)))
(get-v ([k]
(when-let [data (get @store k)]
(update-read-at store k data)
(:value data)))
([k compute-fn]
(let [storage @store]
(if (contains? storage k)
(get-v k)
(let [v (compute-fn)]
(when (or (not (nil? v)) cache-if-nil)
(cache-kv k v)
(get-v k)))))))
(lru ([]
(mapv
(fn [[k v]] [k (:value v)])
(sort-by #(-> % val :read-at) < @store))))]
{:cache-kv cache-kv
:get-v get-v
:cache-if-nil cache-if-nil
:lru lru}))))

View file

@ -0,0 +1,32 @@
(ns clj-activitypub.webfinger
(:require [clj-http.client :as client]
[clj-activitypub.internal.http-util :as http]
[clj-activitypub.internal.thread-cache :as thread-cache]))
(def remote-uri-path "/.well-known/webfinger")
(defn- resource-str [domain username]
(str "acct:" username "@" domain))
(defn resource-url
"Builds a URL pointing to the user's account on the remote server."
[domain username & [params]]
(let [resource (resource-str domain username)
query-str (http/encode-url-params (merge params {:resource resource}))]
(str "https://" domain remote-uri-path "?" query-str)))
(def ^:private user-id-cache
(thread-cache/make))
(defn fetch-user-id
"Follows the webfinger request to a remote domain, retrieving the ID of the requested
account. Typically returns a string in the form of a URL."
[domain username]
((:get-v user-id-cache)
(str domain "@" username) ;; cache key
(fn []
(let [response (some-> (resource-url domain username {:rel "self"})
(client/get {:as :json :throw-exceptions false :ignore-unknown-host? true}))]
(some->> response :body :links
(some #(when (= (:type %) "application/activity+json") %))
:href)))))

View file

@ -0,0 +1,63 @@
(ns dog-and-duck.quack.quack
"Validator for ActivityPub objects: if it walks like a duck, and it quacks like a duck..."
;;(:require [clojure.spec.alpha as s])
(:import [java.net URI URISyntaxException]))
(defn object?
"Return `true` iff `x` is recognisably an ActivityStreams object.
**NOTE THAT** The ActivityStreams spec
[says](https://www.w3.org/TR/activitystreams-core/#object):
> All properties are optional (including the id and type)
But we are *just not having that*, because otherwise we're flying blind.
We *shall* reject objects lacking at least `:type`. Missing `:id` keys are
tolerable because they represent transient objects, which we expect to
handle."
[x]
(and (map? x) (:type x) true))
(object? nil)
(object? {:type "test"})
(defn persistent-object?
"`true` iff `x` is a persistent object.
Transient objects in ActivityPub are not required to have an `id` key, but persistent
ones must have a key, and it must be an IRI (but normally a URI)."
[x]
(try
(and (object? x) (uri? (URI. (:id x))))
(catch URISyntaxException _ false)))
(persistent-object? {:type "test" :id "https://mastodon.scot/@barfilfarm"})
(defn actor?
"TODO!"
[x]
true)
(def verb?
"The set of types we will accept as verbs.
There's an [explicit set of allowed verbs]
(https://www.w3.org/TR/activitystreams-vocabulary/#activity-types)."
#{"Accept" "Add" "Announce" "Arrive" "Block" "Create" "Delete" "Dislike"
"Flag" "Follow" "Ignore" "Invite" "Join" "Leave" "Like" "Listen" "Move"
"Offer" "Question" "Reject" "Read" "Remove" "TentativeAccept"
"TentativeReject" "Travel" "Undo" "Update" "View"})
(defn activity?
"`true` iff `x` is an activity, else false.
see "
[x]
(try
(and (object? x)
(uri? (URI. ((keyword "@context") x)))
(string? (:summary x))
(actor? (:actor x))
(verb? (:type x))
(or (object? (:object x)) (uri? (URI. x))))
(catch URISyntaxException _ false)))

View file

@ -0,0 +1,6 @@
(ns dog-and-duck.scratch.core)
(defn foo
"I don't do a whole lot."
[x]
(println x "Hello, World!"))

View file

@ -0,0 +1,20 @@
(ns dog-and-duck.scratch.parser
(:require [clojure.walk :refer [keywordize-keys]]
[clojure.data.json :as json]
[dog-and-duck.quack.quack :as q]))
(defn clean
"Take this `json` input, and return a sequence of ActivityPub objects
represented by it."
[json]
(let [feed (json/read-str json)]
(filter
q/object?
(cond (map? feed) (list (keywordize-keys feed))
(coll? feed) (map keywordize-keys feed)))))
(map :type (map keywordize-keys (json/read-str (slurp "resources/feed.json"))))
(keys (first (map keywordize-keys (json/read-str (slurp "resources/feed.json")))))
(q/object? (first (map keywordize-keys (json/read-str (slurp "resources/feed.json")))))

View file

@ -0,0 +1,44 @@
(ns dog-and-duck.scratch.scratch
"Scratchpad where I try to understand how to do this stuff."
(:require [clj-activitypub.core :as activitypub]
[clj-activitypub.webfinger :as webfinger]
[clj-pgp.core :as pgp]
[clj-pgp.keyring :as keyring]
[clj-pgp.generate :as pgp-gen]
[clojure.walk :refer [keywordize-keys]]
[clojure.pprint :refer [pprint]]))
;;; Use any ActivityPub account handle you like - for example, your own
(def account-handle "@simon_brooke@mastodon.scot")
(def handle (activitypub/parse-account account-handle))
(webfinger/fetch-user-id "mastodon.scot" "simon_brooke")
(apply webfinger/fetch-user-id (map handle [:domain :username]))
;;; Retrieve the account details from its home server
;;; (`keywordize-keys` is not necessary here but produces a more idiomatic clojure
;;; data structure)
(def account
"Fetch my account to mess with"
(let [handle (activitypub/parse-account account-handle)]
(keywordize-keys
(activitypub/fetch-user
(apply webfinger/fetch-user-id (map handle [:domain :username]))))))
;;; examine what you got back!
(:outbox account)
(def rsa (pgp-gen/rsa-keypair-generator 2048))
(def kp (pgp-gen/generate-keypair rsa :rsa-general))
;; how we make a public/private key pair. But this key pair is not the one
;; known to mastodon.scot as my key pair, so that doesn't get us very far...
;; I think.
(let [rsa (pgp-gen/rsa-keypair-generator 2048)
kp (pgp-gen/generate-keypair rsa :rsa-general)
public (-> kp .getPublicKey .getEncoded)
private (-> kp .getPrivateKey .getPrivateKeyDataPacket .getEncoded)]
(println (str "Public key: " public))
(println (str "Private key: " private))
)

View file

@ -0,0 +1,7 @@
(ns dog-and-duck.scratch.core-test
(:require [clojure.test :refer :all]
[dog-and-duck.scratch.parser :refer :all]))
(deftest a-test
(testing "FIXME, I fail."
(is (= 0 1))))