pycfdp 0.2.2__tar.gz

pycfdp-0.2.2/LICENSE.txt

@@ -0,0 +1,19 @@
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pycfdp-0.2.2/PKG-INFO

@@ -0,0 +1,76 @@
+Metadata-Version: 2.4
+Name: pycfdp
+Version: 0.2.2
+Summary: Python implementation of CCSDS File Delivery Protocol (Modernized Fork)
+Author-email: Alex Pope <alexpopester@gmail.com>, "LibreCube (Original Codebase)" <info@librecube.org>
+License: MIT License
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Provides-Extra: zmq
+Requires-Dist: pyzmq; extra == "zmq"
+Provides-Extra: spacepacket
+Requires-Dist: spacepacket; extra == "spacepacket"
+Provides-Extra: all
+Requires-Dist: pyzmq; extra == "all"
+Requires-Dist: spacepacket; extra == "all"
+Dynamic: license-file
+
+# Python CFDP, Version 0.2
+
+The CCSDS File Delivery Protocol (CFDP) was developed by the
+[Consultative Committee for Space Data Systems (CCSDS)](https://public.ccsds.org).
+The CFDP protocol provides reliable transfer of files from one endpoint to
+another and has been designed to work well over space links that suffer
+from outtakes and long delays. The basic operation of CFDP is to transfer a
+file from a sender to a receiver (both referred to as CFDP entities). The
+sender and receiver must be configured and running at the same time to perform
+a file transfer. It can be used to perform  space to ground, ground to space,
+space to space, and ground to ground file transfers. For example it can be used
+to transfer science data from satellite over mission control to the science
+center in an automated fashion with minimal to no human intervention.
+
+This Python module is an implementation of the CCSDS File Delivery Protocol.
+It supports all features as outlined in the latest version of the [CFDP Blue Book](docs/727x0b5.pdf). These are:
+
+- Class 1 (unacknowledged) file transfer
+- Class 2 (acknowledged) file transfer
+- Filestore requests
+- Proxy operations
+- Directory listing request
+- Native filestore implementation
+- UDP as default transport layer (optional ZMQ)
+
+## Installation
+
+Clone the repository and then install via pip:
+
+```
+pip install cfdp
+```
+
+> Depending on the transport layer to use with CFDP, one needs to install additional dependencies.
+
+## Documentation
+
+Find the detailed documentation [here](docs/README.md).
+
+## Tests
+
+The protocol is tested for cross-support as outlined in CCSDS CFDP Yellow Book.
+See [tests/README.md](tests/README.md) for details.
+
+## Contribute
+
+To learn more on how to successfully contribute please read the contributing
+information in the [LibreCube documentation](https://librecube.gitlab.io/).
+
+## Support
+
+If you are having issues, please let us know. Reach us at
+[Matrix](https://app.element.io/#/room/#librecube.org:matrix.org)
+or via [Email](mailto:info@librecube.org).
+
+## License
+
+The project is licensed under the MIT license. See the [LICENSE](./LICENSE.txt) file for details.

pycfdp-0.2.2/README.md

@@ -0,0 +1,58 @@
+# Python CFDP, Version 0.2
+
+The CCSDS File Delivery Protocol (CFDP) was developed by the
+[Consultative Committee for Space Data Systems (CCSDS)](https://public.ccsds.org).
+The CFDP protocol provides reliable transfer of files from one endpoint to
+another and has been designed to work well over space links that suffer
+from outtakes and long delays. The basic operation of CFDP is to transfer a
+file from a sender to a receiver (both referred to as CFDP entities). The
+sender and receiver must be configured and running at the same time to perform
+a file transfer. It can be used to perform  space to ground, ground to space,
+space to space, and ground to ground file transfers. For example it can be used
+to transfer science data from satellite over mission control to the science
+center in an automated fashion with minimal to no human intervention.
+
+This Python module is an implementation of the CCSDS File Delivery Protocol.
+It supports all features as outlined in the latest version of the [CFDP Blue Book](docs/727x0b5.pdf). These are:
+
+- Class 1 (unacknowledged) file transfer
+- Class 2 (acknowledged) file transfer
+- Filestore requests
+- Proxy operations
+- Directory listing request
+- Native filestore implementation
+- UDP as default transport layer (optional ZMQ)
+
+## Installation
+
+Clone the repository and then install via pip:
+
+```
+pip install cfdp
+```
+
+> Depending on the transport layer to use with CFDP, one needs to install additional dependencies.
+
+## Documentation
+
+Find the detailed documentation [here](docs/README.md).
+
+## Tests
+
+The protocol is tested for cross-support as outlined in CCSDS CFDP Yellow Book.
+See [tests/README.md](tests/README.md) for details.
+
+## Contribute
+
+To learn more on how to successfully contribute please read the contributing
+information in the [LibreCube documentation](https://librecube.gitlab.io/).
+
+## Support
+
+If you are having issues, please let us know. Reach us at
+[Matrix](https://app.element.io/#/room/#librecube.org:matrix.org)
+or via [Email](mailto:info@librecube.org).
+
+## License
+
+The project is licensed under the MIT license. See the [LICENSE](./LICENSE.txt) file for details.

pycfdp-0.2.2/pyproject.toml

@@ -0,0 +1,68 @@
+[project]
+name = "pycfdp"
+version = "0.2.2"
+requires-python = ">=3.11"
+authors = [
+    { name = "Alex Pope", email = "alexpopester@gmail.com" },
+    { name = "LibreCube (Original Codebase)", email = "info@librecube.org" },
+]
+description = "Python implementation of CCSDS File Delivery Protocol (Modernized Fork)"
+readme = "README.md"
+license = { text = "MIT License" }
+dependencies = []
+
+[project.optional-dependencies]
+zmq = ["pyzmq"]
+spacepacket = ["spacepacket"]
+all = ["pyzmq", "spacepacket"]
+
+[build-system]
+requires = ["setuptools>=68"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[dependency-groups]
+dev = [
+    "pytest>=8",
+    "pyzmq",
+    "spacepacket",
+    "ruff>=0.16",
+    "mypy>=1.11",
+]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = ["tests"]
+
+[tool.mypy]
+# Permissive by design (issue: finish what py.typed started). Default mypy does
+# not check the bodies of un-annotated functions, so this gate validates the
+# annotations that ARE present (the machine/shell seam) without demanding
+# annotations across the whole codebase. Tighten incrementally as annotations
+# spread (e.g. enable check_untyped_defs, then disallow_untyped_defs per-module).
+python_version = "3.11"
+files = ["src/cfdp"]
+
+[[tool.mypy.overrides]]
+# Optional transport deps ship no type stubs / py.typed marker.
+module = ["spacepacket.*", "zmq.*"]
+ignore_missing_imports = true
+
+[tool.ruff]
+target-version = "py311"
+src = ["src", "tests"]
+
+[tool.ruff.lint]
+# Correctness (F), pycodestyle (E), import sorting (I), pyupgrade (UP).
+select = ["E", "F", "I", "UP"]
+ignore = [
+    "E501",   # line length is owned by the formatter
+    "UP031",  # legacy %-formatting in logging calls; harmless, deferred
+]
+
+[tool.ruff.lint.per-file-ignores]
+# __init__.py deliberately re-exports the public API (F401/F403) and sets up
+# the package logger before imports (E402).
+"__init__.py" = ["F401", "F403", "E402"]

pycfdp-0.2.2/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

pycfdp-0.2.2/src/cfdp/__init__.py

@@ -0,0 +1,106 @@
+import logging
+
+logger = logging.getLogger(__name__)
+
+from .constants import (
+    DEFAULT_ACK_TIMER_EXPIRATION_LIMIT,
+    DEFAULT_ACK_TIMER_LIMIT,
+    DEFAULT_FAULT_HANDLERS,
+    DEFAULT_INACTIVITY_TIMEOUT,
+    DEFAULT_MAX_FILE_SEGMENT_LEN,
+    DEFAULT_NAK_TIMER_EXPIRATION_LIMIT,
+    DEFAULT_NAK_TIMER_INTERVAL,
+    ActionCode,
+    ChecksumType,
+    ConditionCode,
+    DeliveryCode,
+    Direction,
+    FaultHandlerAction,
+    FileStatus,
+    MachineState,
+    TransactionStatus,
+    TransmissionMode,
+)
+from .core import CfdpEntity
+from .event import Event, EventType
+from .meta import process_user_message
+from .meta.filestore import FilestoreRequest
+from .meta.message import (
+    DirectoryListingRequest,
+    DirectoryListingResponse,
+    MessageToUser,
+    OriginatingTransactionId,
+    ProxyPutCancel,
+    ProxyPutRequest,
+    RemoteResumeRequest,
+    RemoteResumeResponse,
+    RemoteSuspendRequest,
+    RemoteSuspendResponse,
+    UnrecognizedMessage,
+)
+from .pdu import (
+    AckPdu,
+    EofPdu,
+    FiledataPdu,
+    FinishedPdu,
+    KeepAlivePdu,
+    MetadataPdu,
+    NakPdu,
+    PduHeader,
+    PromptPdu,
+)
+from .pure.transaction import Transaction
+from .remote_entity_config import RemoteEntityConfig
+from .transaction_handle import TransactionHandle
+
+__all__ = [
+    # Core public API
+    "CfdpEntity",
+    "RemoteEntityConfig",
+    "TransactionHandle",
+    # Constants / enums used in the public interface
+    "TransmissionMode",
+    "Direction",
+    "ConditionCode",
+    "MachineState",
+    "DeliveryCode",
+    "FileStatus",
+    "TransactionStatus",
+    "FaultHandlerAction",
+    "ChecksumType",
+    "ActionCode",
+    "FilestoreRequest",
+    "DEFAULT_FAULT_HANDLERS",
+    "DEFAULT_INACTIVITY_TIMEOUT",
+    "DEFAULT_ACK_TIMER_LIMIT",
+    "DEFAULT_ACK_TIMER_EXPIRATION_LIMIT",
+    "DEFAULT_NAK_TIMER_INTERVAL",
+    "DEFAULT_NAK_TIMER_EXPIRATION_LIMIT",
+    "DEFAULT_MAX_FILE_SEGMENT_LEN",
+    # PDU types (needed for advanced use)
+    "PduHeader",
+    "MetadataPdu",
+    "FiledataPdu",
+    "EofPdu",
+    "FinishedPdu",
+    "NakPdu",
+    "AckPdu",
+    "KeepAlivePdu",
+    "PromptPdu",
+    # Meta / message types
+    "MessageToUser",
+    "ProxyPutRequest",
+    "ProxyPutCancel",
+    "DirectoryListingRequest",
+    "DirectoryListingResponse",
+    "OriginatingTransactionId",
+    "RemoteSuspendRequest",
+    "RemoteSuspendResponse",
+    "RemoteResumeRequest",
+    "RemoteResumeResponse",
+    "UnrecognizedMessage",
+    # Internal types occasionally accessed in tests / advanced usage
+    "Event",
+    "EventType",
+    "Transaction",
+]

pycfdp-0.2.2/src/cfdp/checksum.py

@@ -0,0 +1,94 @@
+import binascii
+from collections.abc import Iterable
+
+
+class UnsupportedChecksumType(Exception):
+    pass
+
+
+class PduCrcError(Exception):
+    pass
+
+
+def _build_crc32c_table():
+    poly = 0x82F63B78  # reversed Castagnoli polynomial
+    table = []
+    for i in range(256):
+        crc = i
+        for _ in range(8):
+            crc = (crc >> 1) ^ poly if crc & 1 else crc >> 1
+        table.append(crc)
+    return table
+
+
+_CRC32C_TABLE = _build_crc32c_table()
+
+
+def calculate_checksum(data_iter: Iterable[bytes], checksum_type: int) -> int:
+    """Compute a CFDP file checksum over an iterable of byte chunks."""
+    if checksum_type == 0:  # Modular (CCSDS 727.0-B-5 Annex F)
+        checksum = 0
+        buf = b""
+        for chunk in data_iter:
+            buf += chunk
+            n = (len(buf) // 4) * 4
+            for i in range(0, n, 4):
+                checksum += int.from_bytes(buf[i : i + 4], "big")
+            buf = buf[n:]
+        if buf:
+            padded = buf + b"\x00" * (4 - len(buf))
+            checksum += int.from_bytes(padded, "big")
+        return checksum % (2**32)
+
+    elif checksum_type == 2:  # CRC-32C (Castagnoli)
+        crc = 0xFFFFFFFF
+        for chunk in data_iter:
+            for byte in chunk:
+                crc = (crc >> 8) ^ _CRC32C_TABLE[(crc ^ byte) & 0xFF]
+        return crc ^ 0xFFFFFFFF
+
+    elif checksum_type == 3:  # IEEE CRC-32
+        crc = 0
+        for chunk in data_iter:
+            crc = binascii.crc32(chunk, crc)
+        return crc & 0xFFFFFFFF
+
+    elif checksum_type == 15:  # Null
+        return 0
+
+    else:
+        raise UnsupportedChecksumType(f"Unsupported checksum type: {checksum_type}")
+
+
+def crc16_ccitt(data: bytes) -> int:
+    """CRC-16/CCITT-FALSE (poly=0x1021, init=0xFFFF) used for PDU integrity."""
+    crc = 0xFFFF
+    for byte in data:
+        crc ^= byte << 8
+        for _ in range(8):
+            crc = (crc << 1) ^ 0x1021 if crc & 0x8000 else crc << 1
+        crc &= 0xFFFF
+    return crc
+
+
+def strip_pdu_crc(pdu: bytes) -> bytes:
+    """If crc_flag is set, verify the trailing 2-byte CRC and return the PDU without it."""
+    if not (pdu[0] >> 1) & 0x01:
+        return pdu
+    received = int.from_bytes(pdu[-2:], "big")
+    computed = crc16_ccitt(pdu[:-2])
+    if received != computed:
+        raise PduCrcError(
+            f"PDU CRC mismatch: computed {computed:#06x}, received {received:#06x}"
+        )
+    return pdu[:-2]
+
+
+def finalize_pdu(pdu_header, databytes: bytes) -> bytes:
+    """Set pdu_data_field_length, encode header+data, append CRC-16 if crc_flag=1."""
+    crc_flag = pdu_header.crc_flag
+    pdu_header.pdu_data_field_length = len(databytes) + (2 if crc_flag else 0)
+    pdu_bytes = pdu_header.encode() + databytes
+    if crc_flag:
+        pdu_bytes += crc16_ccitt(pdu_bytes).to_bytes(2, "big")
+    return pdu_bytes

pycfdp-0.2.2/src/cfdp/constants.py

@@ -0,0 +1,153 @@
+class ProtocolVersion:
+    VERSION_1 = 0
+    VERSION_2 = 1
+
+
+class TransmissionMode:
+    ACKNOWLEDGED = 0
+    UNACKNOWLEDGED = 1
+
+
+class PduTypeCode:
+    FILE_DIRECTIVE = 0
+    FILE_DATA = 1
+
+
+class Direction:
+    TOWARD_RECEIVER = 0
+    TOWARD_SENDER = 1
+
+
+class DirectiveCode:
+    EOF = 0x04
+    FINISHED = 0x05
+    ACK = 0x06
+    METADATA = 0x07
+    NAK = 0x08
+    PROMPT = 0x09
+    KEEP_ALIVE = 0x0C
+
+
+class DirectiveSubTypeCode:
+    ACK_OTHERS = 0x00
+    ACK_FINISHED = 0x01
+
+
+class ConditionCode:
+    NO_ERROR = 0
+    POSITIVE_ACK_LIMIT_REACHED = 1
+    KEEP_ALIVE_LIMIT_REACHED = 2
+    INVALID_TRANSMISSION_MODE = 3
+    FILESTORE_REJECTION = 4
+    FILE_CHECKSUM_FAILURE = 5
+    FILE_SIZE_ERROR = 6
+    NAK_LIMIT_REACHED = 7
+    INACTIVITY_DETECTED = 8
+    INVALID_FILE_STRUCTURE = 9
+    CHECK_LIMIT_REACHED = 10
+    UNSUPPORTED_CHECKSUM_TYPE = 11
+    SUSPEND_REQUEST_RECEIVED = 14
+    CANCEL_REQUEST_RECEIVED = 15
+
+
+class MachineState:
+    SEND_METADATA = "SEND_METADATA"
+    SEND_FILE = "SEND_FILE"
+    SEND_EOF = "SEND_EOF"
+    TRANSACTION_CANCELLED = "TRANSACTION_CANCELLED"
+    WAIT_FOR_MD = "WAIT_FOR_MD"
+    WAIT_FOR_EOF = "WAIT_FOR_EOF"
+    GET_MISSING_DATA = "GET_MISSING_DATA"
+    SEND_FINISHED = "SEND_FINISHED"
+    COMPLETED = "COMPLETED"
+
+
+class DeliveryCode:
+    DATA_COMPLETE = 0
+    DATA_INCOMPLETE = 1
+
+
+class FileStatus:
+    DISCARDED_DELIBERATELY = 0
+    DISCARDED_FILESTOR_REJECTION = 1
+    RETAINED_SUCCESSFULLY = 2
+    UNREPORTED = 3
+
+
+class TransactionStatus:
+    UNDEFINED = 0
+    ACTIVE = 1
+    TERMINATED = 2
+    UNRECOGNIZED = 3
+
+
+class ActionCode:
+    CREATE_FILE = 0
+    DELETE_FILE = 1
+    RENAME_FILE = 2
+    APPEND_FILE = 3
+    REPLACE_FILE = 4
+    CREATE_DIRECTORY = 5
+    REMOVE_DIRECTORY = 6
+    DENY_FILE = 7  # delete if present
+    DENY_DIRECTORY = 8  # remove if present
+
+
+class TypeFieldCode:
+    FILESTORE_REQUEST = 0x00
+    FILESTORE_RESPONSE = 0x01
+    MESSAGE_TO_USER = 0x02
+    FAULT_HANDLER_OVERRIDES = 0x04
+    FLOW_LABEL = 0x05
+    ENTITY_ID = 0x06
+
+
+class MessageType:
+    PROXY_PUT_REQUEST = 0x00
+    PROXY_PUT_CANCEL = 0x09
+    ORIGINATING_TRANSACTION_ID = 0x0A
+    DIRECTORY_LISTING_REQUEST = 0x10
+    DIRECTORY_LISTING_RESPONSE = 0x11
+    REMOTE_SUSPEND_REQUEST = 0x30
+    REMOTE_SUSPEND_RESPONSE = 0x31
+    REMOTE_RESUME_REQUEST = 0x38
+    REMOTE_RESUME_RESPONSE = 0x39
+
+
+class FaultHandlerAction:
+    CANCEL = "CANCEL"
+    SUSPEND = "SUSPEND"
+    IGNORE = "IGNORE"
+    ABANDON = "ABANDON"
+
+
+class ChecksumType:
+    MODULAR = 0
+    PROXIMITY1 = 1
+    CRC32C = 2
+    IEEE = 3
+    NULL = 15
+
+
+DEFAULT_MAX_FILE_SEGMENT_LEN = 800
+DEFAULT_INACTIVITY_TIMEOUT = 30
+DEFAULT_ACK_TIMER_LIMIT = 5
+DEFAULT_ACK_TIMER_EXPIRATION_LIMIT = 3
+DEFAULT_NAK_TIMER_INTERVAL = 5
+DEFAULT_NAK_TIMER_EXPIRATION_LIMIT = 5
+DEFAULT_FAULT_HANDLERS = {
+    ConditionCode.NO_ERROR: FaultHandlerAction.IGNORE,
+    ConditionCode.POSITIVE_ACK_LIMIT_REACHED: FaultHandlerAction.CANCEL,
+    ConditionCode.KEEP_ALIVE_LIMIT_REACHED: FaultHandlerAction.CANCEL,
+    ConditionCode.INVALID_TRANSMISSION_MODE: FaultHandlerAction.CANCEL,
+    ConditionCode.FILESTORE_REJECTION: FaultHandlerAction.CANCEL,
+    ConditionCode.FILE_CHECKSUM_FAILURE: FaultHandlerAction.CANCEL,
+    ConditionCode.FILE_SIZE_ERROR: FaultHandlerAction.CANCEL,
+    ConditionCode.NAK_LIMIT_REACHED: FaultHandlerAction.CANCEL,
+    ConditionCode.INACTIVITY_DETECTED: FaultHandlerAction.CANCEL,
+    ConditionCode.INVALID_FILE_STRUCTURE: FaultHandlerAction.CANCEL,
+    ConditionCode.CHECK_LIMIT_REACHED: FaultHandlerAction.CANCEL,
+    ConditionCode.UNSUPPORTED_CHECKSUM_TYPE: FaultHandlerAction.CANCEL,
+    ConditionCode.SUSPEND_REQUEST_RECEIVED: FaultHandlerAction.IGNORE,
+    ConditionCode.CANCEL_REQUEST_RECEIVED: FaultHandlerAction.IGNORE,
+}