py1815 0.1.0__tar.gz

py1815-0.1.0/.gitignore

@@ -0,0 +1,23 @@
+__pycache__/
+*.py[cod]
+*.egg
+*.egg-info/
+dist/
+build/
+.venv/
+.mypy_cache/
+.pytest_cache/
+.ruff_cache/
+.coverage
+htmlcov/
+
+# Build output of the interoperability Rust master.
+interop/rust-master/target/
+
+# Artifacts the interoperability sweep writes.
+sweep.pcap
+sweep.json
+suricata-out/
+
+# Built documentation site.
+site/

py1815-0.1.0/CHANGELOG.md

@@ -0,0 +1,164 @@
+# Changelog
+
+Notable changes to this project, newest first. Versions follow
+[semantic versioning](https://semver.org/spec/v2.0.0.html): while the major
+version is `0`, a minor bump may carry a breaking change and the release note
+says so explicitly.
+
+## [Unreleased]
+
+Nothing yet.
+
+## [0.1.0] - 2026-09-29
+
+First release. The protocol stack, the listener, the event path and controls;
+unsolicited responses and the point-map loader are not in it. The API is not
+stable, and while the major version is `0` a minor bump may carry a breaking
+change.
+
+### Added
+
+- **The protocol stack**: CRC-16/DNP, FT3 data link framing with a stream
+  reader, transport segmentation and reassembly, the application layer's
+  control octet, function codes, internal indications and object headers, and
+  static binary and analog inputs with their quality flags. Each layer is
+  testable without the ones above it, and the session does no I/O at all -- it
+  takes the octets that arrived and returns the octets to send -- so behavior
+  is pinned against literal frames rather than against a socket.
+- **The listener**: TCP and TLS, with an explicit peer allow-list by subject
+  name or certificate fingerprint. One master association at a time; admission
+  is serialized, and a peer that fails authorization changes nothing about the
+  association already established.
+- **An interoperability suite of implementations that are not this one.** Four
+  across three jobs, chosen so that no two are the same codebase in different
+  clothes: a C++ master through its Python bindings, a Rust master by different
+  authors that checks the quality octet and the object variation the C++
+  bindings discard, and Wireshark and Suricata reading a capture of the whole
+  function code sweep and verifying every checksum in it. The unit suite is
+  this library marking its own homework; these jobs are the part that is not.
+- **Event buffers for classes 1, 2 and 3**, with deadbands, overflow reporting
+  and confirmation handling. A deadband is measured against the last value
+  *reported*, not the previous reading, so a point drifting in steps smaller
+  than the deadband is still eventually reported rather than never. A quality
+  change generates an event whatever its magnitude, because a point that goes
+  comm-lost holding the same number has changed in the way that matters most. A
+  full buffer drops its oldest event and says so.
+- **Event object encoding**: the timed and untimed variations of groups 2 and
+  32, the six-octet timestamp, and index-prefixed event blocks. Events are not a
+  range -- they are whichever points changed, in the order they changed -- so
+  each carries its own index.
+- **The event path: a master can now read what the buffers hold.** A read naming
+  classes 1, 2 or 3 is answered from them, class 0 still reaches the read
+  provider, and an integrity poll naming both gets one response with the events
+  in front -- a master applies a fragment in order, so a static value written
+  after the events that led to it leaves the point where it should end up.
+
+  Events are not consumed by being read. They leave the buffer when the master
+  confirms the response carrying them, so a response that never arrives has not
+  taken the only copy with it, and a master that reads twice without confirming
+  sees the same events twice. A confirmation retires exactly the events its
+  sequence number covers; one naming any other sequence retires nothing. A
+  request repeated under the same sequence is replayed octet for octet rather
+  than rebuilt, so the confirmation that follows acknowledges what was actually
+  sent.
+
+  The class and overflow indication bits are derived from the buffers on every
+  response rather than tracked beside them, so a bit cannot drift from what is
+  waiting. Overflow is retired when the master acknowledges the read that
+  reported it -- including a read that carries the bit and no events, which
+  would otherwise be a report nothing could ever clear. Other responses report
+  the overflow without asking to be confirmed, since a refusal or a write is not
+  where an acknowledgement belongs and the next read is what retires it.
+- **A ceiling on the size of a response, and on the work of building one.** A
+  master sizes its receive buffer to the fragment size it advertises, so a
+  response past it is discarded rather than merely long. A control request whose
+  echo would not fit is refused *before* anything is dispatched, since a control
+  that executes and cannot report is worse than one that never ran.
+
+  The ceiling bounds the work too. A small response over a large buffer costs
+  the response rather than the buffer.
+- **An answer too large to send at once is a conversation.** The outstation
+  sends what fits, the master confirms it, and the next fragment follows under
+  the next sequence number until the last one says so. A confirmation is
+  therefore the thing that draws out a continuation, which is the only case
+  where this outstation answers something that is not a request.
+
+  No list of unsent events is carried between the fragments. Each is built from
+  the buffers as they then stand, so an event evicted while a master was slow is
+  gone rather than sent from a list that outlived it, and one recorded meanwhile
+  joins the answer rather than waiting for the next -- until the static data
+  starts going out, after which the response takes no more events and they wait
+  for the one after it.
+
+  That needs a bound instead of a rule about which events belong where: a device
+  that records faster than its master confirms would otherwise never be finished
+  with, so a response carries at most sixteen fragments of events and the
+  indication bits go on asking for the rest.
+
+  A master that loses a fragment repeats the confirmation before it and is sent
+  that fragment again. Without it the exchange stops dead -- the master waiting
+  for something that will never arrive, the outstation for a confirmation that
+  will never come.
+
+  Static data travels at the end rather than being reserved for in every
+  fragment, which would have held back a fragment's worth of readings for a body
+  arriving several round trips later.
+- **A provider may say where its own objects end.** `ReadProvider` keeps `read`,
+  which answers in octets and stays the contract; beside it a provider may
+  implement `read_blocks` and have its static data spread across the fragments
+  of a response. Without it a point map too large for one fragment is refused,
+  and a class 0 poll over roughly 290 analog points already exceeds what a
+  master typically advertises. This library still divides nothing: the split
+  points are the provider's, and a single block too large to send is refused as
+  a whole body would be.
+- **`DISABLE_UNSOLICITED` is answered rather than refused.** An outstation that
+  sends no unsolicited responses is already in the state the request asks for,
+  so refusing it answered a question the master did not ask. `ENABLE_UNSOLICITED`
+  is still refused, which is the honest answer while nothing is sent.
+- **Controls: this outstation commands as well as reports.** `SELECT`,
+  `OPERATE`, `DIRECT_OPERATE` and `DIRECT_OPERATE NO ACK`, over control relay
+  output blocks and analog output setpoints, with the output status points a
+  master reads back afterwards. Given no control provider it still refuses every
+  one, which is the truthful answer for an outstation that monitors rather than
+  a degraded version of one that commands.
+
+  Each control is answered on its own: a request naming four points where one is
+  unsupported returns four objects with three successes and one refusal, rather
+  than one verdict for the fragment. A request that cannot be parsed is refused
+  whole instead, because a status has to be attached to an object and a
+  truncated body may leave none.
+
+  Select-before-operate holds the request it was given rather than the points
+  that accepted it, since the operate a master sends next is the request it
+  already sent. Matching compares the octets, which is exact and sidesteps the
+  fact that two NaN setpoints never compare equal.
+
+### Changed
+
+- **`DIRECT_OPERATE NO ACK` executes rather than being dropped.** The standard
+  defines it as function code 5 without a response, and it was previously
+  discarded unexecuted -- correct for an outstation that could not command, and
+  the worst available behavior for one that can, since a master would believe it
+  had issued commands that were silently thrown away. It stays silent, including
+  when its body does not parse: a master that asked for no response is not
+  listening for a parse error either.
+- **A displaced connection is now aborted; a connection closed at shutdown still
+  closes gracefully.** The two callers want opposite things. A displaced peer is
+  typically one whose socket died without a FIN, where a graceful close waits on
+  TCP retransmission -- under the admission lock, which would let a dead master
+  hold the association through a second door. A master connected at shutdown is
+  usually healthy, and aborting would discard a response already queued.
+- **Every no-response function code is met with silence before it is parsed**,
+  as the standard requires.
+- Quality masks are derived from their own enum per point type, rather than one
+  mask built from the analog enum and adjusted by a binary bit. The binary
+  chatter-filter bit was previously covered only because it shares `0x20` with
+  an analog bit.
+
+### Fixed
+
+- An event encoder given a timestamp for an untimed variation discarded it
+  silently, so the caller believed it had sent a time and the master received an
+  event without one. Both directions are now refused.
+- An exception during connection admission escaped without closing the arriving
+  socket, leaving a live peer the listener reported as not connected.

py1815-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,115 @@
+# Contributing
+
+Contributions are welcome -- bug reports, interop findings from real masters,
+and documentation.
+
+## Before you write code
+
+**For a bug**, open an issue with enough to reproduce it: the master
+implementation you were talking to, the function code and objects involved, and
+the frame bytes if you have them. An outstation is judged by what it puts on the
+wire, so a capture or a hex dump is worth more than a description.
+
+**For a feature or a behavior change**, open an issue first. This is a protocol
+implementation, so the useful question is rarely "should we do this" but "what
+does the standard require" -- and that is cheaper to settle before the code than
+after.
+
+**For a point map**, the IEEE 1815.2 DER profile's tables cannot ship here: they
+assign specific indices to specific measurements and are distributed to DNP
+Users Group members rather than published, so a library carrying them could not
+be shared. A map for your own device belongs in your project.
+
+That prohibition is narrower than "no maps ever". The roadmap plans a map-format
+loader and a published table for the predecessor DER profile, and whether the
+AN2018-001-derived map ships with the first release is an open question in
+[DESIGN.md](docs/DESIGN.md) -- it carries an attribution obligation that needs
+confirming before publication. Neither the loader nor the format exists yet; the
+only interface today is the caller-supplied `ReadProvider`. Open an issue before
+building against either.
+
+## Development setup
+
+```bash
+git clone https://github.com/DERSecurity/py1815
+cd py1815
+python -m venv .venv && source .venv/bin/activate   # Windows: .venv\Scripts\activate
+pip install -e ".[dev]"
+```
+
+There are no runtime dependencies, and that is deliberate -- an outstation that
+drags a dependency tree onto an embedded target is harder to justify than one
+that does not. The development extra is `pytest`, `pytest-asyncio`, `ruff` and
+`mypy`.
+
+Then:
+
+```bash
+pytest -q
+ruff check src tests interop
+ruff format --check src tests interop
+mypy src
+```
+
+CI runs all four on Python 3.11, 3.12 and 3.13.
+
+## The interop jobs
+
+The unit suite is this library marking its own homework: a test that encodes
+with this library and decodes with it agrees with itself through any mistake
+both halves share. The `interop` workflow is the part that does not, and it
+gates every pull request.
+
+Four implementations across three jobs, chosen so no two are the same codebase
+in different clothes: a C++ master through its Python bindings, a Rust master by
+different authors, and Wireshark and Suricata reading a capture of the whole
+function code sweep. The masters answer "does it say the right thing"; the
+dissectors answer "is what it put on the wire really DNP3".
+
+A change to framing, to object encoding, or to the function codes the outstation
+answers should expect to be caught here rather than by the unit tests. Run it
+locally before pushing if you can -- `interop/` holds the outstation fixture and
+each peer's driver.
+
+## What a good change looks like
+
+**Tests that could fail.** A test that passes against the broken code tests
+nothing. The check that catches this: revert your fix, confirm the test fails,
+restore it. Assertions shaped like the fixture rather than the behavior are the
+usual way this goes wrong.
+
+**Bytes, not round trips.** Protocol tests compare against literal octets --
+`bytes.fromhex` and an explicit expected value. A test that encodes and then
+decodes with the same library proves only that the two halves agree, which they
+will even when both are wrong.
+
+**Comments that say why.** What the code does is visible; why it does that
+rather than the obvious thing is not. Where the standard forced your hand, cite
+the clause -- a reference to IEEE 1815 tells the next reader far more than a
+restatement of the line below it.
+
+**Type annotations on public API.** `mypy` runs against `src/`. Tests are
+exempt.
+
+## How changes land
+
+Every change to `main` arrives through a pull request, including the
+maintainers' own. Direct pushes, force pushes and branch deletion are blocked by
+branch protection, with no bypass.
+
+A pull request merges when the three test jobs and the `interop` gate are green
+and it carries an approving review. Branches do not have to be up to date with
+`main` first: merging one pull request does not send the others back for a
+rebase, because the peer jobs run against the merge result anyway.
+
+## Conventions
+
+- Line length 100, enforced by `ruff`.
+- American English in code, comments, and documentation.
+- Commit messages: a short imperative subject, then prose explaining why the
+  change is right. No trailers.
+
+## Reporting a security issue
+
+Please do not open a public issue for a vulnerability. See
+[SECURITY.md](SECURITY.md).

py1815-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

py1815-0.1.0/NOTICE

@@ -0,0 +1,10 @@
+py1815
+Copyright 2026 DER Security Corp
+
+This product includes software developed at DER Security Corp.
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not
+use this file except in compliance with the License. You may obtain a copy of
+the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0