fep

FEP-f12e: Consent-respecting attributions

Summary

This document defines how to show, in a consent-respecting way, who has attributed importance to an ActivityPub object, for example as author, contributor or organizer.

It defines an attributions property containing a Collection of Relationship items. Each item states that a party (usually an Actor) has attributed importance to the object that carries the property. It also defines a flow by which the consent of the actors listed in that collection can be requested, proven, and revoked.

[!NOTE] The property attributedTo is left unchanged because in current Fediverse applications it is typically used to define the single Actor that published that object.

Motivation

An event may have several organizers, an article several authors, a video several creators. Credited parties may have different origins, or may not be a Fediverse Actor at all. In practice attributedTo is used as “the Actor that published this”. It is not a good place for attribution or credit that is shared or has roles. Applications that handle multiple ActivityPub object types should not need type-specific properties to find out who has attributed importance to an Object.

Requirements

The key words “MUST”, “MUST NOT”, “SHOULD”, “SHOULD NOT” and “MAY” in this document are to be interpreted as described in RFC-2119.

The publisher of an object is the Actor that published it, usually the Actor who sent a Create activity with that object and is in its attributedTo.

An item in an attributions collection is local if the origin of its object is the same as the origin of the object that contains the collection, and remote otherwise. This is independent of which server is processing the object.

When to use

Most objects need nothing beyond attributedTo. If the only party that attributed importance to an Object is the single Actor in attributedTo, the attributions property SHOULD NOT be used.

The attributions property SHOULD be used when the object has important attributions and at least one of the following applies:

[!WARNING] attributions is designed for a “handful” of parties. Very long lists (for example the end credits of a film) may require a different way of being handled.

Attributions grant no rights

Applications MUST NOT treat being listed in attributions as granting any right to update or delete the object.

Updating attributions

Items and kinds of attributions

Items of the attributions collection are ActivityStreams Relationship objects:

An item reads “subject has relationship object”, for example “Article 1 has the author Actor 1”. If given relationship MUST be a property defined in this direction (work to party), as schema.org’s author, contributor and organizer are.

The subject MAY be omitted if the collection is embedded via the attributions property, in which case the containing object is the subject, or if the context of a standalone collection states it. Consumers MUST fill in an omitted subject before comparing items (see Verification).

The vocabulary of relationship is open-ended, and consumers are not required to understand particular values. A consumer that does not understand a value SHOULD treat the item as a general credit without a role label.

Disclosure

[!WARNING] A malicious actor or application might put Actors into an attributions collection without their consent, and so falsely imply that they have attributed importance to an object.

For items of the attributions collection:

[!NOTE] This section is inspired by FEP-044f. Especially note non-normative sections “Server behavior considerations” and “Security considerations” of FEP-044f, which apply to this FEP accordingly.

The flow below shows how consent is established, how proof can be given to third parties, and how it can be revoked. Remote actors MUST NOT be added to an attributions collection until their consent has been obtained as follows:

  1. Request: The publisher sends an AttributionRequest addressed (to) to the candidate actor. Its object is the Relationship the candidate is asked to consent to, with subject, relationship and object (the candidate) all stated.
  2. Response: The candidate replies with an Accept or Reject. Its object is the full AttributionRequest. An Accept MUST have a result property that links to (not embeds) to that dereferenceable AttributionAuthorization.
  3. Listing: On receiving an Accept, the publisher MUST add a Relationship item with an attributionAuthorization property referencing the authorization to the attributions collection, and MUST send an Update of the object. On receiving a Reject, the publisher MUST NOT add the actor.
  4. Revocation: The actor revokes consent by deleting the AttributionAuthorization with a Delete activity addressed to the publisher. The object of that Delete MUST be a Tombstone that embeds the formerType and the original properties of the authorization, because the publisher can no longer dereference the deleted object to learn what was revoked. On receiving it, the publisher MUST remove the item from attributions and MUST send an Update of the object. The actor MAY also send an Undo of the Accept (with the complete Accept as its object) as an additional signal to the publisher. The Delete is authoritative.

The object of every activity in this flow MUST be embedded in full, not given as an id only. For example, an Undo MUST contain the complete Accept, which contains the complete AttributionRequest.

Verification

A consumer that wants to verify an item of an attributions collection whose object is a remote Actor:

  1. MUST dereference the attributionAuthorization of the item. If it cannot be retrieved, or returns 410 Gone or a Tombstone, the consent MUST be treated as not given or withdrawn.
  2. MUST check that the id of the authorization is on the same origin as its attributedTo, and that attributedTo equals the object of the item.
  3. MUST, after filling in an omitted subject from the containing object, check that the subject, relationship and object of the item equal those of the Relationship embedded as the object of the authorization.

Consent covers exactly the one Relationship that is embedded in the authorization.

A consumer SHOULD re-verify an already verified attribution, when the object is accessed for the first time in a given period of time.

Terms

attributions

URI
https://w3id.org/fep/f12e/attributions
Label
Attributions Collection
Comment
An ActivityStreams Collection of Relationship items that list the parties that have attributed importance to an object.
Domain
Object
Range
Collection (See Activity Streams 2.0 Core specification for a complete description)
Required
No
Functional
No
Is defined by
FEP-f12e
    
{
  "@context": [
    "https://www.w3.org/ns/activitystreams",
    "https://w3id.org/fep/f12e"
  ],
  "type": "Article",
  "id": "https://example.com/article/1",
  "name": "Paper on the Fediverse",
  "attributions": {
    "type": "Collection",
    "totalItems": 3,
    "items": [
      {
        "type": "Relationship",
        "relationship": "https://schema.org/author",
        "object": "https://example.org/actors/1",
        "attributionAuthorization": "https://example.org/actors/1/attributions/1"
      },
      {
        "type": "Relationship",
        "relationship": "https://schema.org/contributor",
        "object": "https://example.net/actors/2",
        "attributionAuthorization": "https://example.net/actors/2/attributions/7"
      },
      {
        "type": "Relationship",
        "relationship": "https://schema.org/contributor",
        "object": {
          "type": "Link",
          "name": "Some Person",
          "href": "https://some.persons.personal.website"
        }
      }
    ]
  },
  "content": "FEP-f12e introduced..."
}
    
  
    
{
  "@context": "https://www.w3.org/ns/activitystreams",
  "type": "Event",
  "id": "https://example.com/events/1",
  "name": "Fediverse Meetup",
  "attributions": {
    "type": "Collection",
    "totalItems": 2,
    "items": [
      {
        "type": "Relationship",
        "relationship": "https://schema.org/organizer",
        "object": "https://example.org/groups/1",
        "attributionAuthorization": "https://example.org/groups/1/attributions/3"
      },
      {
        "type": "Relationship",
        "relationship": "https://schema.org/organizer",
        "object": "https://example.com/actors/3"
      }
    ]
  }
}
    
  
    
{
  "@context": "https://www.w3.org/ns/activitystreams",
  "type": "Video",
  "id": "https://example.com/videos/1",
  "name": "Interview",
  "attributions": {
    "type": "Collection",
    "totalItems": 1,
    "items": [
      {
        "type": "Relationship",
        "relationship": "https://vocab.example/terms/interviewee",
        "object": "https://example.org/actors/4",
        "attributionAuthorization": "https://example.org/actors/4/attributions/2"
      }
    ]
  }
}
    
  

attributionAuthorization

URI
https://w3id.org/fep/f12e/attributionAuthorization
Label
has an attribution authorization
Comment
References an AttributionAuthorization that proves the consent of the attributed party to be listed in the attributions Collection of an object.
Domain
Relationship
Range
An AttributionAuthorization (@id)
Required
No
Functional
Yes
Is defined by
FEP-f12e
    
{
  "@context": [
    "https://www.w3.org/ns/activitystreams",
    "https://w3id.org/fep/f12e"
  ],
  "type": "Relationship",
  "subject": "https://example.com/article/1",
  "relationship": "https://schema.org/author",
  "object": "https://example.org/actors/1",
  "attributionAuthorization": "https://example.org/actors/1/attributions/1"
}
    
  

AttributionAuthorization

URI
https://w3id.org/fep/f12e/AttributionAuthorization
Label
Attribution Authorization
Comment
A revocable approval stamp issued by an actor. Its object is the Relationship the actor consents to.
Subclass of
Object
See also
attributionAuthorization | AttributionRequest
Is defined by
FEP-f12e
    
{
  "@context": [
    "https://www.w3.org/ns/activitystreams",
    "https://w3id.org/fep/f12e"
  ],
  "type": "AttributionAuthorization",
  "id": "https://example.org/actors/1/attributions/1",
  "attributedTo": "https://example.org/actors/1",
  "object": {
    "type": "Relationship",
    "subject": "https://example.com/article/1",
    "relationship": "https://schema.org/author",
    "object": "https://example.org/actors/1"
  }
}
    
  

AttributionRequest

URI
https://w3id.org/fep/f12e/AttributionRequest
Label
Attribution Request
Comment
An activity by which the publisher of an object asks an actor for consent to be listed in the attributions of that object. Its object is the Relationship the actor is asked to consent to.
Subclass of
Activity
See also
AttributionAuthorization
Is defined by
FEP-f12e
    
{
  "@context": [
    "https://www.w3.org/ns/activitystreams",
    "https://w3id.org/fep/f12e"
  ],
  "type": "AttributionRequest",
  "id": "https://example.com/actors/publisher/activities/1",
  "actor": "https://example.com/actors/publisher",
  "to": "https://example.org/actors/1",
  "object": {
    "type": "Relationship",
    "subject": "https://example.com/article/1",
    "relationship": "https://schema.org/author",
    "object": "https://example.org/actors/1"
  }
}
    
  
    
{
  "@context": [
    "https://www.w3.org/ns/activitystreams",
    "https://w3id.org/fep/f12e"
  ],
  "type": "Accept",
  "id": "https://example.org/actors/1/activities/5",
  "actor": "https://example.org/actors/1",
  "to": "https://example.com/actors/publisher",
  "object": {
    "type": "AttributionRequest",
    "id": "https://example.com/actors/publisher/activities/1",
    "actor": "https://example.com/actors/publisher",
    "to": "https://example.org/actors/1",
    "object": {
      "type": "Relationship",
      "subject": "https://example.com/article/1",
      "relationship": "https://schema.org/author",
      "object": "https://example.org/actors/1"
    }
  },
  "result": "https://example.org/actors/1/attributions/1"
}
    
  
    
{
  "@context": [
    "https://www.w3.org/ns/activitystreams",
    "https://w3id.org/fep/f12e"
  ],
  "type": "Delete",
  "id": "https://example.org/actors/1/activities/9",
  "actor": "https://example.org/actors/1",
  "to": "https://example.com/actors/publisher",
  "object": {
    "type": "Tombstone",
    "id": "https://example.org/actors/1/attributions/1",
    "formerType": "AttributionAuthorization",
    "attributedTo": "https://example.org/actors/1",
    "object": {
      "type": "Relationship",
      "subject": "https://example.com/article/1",
      "relationship": "https://schema.org/author",
      "object": "https://example.org/actors/1"
    }
  }
}
    
  

References

CC0 1.0 Universal (CC0 1.0) Public Domain Dedication

To the extent possible under law, the authors of this Fediverse Enhancement Proposal have waived all copyright and related or neighboring rights to this work.