fakesshagent.git

@@ -0,0 +1,7 @@

+html/

+.mypy_cache/

+.pytest_cache/

+__pycache__/

+*.swp

+.coverage*

+.hypothesis/

@@ -0,0 +1,4 @@

+[submodule "docs/wishlist"]

+	path = docs/wishlist

+	url = ./

+	branch = wishlist

@@ -0,0 +1 @@

+(See docs/ directory.)

@@ -0,0 +1,13 @@

+zlib License

+

+Copyright 2026 Marco Ricci <software@the13thletter.info>

+

+This software is provided 'as-is', without any express or implied warranty. In no event will the authors be held liable for any damages arising from the use of this software.

+

+Permission is granted to anyone to use this software for any purpose, including commercial applications, and to alter it and redistribute it freely, subject to the following restrictions:

+

+ 1. The origin of this software must not be misrepresented; you must not claim that you wrote the original software. If you use this software in a product, an acknowledgment in the product documentation would be appreciated but is not required.

+

+ 2. Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software.

+

+ 3. This notice may not be removed or altered from any source distribution.

@@ -0,0 +1,35 @@

+# fakesshagent

+

+[![PyPI - Version](https://img.shields.io/pypi/v/fakesshagent.svg)](https://pypi.org/project/fakesshagent)

+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/fakesshagent.svg)](https://pypi.org/project/fakesshagent)

+

+A non-hardened implementation of the SSH agent protocol, for use in testing.

+

+`fakesshagent` was originally written to test [`derivepassphrase`][DERIVEPASSPHRASE]'s SSH agent interactions.

+As such, `fakesshagent` also registers as an abstract SSH agent socket provider for [`derivepassphrase`][DERIVEPASSPHRASE].

+(The implementation is based on memory buffers, not external I/O with sockets.)

+

+In this first release, `fakesshagent` provides exactly the operations needed for use with `derivepassphrase`:

+listing available keys, and deterministically signing a fixed message (if possible with this key type), for a set of known test keys.

+See the wishlist for planned features of subsequent releases.

+

+[DERIVEPASSPHRASE]: https://the13thletter.info/derivepassphrase/

+

+-----

+

+## Installation

+

+`fakesshagent` is a pure Python package, and may be easily installed with any `pip`-compatible Python package manager such as `pip`, `pipx`, or `uv`.

+

+```console

+pip install fakesshagent

+```

+

+`fakesshagent` requires Python 3.9 or higher as well as the [typing-extensions package][TYPING_EXTENSIONS] and the [`derivepassphrase-sshagentsocketprovider` package][SASP] for its core functionality and programmatic interface.

+

+[TYPING_EXTENSIONS]: https://pypi.org/project/typing-extensions/

+[SASP]: https://pypi.org/project/derivepassphrase-sshagentsocketprovider/

+

+## License

+

+`fakesshagent` is distributed under the terms of the [zlib/libpng](https://spdx.org/licenses/Zlib.html) license.

@@ -0,0 +1,12 @@

+{% extends "base.html" %}

+{% block analytics %}{% endblock %}

+{% block config %}{% endblock %}

+{% block libs %}{% endblock %}

+{% block scripts %}{% endblock %}

+{% block fonts %}

+  {% if config.theme.font != false %}

+    {% set text = config.theme.font.get("text", "Roboto") %}

+    {% set code = config.theme.font.get("code", "Roboto Mono") %}

+        <style>:root{--md-text-font:"{{ text }}";--md-code-font:"{{ code }}"}</style>

+  {% endif %}

+{% endblock %}

@@ -0,0 +1,28 @@

+{#-

+  This file is based on an automatically generated file from MkDocs-Material.

+

+  Changes:

+

+    - Some entries below the path docs/wishlist/... are actually from

+    a submodule pointing to this same repository, but at the "wishlist"

+    branch.

+-#}

+{% if page.edit_url %}

+  {% if "content.action.edit" in features %}

+    <a href="{{ page.edit_url | replace('master/docs/wishlist/', 'wishlist/') }}" title="{{ lang.t('action.edit') }}" class="md-content__button md-icon">

+      {% set icon = config.theme.icon.edit or "material/file-edit-outline" %}

+      {% include ".icons/" ~ icon ~ ".svg" %}

+    </a>

+  {% endif %}

+  {% if "content.action.view" in features %}

+    {% if "/blob/" in page.edit_url %}

+      {% set part = "blob" %}

+    {% else %}

+      {% set part = "edit" %}

+    {% endif %}

+    <a href="{{ page.edit_url | replace(part, 'raw') | replace('master/docs/wishlist/', 'wishlist/') }}" title="{{ lang.t('action.view') }}" class="md-content__button md-icon">

+      {% set icon = config.theme.icon.view or "material/file-eye-outline" %}

+      {% include ".icons/" ~ icon ~ ".svg" %}

+    </a>

+  {% endif %}

+{% endif %}

@@ -0,0 +1,20 @@

+{#-

+  This file was automatically generated - do not edit

+-#}

+<div class="md-copyright">

+  {% if config.copyright %}

+    <div class="md-copyright__highlight">

+      {{ config.copyright }}

+    </div>

+  {% endif %}

+  {% if not config.extra.generator == false %}

+    Made with

+    <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">

+      Material for MkDocs

+    </a>

+    and

+    <a href="https://mkdocstrings.github.io/python/" target="_blank" rel="noopener">

+        mkdocstrings-python

+    </a>

+  {% endif %}

+</div>

@@ -0,0 +1,15 @@

+{#-

+  This file was automatically generated - do not edit

+-#}

+<!doctype html>

+<html>

+  <head>

+    <meta charset="utf-8">

+    <meta name="viewport" content="width=device-width,initial-scale=1">

+    <title>{{ config.site_name }}</title>

+    <meta http-equiv="refresh" content="0;url={{ page.meta.location }}">

+  </head>

+  <body>

+    <div><a href="{{ page.meta.location | url }}">The document has moved.</a></div>

+  </body>

+</html>

@@ -0,0 +1,2 @@

+<!-- Originally downloaded from https://img.shields.io/badge/Keep-a-changelog-E05735?logoColor=fff&logo=keepachangelog&logoSize=auto on 2024-07-21. Used under CC0, as per https://github.com/badges/shields/blob/1e4c8f54d7743381e723a1ca3f79db7868c2f95e/LICENSE . -->

+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="127.21161107182145" height="20" role="img" aria-label="Keep a changelog"><title>Keep a changelog</title><linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="r"><rect width="127.21161107182145" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#r)"><rect width="0" height="20" fill="#555"/><rect x="0" width="127.21161107182145" height="20" fill="#e05735"/><rect width="127.21161107182145" height="20" fill="url(#s)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><image x="5" y="3" width="14.21161107182145" height="14" xlink:href="data:image/svg+xml;base64,PHN2ZyBmaWxsPSIjZmZmIiByb2xlPSJpbWciIHZpZXdCb3g9IjAgMCAyNCAyMy42NDI3NjMyMTAwOTQ4NjYiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyI+PHRpdGxlPktlZXAgYSBDaGFuZ2Vsb2c8L3RpdGxlPjxwYXRoIGQ9Ik05LjgwMzEgMC4wMDAzQzkuMTA4MSAtMC4wMDQ3IDguNDEzMSAwLjA2MTMgNy43MjAxIDAuMjAxM0M1LjYzOTEgMC42MTgzIDMuOTc0MSAxLjY0OTMgMi43NzAxIDMuMjY2M0MxLjIzMjEgNS4zMzYzIDAuMzY3MSA3Ljg5MzMgMC4wNDkxIDExLjMxMzNDLTAuMDc1OSAxMi42NjYzIDAuMDU3MSAxNC4wMjQzIDAuMjMwMSAxNS41MjkzQzAuNDI4MyAxNy40MzczIDEuMTcyNyAxOS4yNDc3IDIuMzc0MSAyMC43NDMzQzMuMzA3MSAyMS45MDAzIDQuMzc4MSAyMi42NjAzIDUuNjQ2MSAyMy4wNjczQzYuNzI1MyAyMy40MTU2IDcuODQ4NiAyMy42MDg5IDguOTgyMSAyMy42NDEzQzkuMjQ3NiAyMy42NDcxIDkuNTEzMSAyMy42MzU4IDkuNzc3MSAyMy42MDczTDEwLjE5MzEgMjMuNTY2M0MxMC43Njc0IDIzLjUwOTYgMTEuMzQxMSAyMy40NDc2IDExLjkxNDEgMjMuMzgwM0MxNC40OTUgMjMuMDgyNyAxNy4wMDAxIDIyLjMxNzkgMTkuMzA3MSAyMS4xMjMzQzIxLjMxNDEgMjAuMDc1MyAyMi43MTcxIDE4LjUyOTMgMjMuNDc3MSAxNi41MjYzQzIzLjgzMTEgMTUuNTk2MyAyNC4wMDAxIDE0LjgxMzMgMjQuMDAwMSAxNC4wODEzQzI0IDEzLjgyNTkgMjMuOTc4NiAxMy41NzEgMjMuOTM2MSAxMy4zMTkzQzIzLjUzMTEgMTAuOTQwMyAyMi43MDExIDguODkxMyAyMS4zODExIDcuMDU1M0MxOS43NDcxIDQuNzc5MyAxOC4wOTMxIDMuMTc3MyAxNi4xNzkxIDIuMDEwM0MxMy45OTMxIDAuNjgxMyAxMS44OTAxIDAuMDE0MyA5LjgwMzEgMC4wMDEzWk05LjM2NDEgMS4wNjQzQzEwLjEzNDEgMS4wNDMzIDEwLjkyNDEgMS4xMjIzIDExLjc0MDEgMS4zMDEzSDExLjczOTFDMTQuNDY5MSAxLjg5ODMgMTYuODc2MSAzLjMwMzMgMTguODkzMSA1LjQ3NDNDMjEuMTgxMSA3LjkzNDMgMjIuNDg0MSAxMC41MTkzIDIyLjg4MTEgMTMuMzczM0MyMi45NTIxIDEzLjkwMTMgMjIuODY4MSAxNC40ODczIDIyLjc4NTEgMTQuOTk1M0MyMi4zOTcxIDE3LjMyMjMgMjEuMTIyMSAxOS4wNTgzIDE4Ljk5OTEgMjAuMTU1M0MxNi43NjA1IDIxLjMwNjIgMTQuMzMzMyAyMi4wNDUzIDExLjgzMzEgMjIuMzM3M0MxMS4yNzUxIDIyLjQwMzMgMTAuNzEzMSAyMi40NjAzIDEwLjA3NjEgMjIuNTI0M0w5Ljk4ODEgMjIuNTM0M0M5LjQzNjMgMjIuNTkxNSA4Ljg3OTUgMjIuNTgxNSA4LjMzMDEgMjIuNTA0M0M3LjY0MDEgMjIuNDA2MyA2Ljg1ODEgMjIuMjk0MyA2LjEwNjEgMjIuMTE1M0M0LjMzOTEgMjEuNjk1MyAzLjAzNzEgMjAuNDkzMyAyLjEyODEgMTguNDU3M0MxLjQ0NDEgMTYuOTE5MyAxLjA5MDEgMTUuMjEyMyAxLjA0NzEgMTMuMjI0M0MwLjk4NjUgMTAuOTA1MiAxLjM3NjcgOC41OTY1IDIuMTk2MSA2LjQyNjNDMi44MTYxIDQuNzg1MyAzLjcxMzEgMi45NzMzIDUuNjU4MSAyLjAwODNDNi44MDg3IDEuNDI0MSA4LjA3NDMgMS4xMDE3IDkuMzY0MSAxLjA2NDNaTTEwLjQ3MjEgMi41MzQzQzkuNzA5MyAyLjU1OTggOC45NTQ1IDIuNjk4IDguMjMyMSAyLjk0NDNDNi42MzIxIDMuNDY5MyA1LjUxNDEgNC4yNDgzIDQuNzA5MSA1LjM4MjNDMy4yMTAxIDcuNTAwMyAyLjQzNDEgOS45NjIzIDIuMzk5MSAxMi43MDczQzIuMzM3MiAxNC4yMTE0IDIuNjExNSAxNS43MTA1IDMuMjAyMSAxNy4wOTUzQzQuMjgzMSAxOS42NjQzIDYuMjU1MSAyMS4xNTkzIDguOTA5MSAyMS40MjEzQzExLjcwNTEgMjEuNjkxMyAxNC40NTIxIDIxLjA0MDMgMTcuMDg3MSAxOS40ODQzQzE4LjIwNjUgMTguODQyMiAxOS4xNTY3IDE3Ljk0MjcgMTkuODU5MSAxNi44NjAzQzIwLjYxMzIgMTUuNzEzNCAyMS4wMTg4IDE0LjM3MjcgMjEuMDI3MSAxMy4wMDAzQzIxLjAyNzEgMTAuODM4MyAyMC4wMTIxIDguNTMwMyAxNy45NzgxIDYuMTM4M0MxNy43NjIyIDUuODg0NiAxNy41MjY4IDUuNjQ4MyAxNy4yNzQxIDUuNDMxM0MxNC45NDExIDMuNDI1MyAxMi43MDcxIDIuNDY1MyAxMC40NzIxIDIuNTMzM1pNMTAuNTcxMSAzLjU2OTNDMTIuMDYzMSAzLjU0NzMgMTMuNTg2MSA0LjA0NDMgMTUuMjQzMSA1LjA3NzNDMTcuMDI2MSA2LjE5NDMgMTguNDA0MSA3Ljg0MDMgMTkuMzM0MSA5Ljk4NjNDMjAuMjIxMSAxMi4wMDYzIDIwLjIzOTEgMTMuOTI0MyAxOS4zOTIxIDE1LjY4MjNDMTguNzU5NCAxNi45NTc3IDE3Ljc0MjcgMTguMDAyNyAxNi40ODUxIDE4LjY3MDNDMTQuMjMyMSAxOS45MDIzIDEyLjE3MDEgMjAuNDQ2MyAxMC4wMjcxIDIwLjM4MzNIMTAuMDA1MUM4LjQ1NTEgMjAuNDQzMyA3LjExNTEgMjAuMDYzMyA1LjkwNzEgMTkuMjIwM0M1LjIwNzEgMTguNzMyMyA0LjY2NjEgMTguMDE4MyA0LjI1MjEgMTcuMDM3M0MzLjY3NzYgMTUuNjg1OSAzLjM4MTEgMTQuMjMyNyAzLjM4MDEgMTIuNzY0M0MzLjM5NzkgMTEuMDk0OSAzLjc0NTkgOS40NDU1IDQuNDA0MSA3LjkxMTNDNC42NTQgNy4zNDkzIDQuOTQ2MiA2LjgwNyA1LjI3ODEgNi4yODkzTDUuNDQxMSA2LjAxOTNDNi4xMTExIDQuOTExMyA3LjE2NjEgNC4zODAzIDguNTQ0MSAzLjkyMDNDOS4xOTggMy43MDA4IDkuODgxNiAzLjU4MjggMTAuNTcxMSAzLjU3MDNaTTEwLjYwMTEgNS4xODkzQzkuNDIxMSA1LjIyNjMgOC4zMjExIDUuNjU0MyA3LjMxMjEgNi40NzIzQzUuOTE3MSA3LjYwMjMgNS4wODIxIDkuMTkyMyA0LjY4MjEgMTEuNDY1M0M0LjM5MjcgMTMuMDM1NCA0LjYzMDQgMTQuNjU3MiA1LjM1ODEgMTYuMDc4M0M2LjQyMDEgMTguMTMyMyA4LjE1ODEgMTkuMTg4MyAxMC4zODQxIDE5LjEyODNIMTAuMzkyMUMxMy4zNTAxIDE4Ljk3MzMgMTUuNTAyMSAxNy44NzkzIDE2Ljk2NTEgMTUuNzgxM0MxNy42NDczIDE0LjgzNjEgMTguMDE3OCAxMy43MDE4IDE4LjAyNTEgMTIuNTM2M0MxOC4wMjMxIDExLjk4MTIgMTcuOTQxNiAxMS40MjkyIDE3Ljc4MzEgMTAuODk3M0MxNy4wNjMxIDguNDYyMyAxNS42MjIxIDYuNzUyMyAxMy40OTMxIDUuODEyM0MxMi40ODQxIDUuMzY3MyAxMS41MTkxIDUuMTYwMyAxMC42MDExIDUuMTg4M1pNMTAuOTEzMSA2LjI1MzNDMTEuNjgzMSA2LjI2MTMgMTIuNDYwMSA2LjQ0NDMgMTMuMjYzMSA2LjgwMzNDMTUuMTI1MSA3LjYzNjMgMTYuMzM2MSA5LjEzNTMgMTYuODYxMSAxMS4yNjUzQzE3LjM4NzEgMTMuMzk1MyAxNi41OTExIDE1LjQ3MDMgMTQuNzk1MSAxNi42ODgzQzEzLjMxNjEgMTcuNjg3MyAxMS44NjUxIDE4LjEzNTMgMTAuMzU3MSAxOC4wNTUzSDEwLjMxNzFDOS4zMTMxIDE4LjEzNTMgOC4zMjMxIDE3LjgyOTMgNy4zNzQxIDE3LjE0NTNDNi43ODIgMTYuNzEzNyA2LjMzMjcgMTYuMTE0NiA2LjA4NDEgMTUuNDI1M0M1Ljc0NzggMTQuNTU1MyA1LjU3MzYgMTMuNjMxIDUuNTcwMSAxMi42OTgzQzUuNTgzOSAxMS41MzIyIDUuODM4MiAxMC4zODE1IDYuMzE3MSA5LjMxODNDNi45OTMxIDcuNzYyMyA4LjA0MTEgNi44MTUzIDkuNTMyMSA2LjQyNTNDOS45OTIxIDYuMzA1MyAxMC40NTExIDYuMjQ3MyAxMC45MTIxIDYuMjUzM1pNOS40NTUxIDguNTc5M1YxNS40NjEzSDEwLjYxMDFWMTMuNTUzM0wxMi4yOTAxIDE1LjQ2MTNIMTMuNzUyMUwxMS40NzkxIDEyLjk2MTNMMTMuMzUwMSAxMS4wMDMzSDExLjg0MTFMMTAuNjEwMSAxMi4zNDAzVjguNTc5M1oiLz48L3N2Zz4="/><text aria-hidden="true" x="727.1161107182145" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="990">Keep a changelog</text><text x="727.1161107182145" y="140" transform="scale(.1)" fill="#fff" textLength="990">Keep a changelog</text></g></svg>

@@ -0,0 +1,2 @@

+<!-- Originally downloaded from https://img.shields.io/badge/SemVer-3F4551?logoColor=fff&logo=semver&logoSize=auto on 2024-07-21. Used under CC0, as per https://github.com/badges/shields/blob/1e4c8f54d7743381e723a1ca3f79db7868c2f95e/LICENSE . -->

+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="71.00018479842694" height="20" role="img" aria-label="SemVer"><title>SemVer</title><linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="r"><rect width="71.00018479842694" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#r)"><rect width="0" height="20" fill="#555"/><rect x="0" width="71.00018479842694" height="20" fill="#3f4551"/><rect width="71.00018479842694" height="20" fill="url(#s)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><image x="5" y="3" width="14.00018479842695" height="14" xlink:href="data:image/svg+xml;base64,PHN2ZyBmaWxsPSJ3aGl0ZXNtb2tlIiByb2xlPSJpbWciIHZpZXdCb3g9IjAgMCAyNCAyNC4wMDAzNzU5MjkyNjAxNTUiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyI+PHRpdGxlPlNlbVZlcjwvdGl0bGU+PHBhdGggZD0iTTAuMzU3IDkuMDI0NkMtMC41OTQzIDEyLjg0ODcgMC4zODExIDE2Ljg5NjUgMi45NyAxOS44Njc2QzUuNTU4IDIyLjgzNjkgOS40MzM5IDI0LjM1NCAxMy4zNSAyMy45MzA2QzIxLjExOCAyMy4yMjc2IDI2LjQzNiAxNC4xMzE2IDIyLjg2NyA3LjEzMDZDMjIuNDUxIDUuOTQwNiAyMC43OTcgNi43NjI2IDIwLjk2NCA3LjcyNjZDMjEuMjUxIDguNDI2NiAyMS40OSA5LjE0NzYgMjEuNjc3IDkuODgxNkMyMi41MzI1IDEzLjc3NTcgMjAuOTg5IDE3LjgwNTQgMTcuNzUxIDIwLjEzMTZDMTIuNzA2NiAyMy43NTI1IDUuNjE0OSAyMS45MjgyIDIuOTQ0IDE2LjMyMjZDMS4yMjY3IDEyLjcyNDMgMS44MTQ4IDguNDQ5NCA0LjQ0IDUuNDQ4NkM1LjcyNDEgMy45ODE0IDcuNDEwNCAyLjkyMyA5LjI5IDIuNDA0NkMxMS42Mjc4IDEuNzQzNSAxNC4xMjc0IDEuOTY4MiAxNi4zMSAzLjAzNTZDMTYuNDY2OCAzLjExNTIgMTYuNTM0NyAzLjMwMzEgMTYuNDY1IDMuNDY0NkwxMi41MDMgMTQuMDg0NkMxMi4zOTYgMTQuODk0NiAxMS44MTMgMTQuODcwNiAxMS43MDYgMTQuMDg0Nkw5LjMyNiA2LjcxNDZDOS4yMTY1IDYuMjkyMiA4LjkzNjYgNS45MzQ0IDguNTUzIDUuNzI2NkM3LjM2MyA1LjE2NjYgNS40NiA2LjM5MzYgNi4xNzQgNy44ODE2TDEwLjA4OCAxOC4zMjI2QzEwLjYxMiAxOS43MTU2IDExLjExMSAyMC4xNTY2IDEyLjE0NiAyMC4xNTY2UzEzLjY4MSAxOS43MTY2IDE0LjIwNCAxOC4zMjI2TDIwIDMuOTQwNkMyMC4xNTU5IDMuNTA2IDIwLjAwNTQgMy4wMjA3IDE5LjYzMSAyLjc1MDZDMTMuMSAtMi45MDY0IDIuMzIgMC42NDE2IDAuMzU3IDkuMDIzNloiLz48L3N2Zz4="/><text aria-hidden="true" x="445.0018479842695" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="430">SemVer</text><text x="445.0018479842695" y="140" transform="scale(.1)" fill="#fff" textLength="430">SemVer</text></g></svg>

@@ -0,0 +1,53 @@

+# Changelog for `fakesshagent`

+

+[![Keeping a changelog][CHANGELOG_BADGE]][KEEP_A_CHANGELOG]

+[![Using Semantic Versioning][SEMVER_BADGE]][SEMANTIC_VERSIONING]

+

+  [CHANGELOG_BADGE]: Keep_a_changelog-E05735.svg

+  [SEMVER_BADGE]: SemVer-3F4551.svg

+  [KEEP_A_CHANGELOG]: https://keepachangelog.com/en/1.1.0/ 'Keeping a changelog'

+  [SEMANTIC_VERSIONING]: https://semver.org/ 'Using Semantic Versioning'

+

+??? info "Definition: the <q>public API</q> of `fakesshagent`"

+

+    The <dfn>public API</dfn>, as defined by Semantic Versioning, is

+    outlined in the Reference section: the set of documented

+    modules, classes, attributes, methods, functions and function

+    parameters, and the documented behavior, options and arguments of the

+    command-line tools.

+

+    Certain **exceptions to this rule** are explicitly and prominently

+    marked as implementation details/not part of the public API.

+

+??? info "Interpretation of the version number"

+

+    The terminology <b>major</b>, <b>minor</b> and <b>patch</b> follows the

+    Semantic Versioning and Keep a Changelog definitions.

+

+      * For version numbers with major version zero, *any* new release may

+        effectively constitute a new <b>major</b> release.

+      * For version numbers with major version one or higher,

+          * <b>Fixed</b> entries justify a <b>patch</b> release;

+          * <b>Added</b> and <b>Deprecated</b> entries justify

+            a <b>minor</b> release;

+          * <b>Changed</b> and <b>Removed</b> entries justify a <b>major</b>

+            release.

+          * <b>Security</b> can justify any type of release; if <b>major</b>

+            or <b>minor</b>, these are accompanied by corresponding entries

+            of the respective types above.

+

+!!! abstract inline end "Legend: symbols"

+

+    <ul style="list-style-type: none;">

+    <li>:material-bug: --- a related bug entry from the wishlist page

+    <li>:material-file-document-plus-outline: --- a related wishlist entry from the wishlist page

+    </ul>

+

+<aside markdown><small>

+(All entries are from the perspective of a user of the program or the API.

+As an exception, entries partaining to developers of `fakesshagent` are

+specifically marked as such.)

+</small></aside>

+

+<!-- scriv changelog start -->

+

@@ -0,0 +1,26 @@

+# How to comply with the "altered versions" clause of the license

+

+!!! abstract inline end "Local version identifiers reserved by upstream `fakesshagent`"

+

+    *   `jvm` -- Indicates a build of `fakesshagent` running on the Java Virtual Machine.

+

+**Short answer:** change the package name and/or include a [PEP 440][] "local version identifier" in the version number.

+If `fakesshagent` ever rebrands, this applies to rebranded names too.

+We try not to clash with anyone else, and will yank our offending releases if we do.

+

+**Long answer:** We, upstream `fakesshagent`, reserve the name `fakesshagent` and certain version numbers for ourselves.

+Specifically, our version numbers adhere to [PEP 440][] (or newer revisions) and generally do not include a "local version identifier" (except for the reserved ones mentioned in the info box).

+To mark an altered version, we thus recommend that you change the software package name `fakesshagent`, or use a version number with a different local version identifier.

+If we (upstream) decide to use a new local version identifier, we will avoid all clashing local version identifiers we are aware of, and if informed of a clashing local version identifier after our release, will yank our offending version(s).

+

+Should we (upstream) change the package name, we shall apply the same guidelines and checks concerning local version identifiers to the new package name.

+A change of package name does *not* by itself imply permission to use the old package name for future releases of altered versions without marking them.

+

+---

+

+See also [the zlib project's take on how to mark altered versions (question #24)][ZLIB_FAQ].

+Like them, we recommend keeping our upstream Changelog (up to the point where you introduced modifications) and describing your modifications both there and in the README, in the appropriate level of detail.

+We also request (but do not require) that you provide clear instructions in the README (and potentially other suitable places) on where and how to report problems that stem from your modifications, not from the upstream software package.

+

+[PEP 440]: https://peps.python.org/pep-0440/

+[ZLIB_FAQ]: https://github.com/madler/zlib/blob/v1.3.1/FAQ

@@ -0,0 +1,8 @@

+---

+title: Explanation overview

+---

+

+* [How to comply with the "altered versions" clause of the

+  license][FAQ_ALTERED_VERSIONS]

+

+[FAQ_ALTERED_VERSIONS]: faq-altered-versions.md

@@ -0,0 +1 @@

+--8<-- "README.md"

@@ -0,0 +1,35 @@

+/* Indentation. */

+div.doc-contents:not(.first) {

+  padding-left: 25px;

+  border-left: .05rem solid var(--md-typeset-table-color);

+}

+

+/* Mark external links as such. */

+div[data-md-component="content"] a:not(.md-icon):is([href^="https://"], [href^="http://"], [href^="//"])::after,

+a.external::after,

+a.autorefs-external::after {

+  /* https://primer.style/octicons/arrow-up-right-24 */

+  mask-image: url('data:image/svg+xml,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18.25 15.5a.75.75 0 00.75-.75v-9a.75.75 0 00-.75-.75h-9a.75.75 0 000 1.5h7.19L6.22 16.72a.75.75 0 101.06 1.06L17.5 7.56v7.19c0 .414.336.75.75.75z"></path></svg>');

+  -webkit-mask-image: url('data:image/svg+xml,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18.25 15.5a.75.75 0 00.75-.75v-9a.75.75 0 00-.75-.75h-9a.75.75 0 000 1.5h7.19L6.22 16.72a.75.75 0 101.06 1.06L17.5 7.56v7.19c0 .414.336.75.75.75z"></path></svg>');

+  content: ' ';

+

+  display: inline-block;

+  vertical-align: middle;

+  position: relative;

+

+  height: 1em;

+  width: 1em;

+  background-color: currentColor;

+}

+

+/* ... but don't mark badges as external */

+div[data-md-component="content"] a:not(.md-icon):is([href^="https://"], [href^="http://"], [href^="//"]):has(img[src^="https://img.shields.io/"], img[src="Keep_a_changelog-E05735.svg"], img[src="../Keep_a_changelog-E05735.svg"], img[src="SemVer-3F4551.svg"], img[src="../SemVer-3F4551.svg"])::after {

+    content: '';

+    width: 0em;

+    height: 0em;

+}

+

+a.external:hover::after,

+a.autorefs-external:hover::after {

+  background-color: var(--md-accent-fg-color);

+}

@@ -0,0 +1,87 @@

+# Compatibility of `fakesshagent` with different Python versions

+

+## Python 3.15  {#py3.15}

+

+Currently supported without any known issues.

+

+## Python 3.14  {#py3.14}

+

+Currently supported without any known issues.

+

+### After end-of-life {#after-eol-py3.14}

+

+After Python 3.14 reaches end-of-life, future `fakesshagent` versions may make use of the following Python functionality:

+

+  * lazy imports

+  * the `frozendict` type

+

+The declared minimum required Python version will then be updated accordingly.

+

+## Python 3.13  {#py3.13}

+

+Currently supported without any known issues.

+

+### After end-of-life {#after-eol-py3.13}

+

+After Python 3.13 reaches end-of-life, future `fakesshagent` versions may make use of the following Python functionality:

+

+  * template strings

+

+The declared minimum required Python version will then be updated accordingly.

+

+## Python 3.12  {#py3.12}

+

+Currently supported without any known issues.

+

+### After end-of-life {#after-eol-py3.12}

+

+Python 3.13 does not offer significantly different functionality than Python 3.12.

+There are thus no plans to make use of additional functionality once Python 3.12 reaches end-of-life.

+

+## Python 3.11  {#py3.11}

+

+Currently supported without any known issues.

+

+### After end-of-life {#after-eol-py3.11}

+

+After Python 3.11 reaches end-of-life, future `fakesshagent` versions may make use of the following Python functionality:

+

+  * complex expressions in f-strings

+  * type parameter syntax and the `type` statement

+

+The declared minimum required Python version will then be updated accordingly.

+

+## Python 3.10  {#py3.10}

+

+Currently supported without any known issues.

+

+### After end-of-life {#after-eol-py3.10}

+

+After Python 3.10 reaches end-of-life, future `fakesshagent` versions may make use of the following Python functionality:

+

+  * exception groups

+  * exception notes

+  * [`contextlib.chdir`][]

+

+The declared minimum required Python version will be then updated accordingly.

+

+## Python 3.9  {#py3.9}

+

+End-of-life since October 2025, but still supported at least until `fakesshagent` v1.0, without any known issues.

+

+### After end-of-life {#after-eol-py3.9}

+

+After Python 3.9 reaches end-of-life, future `fakesshagent` versions may make use of the following Python functionality:

+

+  * structural pattern matching (`match`/`case` blocks)

+  * parenthesized `with` statements

+

+The declared minimum required Python version will be then updated accordingly.

+

+## Python 3.8 and below  {#py3.8-and-below}

+

+These versions were never explicitly supported, neither in CPython nor in PyPy.

+

+## PyPy

+

+As per the respective CPython version above.

@@ -0,0 +1,4 @@

+# Upgrade notes for `fakesshagent`

+

+(Nothing yet.

+Once there is something, this will be listed here, oldest version first.)

@@ -0,0 +1 @@

+Subproject commit 892cce5eece34e7f06e98348540f8491d94d69fe

@@ -0,0 +1,94 @@

+p:has(+ table#bug-summary) {

+    margin: 0em;

+}

+table#bug-summary {

+    width: 100%;

+    border: none;

+}

+table#bug-summary + p {

+    margin: 0em;

+}

+table#bug-summary th, table#bug-summary td {

+    padding: 0.25em;

+    border: none;

+}

+table#bug-summary td:first-of-type {

+    padding-right: 1.5em;

+}

+table#bug-summary td:first-of-type > a:has(+ a) {

+    margin-right: 0.5em;

+}

+

+a.scheduled-next {

+    font-weight: bold;

+}

+

+a.scheduled {

+    font-style: oblique;

+}

+

+a.unscheduled {

+    opacity: 0.75;

+}

+a.fixed {

+    font-weight: normal;

+    font-style: normal;

+    text-decoration: line-through;

+}

+

+.md-typeset div.admonition.abstract .emojione,

+.md-typeset div.admonition.abstract .gemoji,

+.md-typeset div.admonition.abstract .twemoji,

+.md-typeset a[href^="../wishlist/"] .emojione,

+.md-typeset a[href^="../wishlist/"] .gemoji,

+.md-typeset a[href^="../wishlist/"] .twemoji,

+.md-typeset a[href^="wishlist/"] .emojione,

+.md-typeset a[href^="wishlist/"] .gemoji,

+.md-typeset a[href^="wishlist/"] .twemoji {

+    vertical-align: middle;

+}

+

+:root {

+    --md-admonition-icon--bug: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M14 12h-4v-2h4m0 6h-4v-2h4m6-6h-2.81a6 6 0 0 0-1.82-1.96L17 4.41 15.59 3l-2.17 2.17a6 6 0 0 0-2.83 0L8.41 3 7 4.41l1.62 1.63C7.88 6.55 7.26 7.22 6.81 8H4v2h2.09c-.05.33-.09.66-.09 1v1H4v2h2v1c0 .34.04.67.09 1H4v2h2.81c1.04 1.79 2.97 3 5.19 3s4.15-1.21 5.19-3H20v-2h-2.09c.05-.33.09-.66.09-1v-1h2v-2h-2v-1c0-.34-.04-.67-.09-1H20z"/></svg>');

+    --md-admonition-icon--bug-success: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 7h-2.81c-.45-.8-1.07-1.5-1.82-2L16 3.41 14.59 2l-2.17 2.17a6 6 0 0 0-2.83 0L7.41 2 6 3.41 7.62 5c-.75.5-1.36 1.21-1.81 2H3v2h2.09c-.06.33-.09.66-.09 1v1H3v2h2v1c0 .34.03.67.09 1H3v2h2.81A6 6 0 0 0 13 19.65V19c0-2.54 1.61-4.8 4-5.65V13h2v-2h-2v-1c0-.34-.03-.67-.09-1H19zm-6 8H9v-2h4zm0-4H9V9h4zm4.75 11.16-2.75-3L16.16 18l1.59 1.59L21.34 16l1.16 1.41z"/></svg>');

+    --md-admonition-icon--wish: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M23 18h-3v-3h-2v3h-3v2h3v3h2v-3h3M6 2a2 2 0 0 0-2 2v16c0 1.11.89 2 2 2h7.81c-.36-.62-.61-1.3-.73-2H6V4h7v5h5v4.08c.33-.05.67-.08 1-.08.34 0 .67.03 1 .08V8l-6-6M8 12v2h8v-2m-8 4v2h5v-2Z"/></svg>');

+    --md-admonition-icon--wish-success: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m23.5 17-5 5-3.5-3.5 1.5-1.5 2 2 3.5-3.5zM6 2a2 2 0 0 0-2 2v16c0 1.11.89 2 2 2h7.81c-.36-.62-.61-1.3-.73-2H6V4h7v5h5v4.08c.33-.05.67-.08 1-.08.34 0 .67.03 1 .08V8l-6-6M8 12v2h8v-2m-8 4v2h5v-2Z"/></svg>');

+}

+.md-typeset .admonition.wish,

+.md-typeset details.wish {

+    border-color: #888888;

+}

+.md-typeset .wish > .admonition-title,

+.md-typeset .wish > summary {

+    background-color: #8888881a;

+}

+.md-typeset .wish > .admonition-title::before,

+.md-typeset .wish > summary::before {

+    background-color: #888888;

+    -webkit-mask-image: var(--md-admonition-icon--wish);

+            mask-image: var(--md-admonition-icon--wish);

+}

+.md-typeset .admonition.bug-success,

+.md-typeset details.bug-success,

+.md-typeset .admonition.wish-success,

+.md-typeset details.wish-success {

+    border-color: #00c853;

+}

+.md-typeset .bug-success > .admonition-title,

+.md-typeset .bug-success > summary,

+.md-typeset .wish-success > .admonition-title,

+.md-typeset .wish-success > summary {

+    background-color: #00c8531a;

+}

+.md-typeset .bug-success > .admonition-title::before,

+.md-typeset .bug-success > summary::before {

+    background-color: #00c853;

+    -webkit-mask-image: var(--md-admonition-icon--bug-success);

+            mask-image: var(--md-admonition-icon--bug-success);

+}

+.md-typeset .wish-success > .admonition-title::before,

+.md-typeset .wish-success > summary::before {

+    background-color: #00c853;

+    -webkit-mask-image: var(--md-admonition-icon--wish-success);

+            mask-image: var(--md-admonition-icon--wish-success);

+}

@@ -0,0 +1,148 @@

+site_name: fakesshagent

+site_url: 'https://the13thletter.info/fakesshagent/'

+repo_url: 'https://git.schokokeks.org/fakesshagent.git'

+edit_uri: 'raw/master/docs/'

+repo_name: the-13th-letter/fakesshagent

+site_description: A non-hardened implementation of the SSH agent protocol, for use in testing.

+site_author: Marco Ricci

+copyright: Copyright © 2026 Marco Ricci (the-13th-letter)

+

+remote_branch: documentation-tree

+remote_name: '.'

+

+docs_dir: docs

+site_dir: html

+extra_css:

+  - mkdocstrings_recommended_styles.css

+  - wishlist_styling.css

+

+theme:

+  name: "material"

+  #font: false

+  font:

+    text: Noto Sans

+    code: Noto Mono

+    #code: Inconsolata

+  #palette:

+  #  - media: "(prefers-color-scheme)"

+  #    toggle:

+  #      icon: material/brightness-auto

+  #      name: Switch to light mode

+  #  - media: "(prefers-color-scheme: light)"

+  #    scheme: default

+  #    toggle:

+  #      icon: material/brightness-7

+  #      name: Switch to dark mode

+  #  - media: "(prefers-color-scheme: dark)"

+  #    scheme: slate

+  #    toggle:

+  #      icon: material/brightness-4

+  #      name: Switch to system preference

+  icon:

+    logo: material/library

+    repo: fontawesome/brands/git-alt

+  features:

+    - content.action.view

+    - content.code.annotate

+    - navigation.tracking

+    - navigation.tabs

+    - navigation.sections

+    - navigation.indexes

+    - navigation.footer

+  custom_dir: docs-overrides

+

+plugins:

+  offline:

+    enabled: false  # Use mkdocs_offline.yml for offline versions instead!

+  #privacy:

+  #  enabled: true

+  mkdocstrings:

+    handlers:

+      python:

+        inventories:

+          - 'https://docs.python.org/3/objects.inv'

+          - 'https://typing-extensions.readthedocs.io/en/latest/objects.inv'

+          #- 'https://cryptography.readthedocs.io/en/latest/objects.inv'

+          #- 'https://hypothesis.readthedocs.io/en/latest/objects.inv'

+        options:

+          docstring_options:

+            ignore_init_summary: true

+            returns_multiple_items: false

+          merge_init_into_class: true

+          show_source: false

+          heading_level: 2

+          show_object_full_path: false

+          show_root_members_full_path: false

+          show_root_heading: true

+          show_symbol_type_heading: true

+          show_symbol_type_toc: true

+          members_order: 'source'

+          show_signature_annotations: true

+          separate_signature: true

+          signature_crossrefs: true

+          unwrap_annotated: true

+          scoped_crossrefs: true

+        paths:

+          - src

+          - .

+  mike:

+    alias_type: symlink

+    canonical_version: '0.x'

+    version_selector: false

+

+nav:

+  - Overview: index.md

+  #- Tutorials & Examples:

+  #  - tutorials/index.md

+  #- How-Tos:

+  #  - how-tos/index.md

+  #- Reference:

+  #  - reference/index.md

+  - Design & Background:

+    - explanation/index.md

+    - '"altered versions" license requirement': explanation/faq-altered-versions.md

+  - Changelog:

+    - Changelog: changelog.md

+    - Upgrade notes: upgrade-notes.md

+    - Python compatibility: pycompatibility.md

+  - Wishlist:

+    - wishlist/index.md

+not_in_nav: |

+  wishlist/*.md

+  !wishlist/index.md

+draft_docs: |

+  changelog.d

+  _future.md

+  reference/tests.*

+  _release_checklist.md

+

+markdown_extensions:

+  - abbr

+  - attr_list

+  - def_list

+  - footnotes

+  - md_in_html

+  - admonition

+  - smarty

+  - toc:

+      permalink: true

+  - pymdownx.caret

+  - pymdownx.details

+  - pymdownx.emoji:

+      emoji_index: !!python/name:material.extensions.emoji.twemoji

+      emoji_generator: !!python/name:material.extensions.emoji.to_svg

+  - pymdownx.snippets:

+      base_path:

+        - 'docs'

+        - '.'

+      check_paths: true

+  - pymdownx.superfences

+  - pymdownx.tabbed:

+      alternate_style: true

+

+extra:

+  version:

+    provider: mike

+    default:

+      - latest

+      - stable

@@ -0,0 +1,16 @@

+INHERIT: mkdocs_offline.yml

+

+draft_docs: ''

+not_in_nav: |

+  changelog.d

+  wishlist/*.md

+  !wishlist/index.md

+

+# nav: ...

+

+plugins:

+  mkdocstrings:

+    handlers:

+      python:

+        options:

+          filters: []

@@ -0,0 +1,14 @@

+INHERIT: mkdocs.yml

+

+draft_docs: |

+  _future.md

+  reference/tests.*

+  _release_checklist.md

+not_in_nav: |

+  changelog.d

+  wishlist/*.md

+  !wishlist/index.md

+

+plugins:

+  offline:

+    enabled: true

@@ -0,0 +1,478 @@

+[build-system]

+requires = ["hatchling"]

+build-backend = "hatchling.build"

+

+[project]

+name = "fakesshagent"

+description = "A non-hardened implementation of the SSH agent protocol, for use in testing."

+readme = "README.md"

+version = "0.1a1"

+requires-python = ">= 3.9"

+license = "Zlib"

+keywords = []

+authors = [

+  { name = "Marco Ricci", email = "software@the13thletter.info" },

+]

+classifiers = [

+    "Development Status :: 4 - Beta",

+    "Environment :: Console",

+    "Operating System :: OS Independent",

+    "Programming Language :: Python :: 3",

+    "Programming Language :: Python :: 3.9",

+    "Programming Language :: Python :: 3.10",

+    "Programming Language :: Python :: 3.11",

+    "Programming Language :: Python :: 3.12",

+    "Programming Language :: Python :: 3.13",

+    "Programming Language :: Python :: 3.14",

+    "Programming Language :: Python :: 3.15",

+    "Programming Language :: Python :: Implementation :: CPython",

+    "Programming Language :: Python :: Implementation :: PyPy",

+    "Topic :: Software Development :: Testing",

+    "Typing :: Typed",

+]

+dependencies = [

+    "derivepassphrase-sshagentsocketprovider >= 1.0",

+    "typing_extensions",

+]

+

+[project.optional-dependencies]

+dev = [

+    # dev - developers' setup

+    #

+    # Development uses the hatch build system, to isolate all tools in

+    # their own virtual environment...

+    "hatch >= 1.10",

+    # ...but it is still sensible to have most static analysis tools

+    # available in the main virtual environment as well, so that your

+    # editor/IDE setup can access them as well.

+    "mypy >= 1.0",

+    "ruff >= 0.16.0",

+    # Test dependencies should be installed as well, to have static

+    # analysis in the test suite working too.

+    #

+    # `packaging` is needed because the test suite compares version

+    # numbers.

+    #

+    # `pytest-xdist` is used by `hatch test -p`, but for the `psutil`

+    # extra, the `psutil` package provides no wheels for PyPy.  Users on

+    # The Annoying OS are especially screwed if they lack the admin

+    # priviledges necessary to install the developers' tools.  So skip

+    # the extra, and accept that for PyPy environments, `hatch test -p`

+    # will not be able to distinguish logical and physical CPU core

+    # counts.

+    #

+    # We use `hypothesis.is_hypothesis_test`, which was introduced in

+    # 6.131.0, and `exc_type` for `pytest.importorskip`, which was

+    # introduced in 8.2.0.

+    "coverage[toml] >= 7.4",

+    "coverage-enable-subprocess >= 1.0",

+    "hypothesis >= 6.131.0",

+    "packaging",

+    "pytest >= 8.2",

+    "pytest-randomly >= 3.15",

+    "pytest-xdist >= 3.6.0",

+    'pytest-xdist[psutil] >= 3.6.0; platform_python_implementation != "PyPy"',

+    # `pytest` 8.4 and higher, and `hypothesis` versions 6.130.13

+    # through 6.135.1, use syntax only properly available on Python 3.10

+    # and later: `with (x as y, a as b)`.  However, those versions are

+    # not marked as incompatible with Python 3.9.

+    'pytest < 8.4 ; python_version < "3.10"',

+    'hypothesis != 6.130.13, != 6.131.*, != 6.132.*, != 6.133.*, != 6.134.*, != 6.135.0, != 6.135.1 ; python_version < "3.10"',

+    # `hypothesis` requires a Rust toolchain since version 6.156, and

+    # publishes wheels for PyPy 3.11 only. PyO3 version 0.27 also dropped

+    # support for PyPy 3.9 and 3.10, and cannot be overridden within

+    # pyproject.toml.

+    'hypothesis < 6.156 ; platform_python_implementation == "PyPy" and python_version < "3.11"',

+]

+

+[project.urls]

+Documentation = "https://the13thletter.info/fakesshagent/"

+Issues = "https://the13thletter.info/fakesshagent/latest/wishlist/"

+Source = "https://git.schokokeks.org/fakesshagent.git"

+

+[project.entry-points."derivepassphrase.ssh_agent_socket_providers"]

+stub_agent = "fakesshagent.machinery: STUB_AGENT_ENTRY_POINT"

+stub_agent_with_address = "fakesshagent.machinery: STUB_AGENT_WITH_ADDRESS_ENTRY_POINT"

+stub_agent_with_address_and_deterministic_dsa = "fakesshagent.machinery: STUB_AGENT_WITH_ADDRESS_AND_DETERMINISTIC_DSA_ENTRY_POINT"

+

+[tool.coverage.html]

+directory = "html/coverage"

+

+[tool.coverage.paths]

+src = ["src"]

+tests = ["tests"]

+

+[tool.coverage.report]

+skip_covered = false

+skip_empty = true

+precision = 3

+partial_branches = [

+    'pragma: no branch',

+]

+exclude_also = [

+    "if __name__ == .__main__.:",

+    'if (?:typing\.)?TYPE_CHECKING:',

+    "raise AssertionError",

+    "raise NotImplementedError",

+    'assert False',

+    '(?:typing\.)?assert_never\(',

+    '@overload',

+    'class .*\(Protocol\):',

+    'pytest\.fail\(',

+    '@(?:(?:pytest\.)?mark\.)?xfail\(',

+    'class _Omitted:',

+    'class _DummyModule:',

+]

+

+# We use a bunch of "codes", similar to the "type: ignore" comments, as

+# shorthand notation for why we are excluding a certain piece of code

+# manually from coverage, instead of writing a verbose explanation at each

+# call site:

+#

+# "external-api" and "unused": The code is defined by an external API not

+# under our control, or it implements an external interface, and some of the

+# branches of that code we do not yet use ("unused") or don't ever intend to

+# use ("external-api").  In particular, in production and in testing use, we

+# do not expect to hit these code branches unless there are errors in our

+# code.

+#

+# "external": Whether or not we hit this code branch is non-deterministic,

+# and dependent on external factors that are difficult or impossible for us

+# to control, predict, or simulate.  We therefore categorically exclude all

+# branches from coverage.  (Typically though, one particular branch *will*

+# actually run.  We just don't know ahead of time which one.)  (While this

+# applies to "choice of operating system" and "installed Python/library

+# version" as well, these cases are usually tagged with more specific codes,

+# or explained in long-form commentary.)

+#

+# "failsafe": Akin to assertions, these are used to catch "impossible"

+# situations and to still fail in a controlled manner.  We do not expect to

+# hit these code branches during production or testing.

+#

+# "debug", "internal" and "interactive": These code branches are not

+# intended to be called by the general public ("debug", "internal"), or they

+# are only intended to be called interactively ("interactive").  We do not

+# expect to hit these code branches during production or testing.

+

+[tool.coverage.run]

+source_pkgs = ["fakesshagent", "tests"]

+branch = true

+parallel = true

+omit = [

+  "__main__.py",

+]

+dynamic_context = 'test_function'

+concurrency = ['thread', 'multiprocessing']

+sigterm = true

+relative_files = true

+

+[tool.hatch.build.targets.sdist]

+exclude = [

+    'docs/changelog.d/*.md',

+]

+

+[tool.hatch.env]

+requires = [

+    "hatch-mkdocs",

+]

+

+[tool.hatch.env.collectors.mkdocs.docs]

+path = "mkdocs.yml"

+

+[tool.hatch.envs.docs]

+extra-dependencies = [

+    # Our documentation uses formatted function signatures (i.e. with

+    # formatted type annotations), which requires `black`.

+    "black",

+    # We actually use functionality from MkDocs 1.6, so ensure the

+    # version is at least this high.

+    "mkdocs >= 1.6",

+    # Our changelog is assembled from singular entries, orchestrated by

+    # `scriv`.

+    "scriv >= 1.4",

+]

+detached = false

+

+[tool.hatch.envs.hatch-check-code]

+config-path = "/dev/null"

+dependencies = [

+    # Override the default dependencies, lest the ruff requirements

+    # conflict.

+]

+features = [

+    "dev",

+]

+[tool.hatch.envs.hatch-check-fmt]

+config-path = "/dev/null"

+dependencies = [

+    # Override the default dependencies, lest the ruff requirements

+    # conflict.

+]

+features = [

+    "dev",

+]

+[tool.hatch.envs.hatch-check-types]

+config-path = "/dev/null"

+dependencies = [

+    # Override the default dependencies, lest the ruff requirements

+    # conflict.

+    "pyrefly >= 1.0.0",

+]

+features = [

+    "dev",

+]

+

+[tool.hatch.envs.hatch-test]

+default-args = ['src', 'tests']

+dependencies = [

+    "coverage[toml] >= 7.4",

+    "coverage-enable-subprocess >= 1.0",

+    "hypothesis >= 6.131.0",

+    "packaging",

+    "pytest >= 8.2",

+    "pytest-randomly >= 3.15",

+    "pytest-xdist >= 3.6.0",

+    'pytest-xdist[psutil] >= 3.6.0; platform_python_implementation != "PyPy"',

+    'pytest < 8.4 ; python_version < "3.10"',

+    'hypothesis != 6.130.13, != 6.131.*, != 6.132.*, != 6.133.*, != 6.134.*, != 6.135.0, != 6.135.1 ; python_version < "3.10"',

+    'hypothesis < 6.156 ; platform_python_implementation == "PyPy" and python_version < "3.11"',

+]

+matrix-name-format = '{variable}_{value}'

+

+[[tool.hatch.envs.hatch-test.matrix]]

+python = ["3.15", "3.14", "3.13", "3.12", "3.11", "3.10", "3.9", "pypy3.11", "pypy3.10", "pypy3.9"]

+parser-version = ["PEG"]

+

+[[tool.hatch.envs.hatch-test.matrix]]

+python = ["3.9", "pypy3.9"]

+parser-version = ["LL1"]

+

+[tool.hatch.envs.hatch-test.overrides]

+matrix.parser-version.env-vars = [

+    { key = "PYTHONOLDPARSER", value = "1", if = ["LL1"] },

+]

+

+[tool.hatch.envs.hatch-test.scripts]

+run = "pytest --hypothesis-profile={env:HYPOTHESIS_PROFILE:default}{env:HATCH_TEST_ARGS:} {args}"

+run-cov = "coverage run -m pytest --hypothesis-profile={env:HYPOTHESIS_PROFILE:default}{env:HATCH_TEST_ARGS:} {args}"

+cov-combine = "coverage combine"

+cov-report = "coverage report"

+

+[tool.hatch.envs.types]

+extra-dependencies = [

+  "mypy>=1.0.0",

+]

+[tool.hatch.envs.types.scripts]

+check = "mypy --install-types --non-interactive {args:src/fakesshagent tests}"

+

+[tool.mypy]

+files = ['src/**/*.py', 'tests/**/*.py']

+mypy_path = '$MYPY_CONFIG_FILE_DIR/src:$MYPY_CONFIG_FILE_DIR/other-stubs'

+explicit_package_bases = true

+implicit_reexport = false

+sqlite_cache = true

+enable_error_code = ['ignore-without-code']

+

+[tool.pyrefly]

+project-includes = [

+    "src/**/*.py",

+    "tests/**/*.py",

+]

+search-path = [

+    "src",

+    ".",

+]

+preset = "legacy"

+infer-return-types = "never"

+permissive-ignores = true

+

+[tool.pyrefly.errors]

+unnecessary-type-conversion = "ignore"

+

+[tool.pytest.ini_options]

+addopts = '--doctest-modules --dist=loadgroup --import-mode=importlib'

+pythonpath = [

+    'tests', # needed for re-importing test machinery with multiprocessing (spawn)

+]

+testpaths = [

+    'src', # doctests in API documentation

+    'tests', # other tests

+]

+xfail_strict = true

+

+[tool.ruff]

+line-length = 79

+src = ["src"]

+

+[tool.ruff.format]

+docstring-code-format = true

+docstring-code-line-length = "dynamic"

+preview = true

+quote-style = "double"

+

+[tool.ruff.lint]

+ignore = [

+    # Suggested ignore by ruff when also using ruff to format.  We *do*

+    # check for E501, because this usually only happens when there is

+    # a text string that should be manually broken.  However, for

+    # automated quality control, that specific check is turned off so

+    # that the linting and formatting can proceed, and then *afterwards*

+    # the files are re-linted.  We hope that any *true* E501 errors left

+    # over from this *are* text strings that should be manually broken.

+    'tab-indentation', 'indentation-with-invalid-multiple',

+    'indentation-with-invalid-multiple-comment', 'over-indented',

+    'docstring-tab-indentation', 'triple-single-quotes',

+    'bad-quotes-inline-string', 'bad-quotes-multiline-string',

+    'bad-quotes-docstring', 'avoidable-escaped-quote',

+    'missing-trailing-comma', 'prohibited-trailing-comma',

+    'single-line-implicit-string-concatenation',

+    'multi-line-implicit-string-concatenation',

+    # We use `assert` regularly to appease the type checker, and because

+    # it is the right language tool for this job.

+    'assert',

+    # The formatter takes care of trailing commas and docstring code

+    # automatically.

+    'missing-trailing-comma', 'doc-line-too-long',

+    # We document transitive exceptions as well (if we feel they would

+    # be surprising to the user otherwise).

+    'docstring-extraneous-exception',

+    # We currently don't have issues for every TODO.  Forcing an issue

+    # also goes against the philosophy of TODOs as low-overhead markers

+    # for future work; see

+    # https://gist.github.com/dmnd/ed5d8ef8de2e4cfea174bd5dafcda382 .

+    'missing-todo-link',

+    # We somewhat regularly use loops where each iteration needs

+    # a separate try-except block.

+    'try-except-in-loop',

+    # We do not currently use pathlib.  The PTH rules are unselected,

+    # but FURB includes several pathlib-related rules.

+    'read-whole-file', 'write-whole-file',

+    # We catch type-ignore comments without specific code via the mypy

+    # configuration, not via ruff.

+    'blanket-type-ignore',

+    # Provisionally ignore the `__init__.py` rule, until we can adapt our

+    # codebase.

+    'non-empty-init-module',

+    # We prefer noqa comments over ruff-specific ignores, for tool

+    # compatibility reasons, even if the comments themselves become harder

+    # to read. Using them in the ruff config section is fine thought,

+    # because that *is* ruff-specific.

+    'noqa-comments',

+    # Still undecided about this one.

+    'too-many-statements-in-try-clause',

+]

+preview = true

+# We select here in the order of presentation on the ruff documentation

+# website.  ruff default selection (v0.6.2) is merely E4, E7, E9 and F.

+select = [

+    'F', 'E', 'W', 'C90', 'I', 'N', 'D', 'UP', 'YTT',

+    'ANN', 'ASYNC', 'S', 'BLE', 'FBT', 'B', 'A', 'COM',

+    'CPY', 'C4', 'DTZ', 'T10', 'DJ', 'EM', 'EXE', 'FA',

+    'ISC', 'ICN', 'LOG', 'G', 'INP', 'PIE', 'T20', 'PYI',

+    'PT', 'Q', 'RET', 'SLF', 'SLOT', 'SIM', 'TID', 'TC',

+    'INT', 'ARG', 'PTH', 'TD',

+    # We use TODOs and FIXMEs as notes for later, and don't want the

+    # linter to nag about every occurrence.  Disable 'FIX'.

+    #

+    # The "eradicate" rule is prone to a lot of false positives, and it

+    # is unclear to me, and probably confusing to read, where to apply

+    # a noqa marker.  Instead, disable 'ERA', and if necessary, specify

+    # it on the command-line.

+    'PD', 'PGH', 'PL', 'TRY', 'FLY', 'NPY', 'FAST',

+    'AIR', 'PERF', 'FURB', 'DOC', 'RUF',

+]

+

+[tool.ruff.lint.per-file-ignores]

+"**/scripts/*" = [

+    # Suggested by hatch.

+    'INP',

+    # Suggested by hatch.

+    'T20',

+]

+"**/tests/**/*" = [

+    # Suggested by hatch, assumingly because it may be important to

+    # verify that the value is exactly the empty string, and not just

+    # any falsy value.

+    'compare-to-empty-string',

+    # Suggested by hatch, assumingly because tests may use "magic

+    # values".

+    'magic-value-comparison',

+    # Suggested by hatch, because tests are typically organized as

+    # classes and instance methods but may not really be using the

+    # `self` argument.

+    'no-self-use',

+    # Suggested by hatch, because these warnings may be precisely what

+    # the tests are supposed to test.

+    'S',

+    # Suggested by hatch, because pytest-style tests conventionally

+    # import code from each other via relative imports.

+    'relative-imports',

+    # Our tests regularly use arguments named `input` to store an input

+    # (text-/byte-)string.

+    'builtin-argument-shadowing',

+    # We regularly annotate pytest fixtures like monkeypatch as `Any`.

+    'any-type',

+    # Our tests generally don't contain docstrings.