Compare commits

..

10 commits

Author SHA1 Message Date
dece a90b513369 WIP 2022-01-02 17:37:56 +01:00
dece f4bc3f7568 help: bad fix for missing config keys
The unknown config value will be displayed without warning or anything
to the user in the help page, which can be confusing e.g. when mixing
dash and underscore in keys. oh well
2022-01-02 17:34:27 +01:00
dece b1c3f6c518 board: update 2022-01-02 17:33:39 +01:00
dece 04e7a02407 readme: clarify plugin installation with pipx 2022-01-02 17:06:49 +01:00
dece 325c285675 browser: add quit info in the C-c message 2021-12-14 16:48:09 +01:00
dece 41aff7acba browser: add i keybind to show page info 2021-12-14 16:48:09 +01:00
dece 0f35971493 browser/gemini: avoid inf. recursion on code 60
If the server would blindly respond with code 60 even though we present
a client certificate, it would trigger an infinite recursive call
(open_gemini_url → _handle_response → _handle_cert_required).
2021-11-15 14:15:07 +01:00
dece e0a5ca94ec browser/gemini: fix crash during handshake 2021-11-15 09:52:01 +01:00
dece ef6b8929e3 browser: make max redirection value a class var 2021-11-15 09:51:33 +01:00
dece f48a8ab606 protocol: format 2021-11-15 09:51:20 +01:00
6 changed files with 66 additions and 35 deletions

View file

@ -36,6 +36,9 @@ better default editor than vim
search engine search engine
auto-open some media types auto-open some media types
use about scheme instead of bebop use about scheme instead of bebop
don't store explicit port 1965 in URL prefixes (e.g. for identities)
fix shifted line detection when text goes belong the horizontal limit
auto-rewrite missing "/" in empty URL paths

View file

@ -54,9 +54,8 @@ have it installed, check out this Gemini link `gemini://dece.space/dev/faq/using
[py-faq-http]: https://portal.mozz.us/gemini/dece.space/dev/faq/using-python-programs.gmi [py-faq-http]: https://portal.mozz.us/gemini/dece.space/dev/faq/using-python-programs.gmi
The easier installation method is using Pip, either user or system-wide The recommended installation method is using Pipx, but using Pip is fine, either
installation. I recommend user installation, but a system-wide installation user or system-wide installation.
should not cause issues as there are no dependencies.
```bash ```bash
# User installation: # User installation:
@ -124,6 +123,16 @@ Here is a list of plugins I did, available on PyPI:
[plugin-finger]: plugins/finger/README.md [plugin-finger]: plugins/finger/README.md
[plugin-gopher]: plugins/gopher/README.md [plugin-gopher]: plugins/gopher/README.md
Plugins have to be installed in the same Python environment as Bebop. If you
installed Bebop using Pipx, this is done using the `inject` command.
```bash
# Installating the Gopher plugin in the user environment:
pip3 install --user bebop-browser-gopher
# Installating the Gopher plugin for a Pipx installation:
pipx inject bebop-browser bebop-browser-gopher
```
Usage Usage

View file

@ -69,6 +69,7 @@ class Browser:
SEARCH_NEXT = 0 SEARCH_NEXT = 0
SEARCH_PREVIOUS = 1 SEARCH_PREVIOUS = 1
MAX_REDIRECTIONS = 5
def __init__(self, config, cert_stash): def __init__(self, config, cert_stash):
self.config = config self.config = config
@ -426,7 +427,7 @@ class Browser:
- history: whether the URL should be pushed to history on success. - history: whether the URL should be pushed to history on success.
- use_cache: whether we should look for an already cached document. - use_cache: whether we should look for an already cached document.
""" """
if redirects > 5: if redirects > self.MAX_REDIRECTIONS:
self.set_status_error(f"Too many redirections ({url}).") self.set_status_error(f"Too many redirections ({url}).")
return return

View file

@ -24,8 +24,8 @@ MAX_URL_LEN = 1024
def open_gemini_url( def open_gemini_url(
browser: Browser, browser: Browser,
url: str, url: str,
redirects: int =0, redirects: int = 0,
use_cache: bool =False, use_cache: bool = False,
cert_and_key=None cert_and_key=None
) -> Optional[str]: ) -> Optional[str]:
"""Open a Gemini URL and set the formatted response as content. """Open a Gemini URL and set the formatted response as content.
@ -41,9 +41,9 @@ def open_gemini_url(
present the user the problems found and let her decide whether to trust present the user the problems found and let her decide whether to trust
temporarily the certificate or not BUT we currently do not parse the temporarily the certificate or not BUT we currently do not parse the
certificate's fields, not even the pubkey, so this state is never used. certificate's fields, not even the pubkey, so this state is never used.
- STATE_UNKNOWN_CERT: the certificate is valid but has not been seen before; - STATE_UNKNOWN_CERT: the certificate is valid but has not been seen
as we're doing TOFU here, we could automatically trust it or let the user before; as we're doing TOFU here, we could automatically trust it or let
choose. For simplicity, we always trust it permanently. the user choose. For simplicity, we always trust it permanently.
Arguments: Arguments:
- browser: Browser object making the request. - browser: Browser object making the request.
@ -111,16 +111,21 @@ def open_gemini_url(
trust_always=True trust_always=True
) )
try:
data = req.proceed() data = req.proceed()
except OSError:
browser.set_status_error(f"Connection error ({url}).")
return None
if not data: if not data:
browser.set_status_error(f"Server did not respond in time ({url}).") browser.set_status_error(f"Response empty or timed out ({url}).")
return None return None
response = Response.parse(data) response = Response.parse(data)
if not response: if not response:
browser.set_status_error(f"Server response parsing failed ({url}).") browser.set_status_error(f"Response parsing failed ({url}).")
return None return None
return _handle_response(browser, response, url, redirects) return _handle_response(browser, response, url, redirects,
used_cert=cert_and_key is not None)
def _handle_untrusted_cert(browser: Browser, request: Request): def _handle_untrusted_cert(browser: Browser, request: Request):
@ -147,7 +152,8 @@ def _handle_response(
browser: Browser, browser: Browser,
response: Response, response: Response,
url: str, url: str,
redirects: int redirects: int,
used_cert: bool = False,
) -> Optional[str]: ) -> Optional[str]:
"""Handle a response from a Gemini server. """Handle a response from a Gemini server.
@ -171,6 +177,10 @@ def _handle_response(
elif response.generic_code == 10: elif response.generic_code == 10:
return _handle_input_request(browser, url, response.meta) return _handle_input_request(browser, url, response.meta)
elif response.code == 60: elif response.code == 60:
if used_cert:
error = "Server ignored our certificate."
browser.set_status_error(error)
else:
return _handle_cert_required(browser, response, url, redirects) return _handle_cert_required(browser, response, url, redirects)
elif response.code in (61, 62): elif response.code in (61, 62):
details = response.meta or Response.code.name details = response.meta or Response.code.name
@ -182,7 +192,11 @@ def _handle_response(
return None return None
def _handle_successful_response(browser: Browser, response: Response, url: str): def _handle_successful_response(
browser: Browser,
response: Response,
url: str
):
"""Handle a successful response content from a Gemini server. """Handle a successful response content from a Gemini server.
According to the MIME type received or inferred, the response is either According to the MIME type received or inferred, the response is either
@ -215,7 +229,8 @@ def _handle_successful_response(browser: Browser, response: Response, url: str):
error = f"Unknown encoding {encoding}." error = f"Unknown encoding {encoding}."
else: else:
render_opts = get_render_options(browser.config) render_opts = get_render_options(browser.config)
pref_mode = get_url_render_mode_pref(browser.capsule_prefs, url) pref_mode = get_url_render_mode_pref(
browser.capsule_prefs, url)
if pref_mode: if pref_mode:
render_opts.mode = pref_mode render_opts.mode = pref_mode
page = Page.from_gemtext(text, render_opts) page = Page.from_gemtext(text, render_opts)
@ -255,7 +270,7 @@ def _handle_successful_response(browser: Browser, response: Response, url: str):
def _handle_input_request( def _handle_input_request(
browser: Browser, browser: Browser,
from_url: str, from_url: str,
message: str =None message: str = None
) -> Optional[str]: ) -> Optional[str]:
"""Focus command-line to pass input to the server. """Focus command-line to pass input to the server.
@ -311,11 +326,12 @@ def _handle_cert_required(
def select_identity(identities: list): def select_identity(identities: list):
"""Let user select the appropriate identity among candidates.""" """Let user select the appropriate identity among candidates."""
# TODO support multiple identities; for now we just use the first available. # TODO support multiple identities; for now we just use the first
# available.
return identities[0] if identities else None return identities[0] if identities else None
def create_identity(browser: Browser, url: str, reason: Optional[str] =None): def create_identity(browser: Browser, url: str, reason: Optional[str] = None):
"""Walk the user through identity creation. """Walk the user through identity creation.
Returns: Returns:
@ -352,7 +368,7 @@ def create_identity(browser: Browser, url: str, reason: Optional[str] =None):
def forget_certificate(browser: Browser, hostname: str): def forget_certificate(browser: Browser, hostname: str):
"""Remove the fingerprint associated to this hostname for the cert stash.""" """Remove the fingerprint for this hostname from the cert stash."""
key = browser.prompt(f"Remove fingerprint for {hostname}?") key = browser.prompt(f"Remove fingerprint for {hostname}?")
if key != "y": if key != "y":
browser.reset_status() browser.reset_status()
@ -360,4 +376,5 @@ def forget_certificate(browser: Browser, hostname: str):
if untrust_fingerprint(browser.stash, hostname): if untrust_fingerprint(browser.stash, hostname):
browser.set_status(f"Known certificate for {hostname} removed.") browser.set_status(f"Known certificate for {hostname} removed.")
else: else:
browser.set_status_error(f"Known certificate for {hostname} not found.") browser.set_status_error(
f"Known certificate for {hostname} not found.")

View file

@ -104,7 +104,7 @@ def get_help(config, plugins):
config_list = "\n".join( config_list = "\n".join(
( (
f"* {key} = {config[key]} (default {repr(DEFAULT_CONFIG[key])})" f"* {key} = {config[key]} (default {repr(DEFAULT_CONFIG[key])})"
if config[key] != DEFAULT_CONFIG[key] if key in DEFAULT_CONFIG and config[key] != DEFAULT_CONFIG[key]
else f"* {key} = {config[key]}" else f"* {key} = {config[key]}"
) )
for key in sorted(config) for key in sorted(config)

View file

@ -26,8 +26,8 @@ class Request:
sending the request header and receiving the response: sending the request header and receiving the response:
1. Instantiate a Request. 1. Instantiate a Request.
2. `connect` opens the connection and aborts it or leaves the caller free to 2. `connect` opens the connection and aborts it or leaves the caller free
check stuff. to check stuff.
3. `proceed` or `abort` can be called. 3. `proceed` or `abort` can be called.
Attributes: Attributes:
@ -35,8 +35,8 @@ class Request:
- cert_stash: certificate stash to use an possibly update. - cert_stash: certificate stash to use an possibly update.
- state: request state. - state: request state.
- hostname: hostname derived from url, stored when `connect` is called. - hostname: hostname derived from url, stored when `connect` is called.
- payload: bytes object of the payload request; build during `connect`, used - payload: bytes object of the payload request; build during `connect`,
during `proceed`. used during `proceed`.
- ssock: TLS-wrapped socket. - ssock: TLS-wrapped socket.
- cert_validation: validation results dict, set after certificate has been - cert_validation: validation results dict, set after certificate has been
reviewed. reviewed.
@ -79,12 +79,12 @@ class Request:
certificate status is not CertStatus.VALID (Request.STATE_OK). certificate status is not CertStatus.VALID (Request.STATE_OK).
If connect returns False, the secure socket is aborted before return so If connect returns False, the secure socket is aborted before return so
there is no need to call `abort`. If connect returns True, it is up to the there is no need to call `abort`. If connect returns True, it is up to
caller to decide whether to continue (call `proceed`) the connection or the caller to decide whether to continue (call `proceed`) the
abort it (call `abort`). connection or abort it (call `abort`).
The request `state` is updated to reflect the connection state after the The request `state` is updated to reflect the connection state after
function returns. The following list describes states related to the function returns. The following list describes states related to
connection failure (False returned): connection failure (False returned):
- STATE_INVALID_URL: URL is not valid. - STATE_INVALID_URL: URL is not valid.
@ -95,8 +95,8 @@ class Request:
For all request states from now on, the `cert_validation` attribute is For all request states from now on, the `cert_validation` attribute is
updated with the result of the certificate validation. updated with the result of the certificate validation.
The following list describes states related to validation failure (False The following list describes states related to validation failure
returned): (False returned):
- STATE_ERROR_CERT: server certificate could not be validated at all. - STATE_ERROR_CERT: server certificate could not be validated at all.
- STATE_UNTRUSTED_CERT: server certificate mismatched the known - STATE_UNTRUSTED_CERT: server certificate mismatched the known
@ -117,7 +117,8 @@ class Request:
- The DER hash is compared against the fingerprint for this hostname - The DER hash is compared against the fingerprint for this hostname
*and port*; the specification does not tell much about that, but we *and port*; the specification does not tell much about that, but we
are slightly more restrictive here by adding the port in the equation. are slightly more restrictive here by adding the port in the
equation.
- The state STATE_INVALID_CERT is actually never used in Bebop because - The state STATE_INVALID_CERT is actually never used in Bebop because
of the current tendency to ignore any certificate fields and only of the current tendency to ignore any certificate fields and only
check the whole cert fingerprint. Here it is considered the same as a check the whole cert fingerprint. Here it is considered the same as a