dimp 2.4.3__tar.gz → 2.5.0__tar.gz

{dimp-2.4.3 → dimp-2.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dimp
-Version: 2.4.3
+Version: 2.5.0
 Summary: Decentralized Instant Messaging Protocol
 Home-page: https://github.com/dimchat/core-py
 Author: Albert Moky
@@ -29,6 +29,8 @@ License-File: LICENSE
 
 ## Dependencies
 
+* Latest Versions
+
 | Name | Version | Description |
 |------|---------|-------------|
 | [Ming Ke Ming (名可名)](https://github.com/dimchat/mkm-py) | [![Version](https://img.shields.io/pypi/v/mkm)](https://pypi.org/project/mkm) | Decentralized User Identity Authentication |
@@ -47,7 +49,6 @@ License-File: LICENSE
 ```python
 from abc import ABC, abstractmethod
 from enum import IntEnum
-from collections.abc import Mapping
 from typing import Optional
 
 from dimp import *
@@ -82,9 +83,9 @@ class HandshakeCommand(Command, ABC):
             "type" : i2s(0x88),
             "sn"   : 12345,
 
-            "command" : "handshake",    // command name
-            "title"   : "Hello world!", // "DIM?", "DIM!"
-            "session" : "{SESSION_ID}", // session key
+            "command" : "handshake",     // command name
+            "title"   : "Hello world!",  // "DIM?", "DIM!"
+            "session" : "{SESSION_KEY}", // session key
         }
     """
     HANDSHAKE = 'handshake'
@@ -147,6 +148,13 @@ class HandshakeCommand(Command, ABC):
     again = ask         # (2. S->C) ask client to handshake with new session key
     restart = offer     # (3. C->S) handshake with new session key
     success = accepted  # (4. S->C) notice the client that handshake accepted
+```
+
+```python
+from collections.abc import Mapping
+from typing import Optional
+
+from dimp import *
 
 
 class BaseHandshakeCommand(BaseCommand, HandshakeCommand):

{dimp-2.4.3 → dimp-2.5.0}/README.md

@@ -15,6 +15,8 @@
 
 ## Dependencies
 
+* Latest Versions
+
 | Name | Version | Description |
 |------|---------|-------------|
 | [Ming Ke Ming (名可名)](https://github.com/dimchat/mkm-py) | [![Version](https://img.shields.io/pypi/v/mkm)](https://pypi.org/project/mkm) | Decentralized User Identity Authentication |
@@ -33,7 +35,6 @@
 ```python
 from abc import ABC, abstractmethod
 from enum import IntEnum
-from collections.abc import Mapping
 from typing import Optional
 
 from dimp import *
@@ -68,9 +69,9 @@ class HandshakeCommand(Command, ABC):
             "type" : i2s(0x88),
             "sn"   : 12345,
 
-            "command" : "handshake",    // command name
-            "title"   : "Hello world!", // "DIM?", "DIM!"
-            "session" : "{SESSION_ID}", // session key
+            "command" : "handshake",     // command name
+            "title"   : "Hello world!",  // "DIM?", "DIM!"
+            "session" : "{SESSION_KEY}", // session key
         }
     """
     HANDSHAKE = 'handshake'
@@ -133,6 +134,13 @@ class HandshakeCommand(Command, ABC):
     again = ask         # (2. S->C) ask client to handshake with new session key
     restart = offer     # (3. C->S) handshake with new session key
     success = accepted  # (4. S->C) notice the client that handshake accepted
+```
+
+```python
+from collections.abc import Mapping
+from typing import Optional
+
+from dimp import *
 
 
 class BaseHandshakeCommand(BaseCommand, HandshakeCommand):

dimp-2.5.0/dimp/__init__.py

@@ -0,0 +1,384 @@
+# -*- coding: utf-8 -*-
+#
+#   DIMP : Decentralized Instant Messaging Protocol
+#
+#                                Written in 2019 by Moky <albert.moky@gmail.com>
+# ==============================================================================
+# MIT License
+#
+# Copyright (c) 2019 Albert Moky
+#
+# 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.
+# ==============================================================================
+
+"""
+    DIMP
+    ~~~~
+
+    Decentralized Instant Messaging Protocol
+"""
+
+from .types import *
+from .format import *
+from .crypto import *
+from .protocol import *
+from .dkd import *
+from .ext import *
+
+
+name = "DIMP"
+
+__author__ = 'Albert Moky'
+
+__all__ = [
+
+    'Singleton',
+
+    'final',
+
+    'StrMap', 'MutableStrMap',
+    'AnyList', 'StrList',
+
+    'URI', 'DateTime',
+
+    'Stringer',
+    'ConstantString',  # 'String',
+    'Mapper',
+
+    'Converter', 'DataConverter', 'BaseConverter',
+    'Copier', 'DataCopier', 'BaseCopier',
+    'Wrapper', 'DataWrapper', 'BaseWrapper',
+
+    'Dictionary',
+
+    ################################################################
+    #
+    #   Format
+    #
+    ################################################################
+
+    'DataCoder', 'Hex', 'Base58', 'Base64',
+
+    'ObjectCoder', 'JSON',
+    'MapCoder', 'JSONMap',
+    'StringCoder', 'UTF8',
+
+    'TransportableResource',
+    'TransportableData', 'TransportableDataFactory',
+    # 'FormatExtensions',
+    # 'TransportableDataHelper',
+    # 'shared_format_extensions', 'ted_helper',
+
+    #
+    #   TED
+    #
+
+    'BaseString', 'BaseData',
+
+    'PlainData',
+
+    #
+    #   PNF
+    #
+
+    'TransportableFile', 'TransportableFileFactory',
+    # 'TransportableFileExtension',
+    # 'TransportableFileHelper',
+    # 'pnf_helper',
+    'TransportableFileWrapper', 'TransportableFileWrapperFactory',
+    # 'TransportableFileWrapperExtension',
+    # 'pnf_wrapper_factory',
+
+    ################################################################
+    #
+    #   Crypto
+    #
+    ################################################################
+
+    'MessageDigester',
+    'SHA256', 'KECCAK256', 'RIPEMD160',
+
+    #
+    #   Crypto
+    #
+
+    'CryptographyKey', 'EncryptKey', 'DecryptKey',
+    'AsymmetricKey', 'SignKey', 'VerifyKey',
+    # 'CryptoExtensions',
+    # 'shared_crypto_extensions',
+
+    'SymmetricKey', 'SymmetricKeyFactory',
+    # 'SymmetricKeyExtension',
+    # 'SymmetricKeyHelper',
+    # 'symmetric_helper',
+
+    'PublicKey', 'PublicKeyFactory',
+    # 'PublicKeyExtension',
+    # 'PublicKeyHelper',
+    # 'public_helper',
+
+    'PrivateKey', 'PrivateKeyFactory',
+    # 'PrivateKeyExtension',
+    # 'PrivateKeyHelper',
+    # 'private_helper',
+
+    #
+    #   Encrypted Key Bundle
+    #
+
+    'BytesMap',
+
+    'EncryptedBundle',
+    # 'EncryptedBundleExtension',
+    # 'EncryptedBundleHandler',
+    # 'bundle_handler',
+
+    'UserEncryptedBundle',
+
+    # 'DefaultBundleHandler',
+
+    ################################################################
+    #
+    #   Protocol
+    #
+    ################################################################
+
+    #
+    #   Ming-Ke-Ming
+    #
+
+    'EntityType',
+    # 'AccountExtensions',
+    # 'shared_account_extensions',
+
+    'Address', 'AddressFactory',
+    # 'AddressExtension',
+    # 'AddressHelper',
+    # 'address_helper',
+
+    'ID', 'IDFactory',
+    # 'IDExtension',
+    # 'IDHelper',
+    # 'id_helper',
+
+    'Meta', 'MetaFactory',
+    # 'MetaExtension',
+    # 'MetaHelper',
+    # 'meta_helper',
+
+    'TAI',
+    'Document', 'DocumentFactory',
+    # 'DocumentExtension',
+    # 'DocumentHelper',
+    # 'doc_helper',
+
+    'ANYWHERE', 'EVERYWHERE',
+    'ANYONE', 'EVERYONE', 'FOUNDER',
+    'Identifier',  # 'BroadcastAddress',
+
+    #
+    #   Dao-Ke-Dao
+    #
+
+    'Message',
+    # 'MessageExtensions',
+    # 'shared_message_extensions',
+
+    'Envelope', 'EnvelopeFactory',
+    # 'EnvelopeHelper',
+    # 'envelope_helper',
+
+    'InstantMessage', 'InstantMessageFactory',
+    # 'InstantMessageExtension',
+    # 'InstantMessageHelper',
+    # 'instant_helper',
+
+    'SecureMessage', 'SecureMessageFactory',
+    # 'SecureMessageExtension',
+    # 'SecureMessageHelper',
+    # 'secure_helper',
+
+    'ReliableMessage', 'ReliableMessageFactory',
+    # 'ReliableMessageExtension',
+    # 'ReliableMessageHelper',
+    # 'reliable_helper',
+
+    'Content', 'ContentFactory',
+    # 'ContentExtension',
+    # 'ContentHelper',
+    # 'content_helper',
+
+    #
+    #   Core Protocols
+    #
+
+    'ContentType',
+
+    'Command', 'CommandFactory',
+    # 'CommandExtension',
+    # 'CommandHelper',
+    # 'command_helper',
+
+    #
+    #   Message Implementations
+    #
+
+    'MessageEnvelope',
+
+    'BaseMessage',
+    'PlainMessage',
+    'EncryptedMessage',
+    'NetworkMessage',
+
+    ################################################################
+    #
+    #   Extensions
+    #
+    ################################################################
+
+    #
+    #   Format
+    #
+
+    'FormatExtensions',
+    'TransportableDataHelper',
+    'shared_format_extensions', 'ted_helper',
+
+    #
+    #   Crypto
+    #
+
+    'CryptoExtensions',
+    'shared_crypto_extensions',
+
+    'SymmetricKeyExtension',
+    'SymmetricKeyHelper',
+    'symmetric_helper',
+
+    'PublicKeyExtension',
+    'PublicKeyHelper',
+    'public_helper',
+
+    'PrivateKeyExtension',
+    'PrivateKeyHelper',
+    'private_helper',
+
+    #
+    #   Account
+    #
+
+    'AccountExtensions',
+    'shared_account_extensions',
+
+    'AddressExtension',
+    'AddressHelper',
+    'address_helper',
+
+    'IDExtension',
+    'IDHelper',
+    'id_helper',
+
+    'MetaExtension',
+    'MetaHelper',
+    'meta_helper',
+
+    'DocumentExtension',
+    'DocumentHelper',
+    'doc_helper',
+
+    #
+    #   General Extensions
+    #
+
+    'GeneralCryptoExtension',
+    'CryptoKeyHandler',
+    'crypto_handler',
+
+    'GeneralAccountExtension',
+    'AccountHandler',
+    'account_handler',
+
+    #
+    #   Bundle
+    #
+
+    'EncryptedBundleExtension',
+    'EncryptedBundleHandler',
+    'bundle_handler',
+
+    'DefaultBundleHandler',
+
+    #
+    #   Message
+    #
+
+    'MessageExtensions',
+    'shared_message_extensions',
+
+    'EnvelopeHelper',
+    'envelope_helper',
+
+    'InstantMessageExtension',
+    'InstantMessageHelper',
+    'instant_helper',
+
+    'SecureMessageExtension',
+    'SecureMessageHelper',
+    'secure_helper',
+
+    'ReliableMessageExtension',
+    'ReliableMessageHelper',
+    'reliable_helper',
+
+    'ContentExtension',
+    'ContentHelper',
+    'content_helper',
+
+    #
+    #   General Extensions
+    #
+
+    'MessageHandlerExtension',
+    'MessageHandler',
+    'message_handler',
+
+    #
+    #   Transportable File
+    #
+
+    'TransportableFileExtension',
+    'TransportableFileHelper',
+    'pnf_helper',
+
+    'TransportableFileWrapperExtension',
+    'pnf_wrapper_factory',
+
+    #
+    #   Command
+    #
+
+    'CommandExtension',
+    'CommandHelper',
+    'command_helper',
+
+    'GeneralCommandExtension',
+    'CommandHandler',
+    'command_handler',
+
+]

{dimp-2.4.3 → dimp-2.5.0}/dimp/crypto/__init__.py

@@ -28,10 +28,18 @@
 # SOFTWARE.
 # ==============================================================================
 
+"""
+    Cryptography
+    ~~~~~~~~~~~~
+
+    1. Crypto Keys
+    2. Data Digest
+    3. Data Format
+"""
+
 from mkm.digest import *
 from mkm.crypto import *
-
-from .algorithms import AsymmetricAlgorithms, SymmetricAlgorithms
+from dkd.crypto import *
 
 
 __all__ = [
@@ -42,28 +50,44 @@ __all__ = [
 
     'MessageDigester',
     'SHA256', 'KECCAK256', 'RIPEMD160',
-    'sha256', 'keccak256', 'ripemd160',
 
     #
     #   Crypto
     #
 
-    'CryptographyKey',
-    'EncryptKey', 'DecryptKey', 'SignKey', 'VerifyKey',
-    'SymmetricKey', 'AsymmetricKey',
-    'PrivateKey', 'PublicKey',
+    'CryptographyKey', 'EncryptKey', 'DecryptKey',
+    'AsymmetricKey', 'SignKey', 'VerifyKey',
+    # 'CryptoExtensions',
+    # 'shared_crypto_extensions',
 
-    'SymmetricKeyFactory', 'PrivateKeyFactory', 'PublicKeyFactory',
+    'SymmetricKey', 'SymmetricKeyFactory',
+    # 'SymmetricKeyExtension',
+    # 'SymmetricKeyHelper',
+    # 'symmetric_helper',
 
-    # 'SymmetricKeyHelper', 'PublicKeyHelper', 'PrivateKeyHelper',
+    'PublicKey', 'PublicKeyFactory',
+    # 'PublicKeyExtension',
+    # 'PublicKeyHelper',
+    # 'public_helper',
 
-    # 'SymmetricKeyExtension', 'PublicKeyExtension', 'PrivateKeyExtension',
-    # 'CryptoExtensions', 'shared_crypto_extensions',
+    'PrivateKey', 'PrivateKeyFactory',
+    # 'PrivateKeyExtension',
+    # 'PrivateKeyHelper',
+    # 'private_helper',
+
+    #
+    #   Encrypted Key Bundle
+    #
 
+    'BytesMap',
 
-    # ----------------------------------------------------------------
+    'EncryptedBundle',
+    # 'EncryptedBundleExtension',
+    # 'EncryptedBundleHandler',
+    # 'bundle_handler',
 
+    'UserEncryptedBundle',
 
-    'AsymmetricAlgorithms', 'SymmetricAlgorithms',
+    # 'DefaultBundleHandler',
 
 ]

{dimp-2.4.3/dimp/mkm → dimp-2.5.0/dimp/dkd}/__init__.py

@@ -3,7 +3,6 @@
 #   DIMP : Decentralized Instant Messaging Protocol
 #
 #                                Written in 2019 by Moky <albert.moky@gmail.com>
-#
 # ==============================================================================
 # MIT License
 #
@@ -28,55 +27,33 @@
 # SOFTWARE.
 # ==============================================================================
 
-from mkm.protocol import *
-from mkm.protocol.broadcast import BroadcastAddress, Identifier
-
-from ..protocol import MetaType
-from ..protocol import DocumentType
-from ..protocol import Visa, Bulletin
-
-from .meta import BaseMeta
-from .document import BaseDocument
-from .docs import BaseVisa, BaseBulletin
-
-
-__all__ = [
-
-    #
-    #   Protocol
-    #
-
-    'EntityType',
-    'Address', 'ID',
-    'Meta', 'TAI', 'Document',
-
-    'AddressFactory', 'IDFactory',
-    'MetaFactory', 'DocumentFactory',
 
-    'ANYWHERE', 'EVERYWHERE',
-    'ANYONE', 'EVERYONE', 'FOUNDER',
-    'BroadcastAddress', 'Identifier',
+"""
+    Dao-Ke-Dao
+    ~~~~~~~~~~
 
-    # 'AddressHelper', 'IDHelper',
-    # 'MetaHelper', 'DocumentHelper',
+    Universal Message Module
+"""
 
-    # 'AddressExtension', 'IDExtension',
-    # 'MetaExtension', 'DocumentExtension',
-    # 'AccountExtensions', 'shared_account_extensions',
+from .envelope import MessageEnvelope
 
+from .base import BaseMessage
+from .instant import PlainMessage
+from .secure import EncryptedMessage
+from .reliable import NetworkMessage
 
-    # ----------------------------------------------------------------
 
-
-    'MetaType',
-    'DocumentType',
-    'Visa', 'Bulletin',
+__all__ = [
 
     #
-    #   Implementations
+    #   Message Implementations
     #
 
-    'BaseMeta',
-    'BaseDocument', 'BaseVisa', 'BaseBulletin',
+    'MessageEnvelope',
+
+    'BaseMessage',
+    'PlainMessage',
+    'EncryptedMessage',
+    'NetworkMessage',
 
 ]

{dimp-2.4.3 → dimp-2.5.0}/dimp/dkd/base.py

@@ -53,15 +53,37 @@ from typing import Optional
 
 from mkm.types import DateTime
 from mkm.types import StrMap
-from mkm.types import Dictionary
 
 from mkm.protocol import ID
 from dkd.protocol import Envelope, Message
 
+from ..types import Dictionary
+
 
 class BaseMessage(Dictionary, Message):
+    """
+    Message with Envelope
+    ~~~~~~~~~~~~~~~~~~~~~
+
+    Base classes for messages
+    This class is used to create a message
+    with the envelope fields, such as 'sender', 'receiver', and 'time'
+
+    data format: {
+        //-- envelope
+        "sender"   : "moki@xxx",
+        "receiver" : "hulk@yyy",
+        "time"     : 123.45,
+
+        //-- body
+        ...
+    }
+    """
 
     def __init__(self, msg: StrMap = None, head: Envelope = None):
+        """Create a message with an existing envelope (shares its dictionary),
+        or decode from a network dictionary.
+        """
         if msg is None:
             # 1. new message with envelope
             assert head is not None, 'message envelope should not be empty'
@@ -82,6 +104,8 @@ class BaseMessage(Dictionary, Message):
             self.__envelope = env
         return env
 
+    # --------
+
     @property  # Override
     def sender(self) -> ID:
         return self.envelope.sender
@@ -101,14 +125,3 @@ class BaseMessage(Dictionary, Message):
     @property  # Override
     def type(self) -> Optional[str]:
         return self.envelope.type
-
-    @classmethod
-    def is_broadcast(cls, msg: Message) -> bool:
-        if msg.receiver.is_broadcast:
-            return True
-        # check exposed group
-        overt_group = msg.get('group')
-        if overt_group is None:
-            return False
-        group = ID.parse(identifier=overt_group)
-        return group is not None and group.is_broadcast