# mpemtrans

Mystic PEM certificate conversion, based on
[amenonsen/pemtrans](https://github.com/amenonsen/pemtrans). The original explicit
permission is retained in the C header and LICENSE.

Status: development prototype. The Linux converter has created and reopened
synthetic RSA keysets with cryptlib 3.4.5 and the tested generic 3.4.9.6 build.
Native Windows qualification and native Mystic handshake tests
are tracked separately in each release report. An isolated Linux Mystic A49
BinkP TLS 1.2 test has verified the exact converted certificate, CA/hostname
validation and encrypted BinkP framing with cryptlib 3.4.5. Synthetic single-certificate,
fullchain and encrypted PKCS#8 conversion tests are included in the test suite. Published preview archives are not production-qualified releases.

## What it does

The converter reads a PEM private key and a matching certificate/full chain,
imports them through the explicitly selected cryptlib and creates a new PKCS#15
keyset. It reopens that keyset and retrieves the private key before publishing
it. Existing output files are never replaced. The tool does not install or
restart Mystic, obtain certificates, or change server configuration.

Current key scope: RSA, 2048–4096 bits; PKCS#1 or PKCS#8 private-key input.
ECDSA private keys are rejected in this prototype. An RSA private key and its
matching certificate are required. Issuer relationships and certificate dates
are checked; this is not a substitute for validating public CA trust.

The 3.4.5 and 3.4.9.6 public headers were compared for the used API constants and
RSA structure layout. Session attributes are not used. A newer cryptlib being
usable by this converter does not prove it is compatible with an old Mystic
binary. Always select the intended library explicitly.

## Linux

The Linux tar.gz contains only `mpemtrans` and `README.txt`. Extract beside
Mystic, normally `/opt/mystic`, or another chosen location. No DEB installation,
PATH update or separate manpage is needed. The target cryptlib is an external
prerequisite; it is not bundled or replaced by this tool.

Prepare a nonempty output-password file. Use a strong password for general
keysets; cryptlib enforces its supported password constraints. Mystic A49's
native keyset interface expects a fixed legacy label/password, so an arbitrary
label or password produces a keyset Mystic cannot open. Use the matching Mystic
profile when preparing `data/ssl.cert`; no vendor password is printed here.
Protect it so only its owner can read it (`chmod 600 output-password.txt`). Do
not put the password directly on the command line.

```sh
./mpemtrans \
  --library /absolute/path/to/libcl.so.3.4.5 \
  --key privkey.pem \
  --cert fullchain.pem \
  --out server-new.p15 \
  --label ssl_cert \
  --password-file output-password.txt
```

On Linux, `--library` is optional. Without it, the directory of the actual executable
(resolved through `/proc/self/exe`, including when invoked through a symlink)
is searched first for `libcl.so`, `libcl.so.3`, `libcl.so.3.4.5`, then
`libcl.so.3.4.9`. Only after those local names are absent does discovery use
the same names through the system loader's configured library paths.
The first located library must pass the API/version checks; an incompatible
installation does not trigger silent switching. The working directory is not
scanned. Normal loader configuration, including an explicitly configured
`LD_LIBRARY_PATH`, applies. If loading fails, the error asks for an explicit
`--library /absolute/path/to/library`. Windows discovery is described below.

An explicit library path must be absolute. Select a tested newer cryptlib with the same
option when preparing a keyset for that version. If an input PEM is encrypted,
provide its separate protected file with `--input-password-file FILE`; otherwise
no interactive prompt is issued.

## Windows

The Windows ZIP contains only `mpemtrans.exe` and `README.txt`. Extract into a
chosen short ASCII path, normally `C:\Mystic`. There is no MSI or global PATH
change. Use the cryptlib DLL matching the executable architecture; existing
Mystic x86/x64 builds conventionally use `cl32.dll` / `cl64.dll` respectively.
Without `--library`, Windows searches for `cl32.dll` (x86) or `cl64.dll`
(x64) beside `mpemtrans.exe`, then in the Windows system directory returned by
`GetSystemDirectory`. It does not search the working directory or PATH. The
first located library must pass qualification; `--library` selects an explicit
absolute path instead. If loading fails, the error asks for that option.
Do not copy a different DLL over a working Mystic library to test this tool.

Example from PowerShell:

```powershell
./mpemtrans.exe --library 'C:\Mystic\cl64.dll' --key 'privkey.pem' --cert 'fullchain.pem' --out 'server-new.p15' --label 'ssl_cert' --password-file 'output-password.txt'
```

Create the password file through your preferred secure editor and restrict its
ACL to the intended account, SYSTEM and administrators. Passwords are read from
files, not printed or included in process arguments. The prototype uses Windows
ANSI file APIs, so short ASCII file paths are required for now.

## Output and checks

A private temporary directory is created beside the destination, and the new
keyset is written there. Linux uses owner-only permissions; Windows uses an
explicit protected directory ACL. The completed keyset is reopened through the
selected cryptlib before publication under the requested name without replacing
an existing file. Source keys and certificates are not changed.

A successful conversion exits with 0. Failure exits nonzero and reports the
operation stage without printing private key material or passwords. Keep the
current server certificate until a separate native Mystic test succeeds. Do
not infer a usable TLS configuration merely from a .p15 filename.

## Source and distribution

`make CRYPTLIB_INCLUDE=/path/to/headers` builds a Linux development executable.
Linux builds link the distribution's OpenSSL 3 libcrypto dynamically. Build on
the oldest supported distribution and test the identical executable on all
supported targets; the OpenSSL major version alone does not qualify glibc or
symbol requirements.

Windows builds link OpenSSL 3 libcrypto and the MSVC runtime statically. No
separate OpenSSL installation or OpenSSL DLL is required. The Windows workflow
uses vcpkg's x86-windows-static / x64-windows-static triplets, inspects executable
imports and assembles the applicable dependency notices into README.txt.
Bundled OpenSSL security fixes require rebuilding and redistributing the EXE.
The external cryptlib DLL is still required. This build arrangement does not
replace native conversion and Mystic handshake qualification.
The selected cryptlib is loaded at runtime, not linked into the program.

The old Unix manpage has been retired from the active root. Its content is
retained only as a source reference under `docs/upstream-manpage-reference.txt`;
this README replaces it for both platforms. The maintained implementation stays in the original `pemtrans.c` file.
Its upstream version and subsequent changes remain available through Git history;
the executable is named `mpemtrans`.

Tool code, builds and tests belong here. Mystic installation/configuration is
maintained in mysticd; theme artwork belongs to mystic-theme. Release archives
must contain exactly one executable and README.txt, with checksums and source
published separately. Windows support is not claimed until native tests pass.


TOOL LICENSE
pemtrans

Copyright 2004 Abhijit Menon-Sen <ams@toroid.org>
Use, modification, and distribution of pemtrans is allowed without
any limitations. There is no warranty, express or implied.

The original notice is retained at the beginning of pemtrans.c.
New adaptations in this fork use the same permission unless otherwise stated.


OPENSSL NOTICES

                                 Apache License
                           Version 2.0, January 2004
                        https://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

