Metadata-Version: 2.1
Name: asn1editor
Version: 0.5.0
Summary: ASN.1 editor framework with support for encoding and decoding various codecs.
Home-page: https://github.com/futsch1/asn1editor
Author: Florian Fetz
Author-email: florian.fetz@gmail.com
License: MIT
Description: ![Build](https://github.com/Futsch1/asn1editor/workflows/Build/badge.svg)
        [![Coverage Status](https://coveralls.io/repos/github/Futsch1/asn1editor/badge.svg?branch=master)](https://coveralls.io/github/Futsch1/asn1editor?branch=master)
        # asn1editor
        Python based ASN.1 editor
        
        This project contains a generic editor to view and edit ASN.1 encoded data. 
        It can load and save data encoded in various ASN.1 formats. It uses
        [asn1tools](https://github.com/eerimoq/asn1tools) to parse
        ASN.1 specifications and read and write encoded data.
        
        The controller part of the editor is written independently of the 
        used GUI framework. A view implementation with wxPython is provided.
        
        ![Screenshot](docs/screenshot_tree.png?raw=true "asn1editor")
        
        ## Usage
        To start the wxPython based editor, install asn1editor via pip:
        
        ```pip install asn1editor```
        
        Then you can run asn1editor from the shell
        
        ```asn1editor [-h] [-type TYPE] [-data DATA] [asn1spec]```
        
        The ASN.1 specification to be loaded can be passed as an (optional) argument. The type inside the ASN.1 specification can be selected using the syntax < Module
        name >.< Type name >. Finally, a data file can be passed as well that contains data encoded in the ASN.1 specification.
        
        ## Features
        
        ### Supported types
        The editor supports a large variety of ASN.1 data types:
        - INTEGER
        - REAL
        - ENUMERATED
        - BOOLEAN
        - OCTET STRING, VisibleString, UTF8String, GeneralString, IA5String, OBJECT IDENTIFIER
        - BIT STRING
        - SEQUENCE, SET
        - SEQUENCE OF, SET OF
        - CHOICE
        - DATE, TIME-OF-DAY, DATE-TIME, DURATION, GeneralizedTime, UTCTime
        
        ### Supported encodings
        
        The following encodings are supported for reading and writing data:
        
        - JER
        - OER
        - XER
        - DER
        - BER
        - PER
        - UPER
        
        ### GUI features
        - Load and save encoded data
        - View the data in a tree view or as groups
        ![Screenshot](docs/screenshot_groups.png?raw=true "asn1editor group view")
        - See limits of numeric values and texts as tooltips
        - Edit octet strings as ASCII or hex
        - List of recently opened specifications for quick access
        - Optional dark mode
        - Use a .style file to customize the way fields are displayed in asn1editor
        
          If an ASN.1 file is opened, asn1editor looks for an equally named file with a .style extension in the same directory. If it is found, it is loaded and used to
          refine the layout of the specification. A style file is JSON formatted and contains the name of the ASN.1 field as a key, and the layout specifier as value.
          The specifiers "read_only" and
          "hidden" are supported.
        
          Example:
          ```json
          { "firstField": "read_only", "secondField": "hidden"}
          ```
        
        ### IMPORTS
        IMPORT references are automatically resolved if the ASN1 files containing the imported types 
        reside in the same directory and have the extension ".asn". 
        
        ### Extending asn1editor
        
        If you want to extend asn1editor with custom functionality, you can pass a plugin object to the WxPythonMainWindow object.
        The plugin object needs to inherit from asn1editor.Plugin.
        
        Example:
        
        ```python
        import wx
        from asn1editor import WxPythonMainWindow, Plugin
        
        class MyPlugin(Plugin):
            # Implementation of abstract functions goes here
            pass
        
        app = wx.App()
        
        frame = WxPythonMainWindow(MyPlugin)
        
        frame.Show()
        
        app.MainLoop()
        ```
        
        ## Plugin interface
        In order to use custom data formats or to work with the data, plugins
        can be used. These plugins need to inherit from the Plugin.Plugin class and
        can use the PluginInterface.PluginInterface class to interact with the
        main application. A list of plugins can be passed to the constructor of the main editor class
        and is then automatically embedded in the application.
        
        An example application is if a custom header is added to an ASN.1 encoded data. Then the plugin
        can decode the header, choose the appropriate ASN.1 specification, load it, decode the data and display it.
        
Keywords: ASN.1,asn1,editor
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development
Requires-Python: >=3.6
Description-Content-Type: text/markdown
