[Docs] [txt|pdf|xml|html] [Tracker] [Email] [Diff1] [Diff2] [Nits]

Versions: 00 01 02 03 04 05 06 07 08

Network Working Group                                    P. Hallam-Baker
Internet-Draft                                         Comodo Group Inc.
Intended status: Informational                           August 18, 2017
Expires: February 19, 2018


              Mathematical Mesh: Reference Implementation
                  draft-hallambaker-mesh-developer-03

Abstract

   The Mathematical Mesh ?The Mesh? is an end-to-end secure
   infrastructure that facilitates the exchange of configuration and
   credential data between multiple user devices.

   This document describes the Mesh reference code and how to install,
   run and make use of it in applications.  It does not form a part of
   the Mesh specifications and is not normative.

Status of This Memo

   This Internet-Draft is submitted in full conformance with the
   provisions of BCP 78 and BCP 79.

   Internet-Drafts are working documents of the Internet Engineering
   Task Force (IETF).  Note that other groups may also distribute
   working documents as Internet-Drafts.  The list of current Internet-
   Drafts is at http://datatracker.ietf.org/drafts/current/.

   Internet-Drafts are draft documents valid for a maximum of six months
   and may be updated, replaced, or obsoleted by other documents at any
   time.  It is inappropriate to use Internet-Drafts as reference
   material or to cite them other than as "work in progress."

   This Internet-Draft will expire on February 19, 2018.

Copyright Notice

   Copyright (c) 2017 IETF Trust and the persons identified as the
   document authors.  All rights reserved.

   This document is subject to BCP 78 and the IETF Trust's Legal
   Provisions Relating to IETF Documents
   (http://trustee.ietf.org/license-info) in effect on the date of
   publication of this document.  Please review these documents
   carefully, as they describe your rights and restrictions with respect
   to this document.  Code Components extracted from this document must
   include Simplified BSD License text as described in Section 4.e of



Hallam-Baker            Expires February 19, 2018               [Page 1]


Internet-Draft         Mathematical Mesh Developer           August 2017


   the Trust Legal Provisions and are provided without warranty as
   described in the Simplified BSD License.

Table of Contents

   1.  Definitions . . . . . . . . . . . . . . . . . . . . . . . . .   3
     1.1.  Requirements Language . . . . . . . . . . . . . . . . . .   3
     1.2.  Defined Terms . . . . . . . . . . . . . . . . . . . . . .   3
     1.3.  Related Specifications  . . . . . . . . . . . . . . . . .   3
     1.4.  Implementation Status . . . . . . . . . . . . . . . . . .   3
   2.  Getting the Reference Code and Build Tools  . . . . . . . . .   3
     2.1.  Obtaining the Development Environment . . . . . . . . . .   4
     2.2.  Obtaining the Build Tools . . . . . . . . . . . . . . . .   4
     2.3.  Obtaining the Mesh Source Libraries . . . . . . . . . . .   4
   3.  Running the Reference Code Examples . . . . . . . . . . . . .   5
     3.1.  Starting the Server . . . . . . . . . . . . . . . . . . .   5
     3.2.  The Profile Manager Wizard  . . . . . . . . . . . . . . .   5
     3.3.  The Profile Connection Wizard . . . . . . . . . . . . . .   6
   4.  Platform specific configuration data  . . . . . . . . . . . .   6
     4.1.  Windows . . . . . . . . . . . . . . . . . . . . . . . . .   6
       4.1.1.  Private Key Data  . . . . . . . . . . . . . . . . . .   6
       4.1.2.  Registry settings . . . . . . . . . . . . . . . . . .   6
       4.1.3.  Profile data files  . . . . . . . . . . . . . . . . .   7
     4.2.  OSX and Linux . . . . . . . . . . . . . . . . . . . . . .   7
   5.  Using the Mesh C#/.Net Libraries in an Application  . . . . .   7
     5.1.  Creating a Portal Client Connection . . . . . . . . . . .   7
     5.2.  Checking that a Portal Account name is acceptable . . . .   8
     5.3.  Creating a Personal Profile . . . . . . . . . . . . . . .   8
     5.4.  Creating an Offline Escrow Entry  . . . . . . . . . . . .   8
     5.5.  Publishing the Profile and Escrow Entries . . . . . . . .   8
     5.6.  Attaching a New Device  . . . . . . . . . . . . . . . . .   8
     5.7.  Attaching a new Application . . . . . . . . . . . . . . .   8
     5.8.  Deleting Profile Data . . . . . . . . . . . . . . . . . .   8
     5.9.  Recovering Profile Data . . . . . . . . . . . . . . . . .   8
   6.  Using other languages . . . . . . . . . . . . . . . . . . . .   8
     6.1.  Using the C Binding . . . . . . . . . . . . . . . . . . .   8
   7.  Implementation Status . . . . . . . . . . . . . . . . . . . .   8
     7.1.  Reference Implementation  . . . . . . . . . . . . . . . .   9
       7.1.1.  Coverage: . . . . . . . . . . . . . . . . . . . . . .   9
       7.1.2.  Licensing . . . . . . . . . . . . . . . . . . . . . .  10
       7.1.3.  Implementation Experience . . . . . . . . . . . . . .  10
       7.1.4.  Contact Info  . . . . . . . . . . . . . . . . . . . .  10
   8.  Security Considerations . . . . . . . . . . . . . . . . . . .  10
   9.  IANA Considerations . . . . . . . . . . . . . . . . . . . . .  10
   10. Acknowledgements  . . . . . . . . . . . . . . . . . . . . . .  10
   11. References  . . . . . . . . . . . . . . . . . . . . . . . . .  10
     11.1.  Normative References . . . . . . . . . . . . . . . . . .  10
     11.2.  Informative References . . . . . . . . . . . . . . . . .  11



Hallam-Baker            Expires February 19, 2018               [Page 2]


Internet-Draft         Mathematical Mesh Developer           August 2017


   Author's Address  . . . . . . . . . . . . . . . . . . . . . . . .  11

1.  Definitions

   This section presents the related specifications and standard, the
   terms that are used as terms of art within the documents and the
   terms used as requirements language.

1.1.  Requirements Language

   This document is not normative and does not contain requirements
   language

1.2.  Defined Terms

   The terms of art used in this document are described in the Mesh
   Architecture Guide [draft-hallambaker-mesh-architecture]
   [draft-hallambaker-mesh-architecture] .

1.3.  Related Specifications

   The architecture of the Mathematical Mesh is described in the Mesh
   Architecture Guide [draft-hallambaker-mesh-architecture]
   [draft-hallambaker-mesh-architecture] . The Mesh documentation set
   and related specifications are described in this document.

1.4.  Implementation Status

   The implementation status of the reference code base is described in
   the companion document [draft-hallambaker-mesh-developer]
   [draft-hallambaker-mesh-developer] .

2.  Getting the Reference Code and Build Tools

   The Mesh Reference library was developed using Visual Studio 2017
   Community Edition [VS2017] [VS2017] using PHB?s Build Tools [PHB2017]
   [PHB2017] extensions.  The reference code itself is currently limited
   to C# libraries.

   The code should in theory run under other operating systems but this
   has not been tested recently.

   Development under different development environments is also possible
   but would require re-engineering to make use of the line mode
   versions of the build tools.






Hallam-Baker            Expires February 19, 2018               [Page 3]


Internet-Draft         Mathematical Mesh Developer           August 2017


2.1.  Obtaining the Development Environment

   Visual Studio 2015 Community Edition is currently available at no
   cost for a wide range of non-commercial development including
   personal use and development of Open Source software.  For full
   details, please consult the license published by Microsoft.

   https://www.visualstudio.com/

                                 Figure 1

2.2.  Obtaining the Build Tools

   Over half the code in the reference code library is generated using
   code generators.  These are used to ensure that the specification,
   examples and reference code are always kept in synchronization.

   The build tools are published under an MIT License and are available
   in two forms:

   As stand-alone tools to be run from the command line.

   As a VSIX package that integrates into the Visual Studio environment.

   The source distribution is configured to use the tools integrated
   into the Visual Studio environment.  If development on other
   platforms is desired, the simplest approach is likely to be to write
   a tool that reads the Visual Studio configuration files and generates
   the corresponding files for use with make.

   The VSIX package is available from the Visual Studio extensions
   gallery:

   PHB Code Generation Tools

                                 Figure 2

   The source code for the build tools is available from:

   https://sourceforge.net/projects/phb-build-tools/

                                 Figure 3

2.3.  Obtaining the Mesh Source Libraries

   The Mesh reference library source code is published under an MIT
   license and is available from:




Hallam-Baker            Expires February 19, 2018               [Page 4]


Internet-Draft         Mathematical Mesh Developer           August 2017


   https://sourceforge.net/projects/mathematicalmesh/

                                 Figure 4

3.  Running the Reference Code Examples

   The reference code examples are designed to illustrate how the Mesh
   might be used in an application rather than be standalone tools in
   their own right.  The Mesh is designed to make it each for developers
   to add security to their own applications rather than providing the
   applications themselves.

3.1.  Starting the Server

   On the Windows platform, the server runs in the context of the
   platform Web server and must be granted permission to bind to the
   range of server addresses used using the netsh command.

   From a command prompt with administrator privileges, run the
   following command:

   netsh http add urlacl http://<domain>/.well-known/mmm/
       \user=<machine>\<user>

                                 Figure 5

   Where is the DNS domain name under which the service is run, is the
   Windows domain name of the machine and the account name.

   To start the service from the command line type:

   servermesh <domain>

                                 Figure 6

   The server does not require administration privileges.

3.2.  The Profile Manager Wizard

   The profile manager wizard demonstrates functions that are performed
   on an administration device.  These include creating a completely new
   profile and initial configuration of applications, connecting a
   device to the profile and recovery of the profile from escrow data.

   To run the client from the command line, place the executable image
   in a location that it will be found in the PATH variable and type:





Hallam-Baker            Expires February 19, 2018               [Page 5]


Internet-Draft         Mathematical Mesh Developer           August 2017


   meshclient

                                 Figure 7

3.3.  The Profile Connection Wizard

   The Profile connection wizard demonstrates the much more restricted
   functionality that would be required in a Mesh connected application
   and/or a profile manager for a non-administration device.

   To run the client from the command line, place the executable image
   in a location that it will be found in the PATH variable and type:

   meshconnect

                                 Figure 8

4.  Platform specific configuration data

4.1.  Windows

4.1.1.  Private Key Data

   All private key data is stored using the Windows public key store.
   At minimum, this ensures that private keys are obfuscated and
   encrypted under the account password to protect the data against
   casual extraction attacks.  On a machine with cryptographic hardware
   support such as a TPM or HSM, extraction of the private key may be
   infeasible without physical access to the machine and possibly
   require sophisticated diagnostic equipment.

4.1.2.  Registry settings

   Separate settings are used for production and test code.  Test Code
   should use the Registry Hive:

   HKEY_CURRENT_USER\SOFTWARE\CryptoMesh

   Production code should use the hive

   HKEY_CURRENT_USER\SOFTWARE\MathematicalMesh

   In either case the sub structure is:

      Contains the set of Mesh Portal Accounts for the user.  The
      default value is the account name of the default account.  The
      Name of the each key is a portal account name and the value a
      REG_SZ entry containing the UDF of the profile master key.



Hallam-Baker            Expires February 19, 2018               [Page 6]


Internet-Draft         Mathematical Mesh Developer           August 2017


      Contains the set of Mesh Profiles for the user.  The default value
      is the UDF of the default profile master key.  The Name of each
      key is the UDF of the master key and the value a REG_SZ entry
      containing the file location of the cached copy of the personal
      profile.

      Contains the set of Device profiles in the same format as the
      PersonalProfiles.

4.1.3.  Profile data files

   The profile data itself is stored in data files at the location
   specified in the registry.  The files are standard XML files in UTF8
   encoding.

4.2.  OSX and Linux

   [[Not yet implemented, subject to change.]

   All configuration information is stored in the user directory ~/.mmm

   Keys are stored in SSH key file format [RFC4716] [RFC4716] using the
   customary name and extension conventions for that application.

5.  Using the Mesh C#/.Net Libraries in an Application

   The application ExampleGenerator shows the use of the Mesh in an
   application using the convenience API.  It is the application program
   used to generate the examples in the reference document.

   ExampleGenerator implements a client that connects to a remote
   WebService, creates new personal profile with an escrow entry with
   offline recovery codes, attaches applications and other devices,
   updates an application profile, deletes all the profile data from the
   local machine and then restores them using the recovery codes and
   escrow entry.

5.1.  Creating a Portal Client Connection

   The normal method of creating a Portal Client connection is?

   Since the purpose of the ExampleGenerator is to create examples for
   the documentation, it is not necessary for the JSON Remote Procedure
   Calls to actually be ?Remote?. Instead the ?Local?  Procedure Call
   mode is used in which the client and server both run in the same
   process with the client API invoking the server dispatch methods
   through an interface that performs JSON serialization and
   deserialization but does not invoke the network transport.



Hallam-Baker            Expires February 19, 2018               [Page 7]


Internet-Draft         Mathematical Mesh Developer           August 2017


   ?.

   For purposes of testing and initial development of a Web Service it
   is frequently desirable to further simplify the implementation by
   dispensing with the serialization layer and the client calling the
   server dispatch methods directly.

   ?.

5.2.  Checking that a Portal Account name is acceptable

5.3.  Creating a Personal Profile

5.4.  Creating an Offline Escrow Entry

5.5.  Publishing the Profile and Escrow Entries

5.6.  Attaching a New Device

5.7.  Attaching a new Application

5.8.  Deleting Profile Data

5.9.  Recovering Profile Data

6.  Using other languages

   If you are building Mesh applications in another language, the least
   effort approach may be to rewrite the PROTOGEN build tool to target
   your language.

   Protogen does support generation of C header files that may be used
   to drive a parser.  If however you are adding Mesh support for an
   application that already uses JSON based protocols, you might want to
   edit the generator scripting files to generate code for your existing
   libraries.

6.1.  Using the C Binding

7.  Implementation Status

   This section records the status of known implementations of the
   protocol defined by this specification at the time of posting of this
   Internet-Draft, and is based on a proposal described in [RFC6892]
   [RFC6892] .  The description of implementations in this section is
   intended to assist the IETF in its decision processes in progressing
   drafts to RFCs.  Please note that the listing of any individual
   implementation here does not imply endorsement by the IETF.



Hallam-Baker            Expires February 19, 2018               [Page 8]


Internet-Draft         Mathematical Mesh Developer           August 2017


   Furthermore, no effort has been spent to verify the information
   presented here that was supplied by IETF contributors.  This is not
   intended as, and must not be construed to be, a catalog of available
   implementations or their features.  Readers are advised to note that
   other implementations may exist.

   According to [RFC6892] [RFC6892] , "this will allow reviewers and
   working groups to assign due consideration to documents that have the
   benefit of running code, which may serve as evidence of valuable
   experimentation and feedback that have made the implemented protocols
   more mature.  It is up to the individual working groups to use this
   information as they see fit".

7.1.  Reference Implementation

   Organization: Comodo Group Inc.

   Implementer: Phillip Hallam-Baker

   Maturity: Experimental Prototype

   This implementation was used to produce the reference section and all
   the examples in this document.  Since the conversion of specification
   to code is automatic, there is a high degree of assurance that the
   reference implementation is consistent with this document.

7.1.1.  Coverage:

   The draft-xx branch describes the code used to create version xx of
   this document.

   The main current limitations are that the code only supports RSA key
   pairs and for ease of development the server does not persist keys
   across sessions.  Nor does the implementation currently support the
   HTTP payload authentication and encryption layer or make use of TLS.
   These could be easily fixed.

   The client and server are implemented as libraries that may be called
   from a multi-protocol server.  A standalone server will be provided
   in a future release.

   Only the JSON encoding is currently implemented.  The JSON-B, JSON-C,
   ASN.1 and TLS Schema implementations are all supported by the code
   generation tool but not currently implemented as the build tool
   bindings for those encodings have not yet been finalized or
   documented.





Hallam-Baker            Expires February 19, 2018               [Page 9]


Internet-Draft         Mathematical Mesh Developer           August 2017


   The key restrictions for TLS key exchange have not yet been
   implemented.

   The code has only been tested on Windows 10 but passed compatibility
   testing for both Mono and dotNetCore 10 run times which should in
   theory permit use on Linux and OSX platforms.

7.1.2.  Licensing

   The code is released under an MIT License

   Source code is available from GitHub at
   https://github.com/hallambaker/Mathematical-Mesh

7.1.3.  Implementation Experience

   The implementation and specification documentation were developed in
   Visual Studio using the PHB Build Tools suite.

7.1.4.  Contact Info

   Contact Phillip Hallam-Baker phill@hallambaker.com

8.  Security Considerations

   Security Considerations are addressed in the companion document
   [draft-hallambaker-mesh-architecture]
   [draft-hallambaker-mesh-architecture]

9.  IANA Considerations

   This document specifies no actions for IANA

10.  Acknowledgements

   Comodo Group: Egemen Tas, Melhi Abdulhayo?lu, Rob Stradling, Robin
   Alden.

11.  References

11.1.  Normative References

   [RFC4716]  Galbraith, J. and R. Thayer, "The Secure Shell (SSH)
              Public Key File Format", RFC 4716, DOI 10.17487/RFC4716,
              November 2006.






Hallam-Baker            Expires February 19, 2018              [Page 10]


Internet-Draft         Mathematical Mesh Developer           August 2017


11.2.  Informative References

   [draft-hallambaker-mesh-architecture]
              Hallam-Baker, P., "Mathematical Mesh: Architecture",
              draft-hallambaker-mesh-architecture-03 (work in progress),
              May 2017.

   [draft-hallambaker-mesh-developer]
              Hallam-Baker, P., "Mathematical Mesh: Developer's Guide",
              draft-hallambaker-mesh-developer-02 (work in progress),
              September 2016.

   [PHB2017]  "[Reference Not Found!]".

   [RFC6892]  Wilde, E., "The 'describes' Link Relation Type", RFC 6892,
              DOI 10.17487/RFC6892, March 2013.

   [VS2017]   "[Reference Not Found!]".

Author's Address

   Phillip Hallam-Baker
   Comodo Group Inc.

   Email: philliph@comodo.com


























Hallam-Baker            Expires February 19, 2018              [Page 11]


Html markup produced by rfcmarkup 1.129c, available from https://tools.ietf.org/tools/rfcmarkup/