https://github.com/apple502j/bpauthorization
Authenticate and authorize using BotPassword and Authorization header.
https://github.com/apple502j/bpauthorization
mediawiki-extension
Last synced: about 2 months ago
JSON representation
Authenticate and authorize using BotPassword and Authorization header.
- Host: GitHub
- URL: https://github.com/apple502j/bpauthorization
- Owner: apple502j
- License: gpl-2.0
- Created: 2021-01-04T11:28:56.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-01-04T11:29:11.000Z (over 4 years ago)
- Last Synced: 2025-02-13T07:15:34.610Z (3 months ago)
- Topics: mediawiki-extension
- Language: PHP
- Homepage:
- Size: 11.7 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# BPAuthorization
BPAuthorization allows bots to access the API (both Action API and REST API) using an `Authorization` header with a bot password, instead of a complex method like OAuth, or classic Cookie-based login.
## Authentication and Authorization
Set the request header, `Authorization`, to `Bot B64USERNAME:B64BOTNAME:B64PASSWORD`, where `B64USERNAME` is the bot's username (base64ed), `B64BOTNAME` is the bot name (base64ed), and `B64PASSWORD` is the bot password (base64ed).
This authentication/authorization method should only be used on a client (i.e. a bot), not a website. Anyone who can read the header value can access the bot password.
## Example
Here is a Python code to create a page.
```py
from base64 import b64encode
import requests
# The bot's username.
NAME = b64encode(b"ExampleBot").decode("ascii")
# The bot's bot name on Special:BotPasswords.
BOTNAME = b64encode(b"PageCreationExample").decode("ascii")
# Bot password. Always keep this secret!
PW = b64encode(b"0ok82q312pofknfcfd9ix0p4aqk3wqt4").decode("ascii")
resp = requests.put("https://wiki.example.org/w/rest.php/v1/page/BPAuthorization", headers={
"Authorization": f"Bot {NAME}:{BOTNAME}:{PW}"
}, json={
"source": "This page is created using BPAuthorization, a cool extension for authentication.",
"comment": "Created a page using BPAuthorization"
})
print(resp.json())
```