Mercurial > prosody-modules
annotate mod_rest/example/prosody_oauth.py @ 6261:1c62edeb9147
mod_pastebin: Update Readme
diff --git a/mod_pastebin/README.md b/mod_pastebin/README.md
--- a/mod_pastebin/README.md
+++ b/mod_pastebin/README.md
@@ -37,12 +37,14 @@ For example:
Pastes will be available by default at
`http://<your-prosody>:5280/pastebin/` by default.
-In Prosody 0.9 and later this can be changed with [HTTP
-settings](https://prosody.im/doc/http).
+Ports and path can be changed with [HTTP
+settings](https://prosody.im/doc/http), for example like:
-In 0.8 and older this can be changed with `pastebin_ports` (see below),
-or you can forward another external URL from your web server to Prosody,
-use `pastebin_url` to set that URL.
+``` {.lua}
+ http_paths = {
+ pastebin = "/$host-paste";
+ }
+```
# Discovery
@@ -82,27 +84,16 @@ The line and character tresholds are adv
pastebin_line_threshold The maximum number of lines a message may have before it is sent to the pastebin. (default 4 lines)
pastebin_trigger A string of characters (e.g. "!paste ") which if detected at the start of a message, always sends the message to the pastebin, regardless of length. (default: not set)
pastebin_expire_after Number of hours after which to expire (remove) a paste, defaults to 24. Set to 0 to store pastes permanently on disk.
- pastebin_ports List of ports to run the HTTP server on, same format as mod_httpserver's http_ports[^1]
- pastebin_url Base URL to display for pastebin links, must end with / and redirect to Prosody's built-in HTTP server[^2]
# Compatibility
- ------ -------
- trunk Works
+ ------ ---------------------
+ trunk Works as of 25-06-13
+ 13 Works
0.12 Works
- 0.11 Works
- 0.10 Works
- 0.9 Works
- 0.8 Works
- ------ -------
+ ------ ---------------------
# Todo
- Maximum paste length
- Web interface to submit pastes?
-
-[^1]: As of Prosody 0.9, `pastebin_ports` is replaced by `http_ports`,
- see [Prosody HTTP server documentation](https://prosody.im/doc/http)
-
-[^2]: See also
- [http_external_url](https://prosody.im/doc/http#external_url)
| author | Menel <menel@snikket.de> |
|---|---|
| date | Fri, 13 Jun 2025 11:39:58 +0200 |
| parents | 9a4556a13cc7 |
| children |
| rev | line source |
|---|---|
|
4952
ccce785f53e1
mod_rest: Add an example OAuth client (needs mod_http_oauth2)
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
1 from requests_oauthlib import OAuth2Session |
|
5269
0e5a37f55440
mod_rest: Update prosody_oauth.py example to non-legacy OAuth2
Kim Alvefur <zash@zash.se>
parents:
4952
diff
changeset
|
2 import requests |
|
4952
ccce785f53e1
mod_rest: Add an example OAuth client (needs mod_http_oauth2)
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
3 |
|
ccce785f53e1
mod_rest: Add an example OAuth client (needs mod_http_oauth2)
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
4 |
|
ccce785f53e1
mod_rest: Add an example OAuth client (needs mod_http_oauth2)
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
5 class ProsodyRestSession(OAuth2Session): |
|
5269
0e5a37f55440
mod_rest: Update prosody_oauth.py example to non-legacy OAuth2
Kim Alvefur <zash@zash.se>
parents:
4952
diff
changeset
|
6 def __init__( |
|
0e5a37f55440
mod_rest: Update prosody_oauth.py example to non-legacy OAuth2
Kim Alvefur <zash@zash.se>
parents:
4952
diff
changeset
|
7 self, base_url, client_name, client_uri, redirect_uri, *args, **kwargs |
|
0e5a37f55440
mod_rest: Update prosody_oauth.py example to non-legacy OAuth2
Kim Alvefur <zash@zash.se>
parents:
4952
diff
changeset
|
8 ): |
|
0e5a37f55440
mod_rest: Update prosody_oauth.py example to non-legacy OAuth2
Kim Alvefur <zash@zash.se>
parents:
4952
diff
changeset
|
9 self.base_url = base_url |
|
0e5a37f55440
mod_rest: Update prosody_oauth.py example to non-legacy OAuth2
Kim Alvefur <zash@zash.se>
parents:
4952
diff
changeset
|
10 discovery_url = base_url + "/.well-known/oauth-authorization-server" |
|
4952
ccce785f53e1
mod_rest: Add an example OAuth client (needs mod_http_oauth2)
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
11 |
|
5269
0e5a37f55440
mod_rest: Update prosody_oauth.py example to non-legacy OAuth2
Kim Alvefur <zash@zash.se>
parents:
4952
diff
changeset
|
12 meta = requests.get(discovery_url).json() |
|
0e5a37f55440
mod_rest: Update prosody_oauth.py example to non-legacy OAuth2
Kim Alvefur <zash@zash.se>
parents:
4952
diff
changeset
|
13 reg = requests.post( |
|
0e5a37f55440
mod_rest: Update prosody_oauth.py example to non-legacy OAuth2
Kim Alvefur <zash@zash.se>
parents:
4952
diff
changeset
|
14 meta["registration_endpoint"], |
|
0e5a37f55440
mod_rest: Update prosody_oauth.py example to non-legacy OAuth2
Kim Alvefur <zash@zash.se>
parents:
4952
diff
changeset
|
15 json={ |
|
0e5a37f55440
mod_rest: Update prosody_oauth.py example to non-legacy OAuth2
Kim Alvefur <zash@zash.se>
parents:
4952
diff
changeset
|
16 "client_name": client_name, |
|
0e5a37f55440
mod_rest: Update prosody_oauth.py example to non-legacy OAuth2
Kim Alvefur <zash@zash.se>
parents:
4952
diff
changeset
|
17 "client_uri": client_uri, |
|
0e5a37f55440
mod_rest: Update prosody_oauth.py example to non-legacy OAuth2
Kim Alvefur <zash@zash.se>
parents:
4952
diff
changeset
|
18 "redirect_uris": [redirect_uri], |
|
5488
9a4556a13cc7
mod_rest/example: Include 'application_type' in registration
Kim Alvefur <zash@zash.se>
parents:
5269
diff
changeset
|
19 "application_type": redirect_uri[:8] == "https://" |
|
9a4556a13cc7
mod_rest/example: Include 'application_type' in registration
Kim Alvefur <zash@zash.se>
parents:
5269
diff
changeset
|
20 and "web" |
|
9a4556a13cc7
mod_rest/example: Include 'application_type' in registration
Kim Alvefur <zash@zash.se>
parents:
5269
diff
changeset
|
21 or "native", |
|
5269
0e5a37f55440
mod_rest: Update prosody_oauth.py example to non-legacy OAuth2
Kim Alvefur <zash@zash.se>
parents:
4952
diff
changeset
|
22 }, |
|
0e5a37f55440
mod_rest: Update prosody_oauth.py example to non-legacy OAuth2
Kim Alvefur <zash@zash.se>
parents:
4952
diff
changeset
|
23 ).json() |
|
0e5a37f55440
mod_rest: Update prosody_oauth.py example to non-legacy OAuth2
Kim Alvefur <zash@zash.se>
parents:
4952
diff
changeset
|
24 |
|
0e5a37f55440
mod_rest: Update prosody_oauth.py example to non-legacy OAuth2
Kim Alvefur <zash@zash.se>
parents:
4952
diff
changeset
|
25 super().__init__(client_id=reg["client_id"], *args, **kwargs) |
|
0e5a37f55440
mod_rest: Update prosody_oauth.py example to non-legacy OAuth2
Kim Alvefur <zash@zash.se>
parents:
4952
diff
changeset
|
26 |
|
0e5a37f55440
mod_rest: Update prosody_oauth.py example to non-legacy OAuth2
Kim Alvefur <zash@zash.se>
parents:
4952
diff
changeset
|
27 self.meta = meta |
|
0e5a37f55440
mod_rest: Update prosody_oauth.py example to non-legacy OAuth2
Kim Alvefur <zash@zash.se>
parents:
4952
diff
changeset
|
28 self.client_secret = reg["client_secret"] |
|
0e5a37f55440
mod_rest: Update prosody_oauth.py example to non-legacy OAuth2
Kim Alvefur <zash@zash.se>
parents:
4952
diff
changeset
|
29 self.client_id = reg["client_id"] |
|
0e5a37f55440
mod_rest: Update prosody_oauth.py example to non-legacy OAuth2
Kim Alvefur <zash@zash.se>
parents:
4952
diff
changeset
|
30 |
|
0e5a37f55440
mod_rest: Update prosody_oauth.py example to non-legacy OAuth2
Kim Alvefur <zash@zash.se>
parents:
4952
diff
changeset
|
31 def authorization_url(self, *args, **kwargs): |
|
0e5a37f55440
mod_rest: Update prosody_oauth.py example to non-legacy OAuth2
Kim Alvefur <zash@zash.se>
parents:
4952
diff
changeset
|
32 return super().authorization_url( |
|
0e5a37f55440
mod_rest: Update prosody_oauth.py example to non-legacy OAuth2
Kim Alvefur <zash@zash.se>
parents:
4952
diff
changeset
|
33 self.meta["authorization_endpoint"], *args, **kwargs |
|
0e5a37f55440
mod_rest: Update prosody_oauth.py example to non-legacy OAuth2
Kim Alvefur <zash@zash.se>
parents:
4952
diff
changeset
|
34 ) |
|
4952
ccce785f53e1
mod_rest: Add an example OAuth client (needs mod_http_oauth2)
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
35 |
|
ccce785f53e1
mod_rest: Add an example OAuth client (needs mod_http_oauth2)
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
36 def fetch_token(self, *args, **kwargs): |
|
5269
0e5a37f55440
mod_rest: Update prosody_oauth.py example to non-legacy OAuth2
Kim Alvefur <zash@zash.se>
parents:
4952
diff
changeset
|
37 return super().fetch_token( |
|
0e5a37f55440
mod_rest: Update prosody_oauth.py example to non-legacy OAuth2
Kim Alvefur <zash@zash.se>
parents:
4952
diff
changeset
|
38 token_url=self.meta["token_endpoint"], |
|
0e5a37f55440
mod_rest: Update prosody_oauth.py example to non-legacy OAuth2
Kim Alvefur <zash@zash.se>
parents:
4952
diff
changeset
|
39 client_secret=self.client_secret, |
|
0e5a37f55440
mod_rest: Update prosody_oauth.py example to non-legacy OAuth2
Kim Alvefur <zash@zash.se>
parents:
4952
diff
changeset
|
40 *args, |
|
0e5a37f55440
mod_rest: Update prosody_oauth.py example to non-legacy OAuth2
Kim Alvefur <zash@zash.se>
parents:
4952
diff
changeset
|
41 **kwargs |
|
0e5a37f55440
mod_rest: Update prosody_oauth.py example to non-legacy OAuth2
Kim Alvefur <zash@zash.se>
parents:
4952
diff
changeset
|
42 ) |
|
4952
ccce785f53e1
mod_rest: Add an example OAuth client (needs mod_http_oauth2)
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
43 |
|
ccce785f53e1
mod_rest: Add an example OAuth client (needs mod_http_oauth2)
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
44 def xmpp(self, json=None, *args, **kwargs): |
|
5269
0e5a37f55440
mod_rest: Update prosody_oauth.py example to non-legacy OAuth2
Kim Alvefur <zash@zash.se>
parents:
4952
diff
changeset
|
45 return self.post(self.base_url + "/rest", json=json, *args, **kwargs) |
|
4952
ccce785f53e1
mod_rest: Add an example OAuth client (needs mod_http_oauth2)
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
46 |
|
ccce785f53e1
mod_rest: Add an example OAuth client (needs mod_http_oauth2)
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
47 |
|
ccce785f53e1
mod_rest: Add an example OAuth client (needs mod_http_oauth2)
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
48 if __name__ == "__main__": |
|
ccce785f53e1
mod_rest: Add an example OAuth client (needs mod_http_oauth2)
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
49 # Example usage |
|
ccce785f53e1
mod_rest: Add an example OAuth client (needs mod_http_oauth2)
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
50 |
|
ccce785f53e1
mod_rest: Add an example OAuth client (needs mod_http_oauth2)
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
51 # from prosody_oauth import ProsodyRestSession |
|
ccce785f53e1
mod_rest: Add an example OAuth client (needs mod_http_oauth2)
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
52 from getpass import getpass |
|
ccce785f53e1
mod_rest: Add an example OAuth client (needs mod_http_oauth2)
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
53 |
|
5269
0e5a37f55440
mod_rest: Update prosody_oauth.py example to non-legacy OAuth2
Kim Alvefur <zash@zash.se>
parents:
4952
diff
changeset
|
54 p = ProsodyRestSession( |
|
0e5a37f55440
mod_rest: Update prosody_oauth.py example to non-legacy OAuth2
Kim Alvefur <zash@zash.se>
parents:
4952
diff
changeset
|
55 input("Base URL: "), |
|
0e5a37f55440
mod_rest: Update prosody_oauth.py example to non-legacy OAuth2
Kim Alvefur <zash@zash.se>
parents:
4952
diff
changeset
|
56 "Prosody mod_rest OAuth 2 example", |
|
0e5a37f55440
mod_rest: Update prosody_oauth.py example to non-legacy OAuth2
Kim Alvefur <zash@zash.se>
parents:
4952
diff
changeset
|
57 "https://modules.prosody.im/mod_rest", |
|
0e5a37f55440
mod_rest: Update prosody_oauth.py example to non-legacy OAuth2
Kim Alvefur <zash@zash.se>
parents:
4952
diff
changeset
|
58 "urn:ietf:wg:oauth:2.0:oob", |
|
0e5a37f55440
mod_rest: Update prosody_oauth.py example to non-legacy OAuth2
Kim Alvefur <zash@zash.se>
parents:
4952
diff
changeset
|
59 ) |
|
0e5a37f55440
mod_rest: Update prosody_oauth.py example to non-legacy OAuth2
Kim Alvefur <zash@zash.se>
parents:
4952
diff
changeset
|
60 |
|
0e5a37f55440
mod_rest: Update prosody_oauth.py example to non-legacy OAuth2
Kim Alvefur <zash@zash.se>
parents:
4952
diff
changeset
|
61 print("Open the following URL in a browser and login:") |
|
0e5a37f55440
mod_rest: Update prosody_oauth.py example to non-legacy OAuth2
Kim Alvefur <zash@zash.se>
parents:
4952
diff
changeset
|
62 print(p.authorization_url()[0]) |
|
0e5a37f55440
mod_rest: Update prosody_oauth.py example to non-legacy OAuth2
Kim Alvefur <zash@zash.se>
parents:
4952
diff
changeset
|
63 |
|
0e5a37f55440
mod_rest: Update prosody_oauth.py example to non-legacy OAuth2
Kim Alvefur <zash@zash.se>
parents:
4952
diff
changeset
|
64 p.fetch_token(code=getpass("Paste Authorization code: ")) |
|
4952
ccce785f53e1
mod_rest: Add an example OAuth client (needs mod_http_oauth2)
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
65 |
|
ccce785f53e1
mod_rest: Add an example OAuth client (needs mod_http_oauth2)
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
66 print(p.xmpp(json={"disco": True, "to": "jabber.org"}).json()) |
