distraction.party/docs/dev.md

This document contains notes and guidelines for Pleroma developers.

Authentication & Authorization

OAuth token-based authentication & authorization

• Pleroma supports hierarchical OAuth scopes, just like Mastodon but with added granularity of admin scopes. For a reference, see Mastodon OAuth scopes.

• It is important to either define OAuth scope restrictions or explicitly mark OAuth scope check as skipped, for every controller action. To define scopes, call plug(Pleroma.Web.Plugs.OAuthScopesPlug, %{scopes: [...]}). To explicitly set OAuth scopes check skipped, call plug(:skip_plug, Pleroma.Web.Plugs.OAuthScopesPlug <when ...>).

• In controllers, use Pleroma.Web, :controller will result in action/2 (see Pleroma.Web.controller/0 for definition) be called prior to actual controller action, and it'll perform security / privacy checks before passing control to actual controller action.

  For routes with :authenticated_api pipeline, authentication & authorization are expected, thus OAuthScopesPlug will be run unless explicitly skipped (also EnsureAuthenticatedPlug will be executed immediately before action even if there was an early run to give an early error, since OAuthScopesPlug supports :proceed_unauthenticated option, and other plugs may support similar options as well).

  For :api pipeline routes, it'll be verified whether OAuthScopesPlug was called or explicitly skipped, and if it was not then auth information will be dropped for request. Then EnsurePublicOrAuthenticatedPlug will be called to ensure that either the instance is not private or user is authenticated (unless explicitly skipped). Such automated checks help to prevent human errors and result in higher security / privacy for users.

HTTP Basic Authentication

• With HTTP Basic Auth, OAuth scopes check is not performed for any action (since password is provided during the auth, requester is able to obtain a token with full permissions anyways). Pleroma.Web.Plugs.AuthenticationPlug and Pleroma.Web.Plugs.LegacyAuthenticationPlug both call Pleroma.Web.Plugs.OAuthScopesPlug.skip_plug(conn) when password is provided.

Auth-related configuration, OAuth consumer mode etc.

See Authentication section of the configuration cheatsheet.

MRF policies descriptions

If MRF policy depends on config, it can be added into MRF tab to adminFE by adding config_description/0 method, which returns map with special structure.

Example:

%{
      key: :mrf_activity_expiration,
      related_policy: "Pleroma.Web.ActivityPub.MRF.ActivityExpirationPolicy",
      label: "MRF Activity Expiration Policy",
      description: "Adds automatic expiration to all local activities",
      children: [
        %{
          key: :days,
          type: :integer,
          description: "Default global expiration time for all local activities (in days)",
          suggestions: [90, 365]
        }
      ]
    }