https://github.com/fedwiki/wiki-security-friends

A minimal security module using shared secrets
https://github.com/fedwiki/wiki-security-friends

Last synced: 5 days ago
JSON representation

A minimal security module using shared secrets

• Host: GitHub
• URL: https://github.com/fedwiki/wiki-security-friends
• Owner: fedwiki
• License: mit
• Created: 2016-08-13T16:32:32.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2023-10-29T08:47:17.000Z (about 1 year ago)
• Last Synced: 2024-09-30T17:15:36.338Z (about 1 month ago)
• Language: CoffeeScript
• Size: 808 KB
• Stars: 3
• Watchers: 4
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - fedwiki/wiki-security-friends - A minimal security module using shared secrets (others)

README

        
# Federated Wiki - Security Plug-in: Friends

This module creates its own secrets which it maintains in the `status/owner.json` file. No internet access is necessary to claim sites at will and ensure single owner access once claimed. We expect a farm operator is "friends" with each user and is available to help restore the long-lived session should it be lost.

Write access to a claimed site can be restored by clicking on the padlock and pasting in the site's

secret. This can be retrieved from the `status/owner.json` file by the site operator.

## Configuration

Launch the wiki server with three additional arguments, `security_type`, `cookieSecret` and `session_duration`.

```

--security_type friends

--cookieSecret 'REPLACE-THIS-SECRET'

--session_duration n

```

The security_type friends specifies to handle authentication with this module. Setting a `cookieSecret` makes sure that the session cookie encryption is consistent between server restarts. Otherwise each wiki owner would be logged out following a wiki server restart and would need to use the reclaim code to acquire a new session.

Setting a `session_duration` allows you to set a longer time for the sites sessions. `n` is the number of days that the session will last, the default is 7 days.