2007-06-08 Jonathan Pobst <monkey@jpobst.com>
[mono.git] / web / crypto
index 09546eaa135e9d23b8c8761dad8e145092c43389..56fbde78316e3f083ccb3948acc992ef7ce563bb 100644 (file)
@@ -1,7 +1,8 @@
 * Cryptography
 
        In the .NET framework cryptography can be found under a number of
-       namespaces in several assemblies.
+       namespaces in several assemblies. Mono also has it's own assemblies
+       to provide missing security functionalities from the .NET framework.
 
 ** Assembly: corlib
 
 
 **** Status
        <ul>
-               * Every classes are present.
+               * All classes are present. Most of them have (minimal) 
+                 documentation in <b>monodoc</b>.
 
                * Most classes have their unit tests. Some tests like <code>
                  SymmetricAlgorithmTest</code> are generated by external 
                  tools.
-
-               * MACTripleDES is compatible with the implementation shipped in
-                 framework 1.0. Version 1.1 gives different results when the
-                 MACed data is a multiple of BlockSize (8 bytes).
        </ul>
 
-**** TODO
-       <ul>
-               * RNGCryptoServiceProvider is currently only working on Linux.
-                 The current implementation reside in Mono's runtime and use 
-                 the <code>/dev/[u]random</code> device (which do not exists 
-                 under Windows). A Windows specific alternative is available 
-                 using the Mono.Security.Win32 assembly.
-
-               * Keypair persistance for RSA and DSA. This persistance must
-                 somehow be linked with X509 certificate stores (in planning).
-
-               * <code>PasswordDeriveBytes.CryptDeriveKey</code> is included 
-                 in MS BCL to provide compatibility with existing Windows 
-                 applications. The main problem is that the key derivation 
-                 algorithm can be different for every CSP (Crypto Service 
-                 Provider). However for compatibility we should provide an
-                 implementation compatible with the MS CSP (most likely used).
-       </ul>
-
-**** Notes
-       <ul>
-               * All cryptographic algorithms are entirely managed, including 
-                 classes named <code>*CryptoServiceProvider</code>, with the 
-                 exception of <code>RNGCryptoServiceProvider</code> (which 
-                 implementation resides in the runtime).
-
-               * There is a bug in the <code>PKCS1MaskGenerationMethod</code>
-                 class (in both framework 1.0 and 1.1). This means our 
-                 implementation isn't compatible with MS (but is compatible with
-                 PKCS#1 v.2.1). However we get OAEP padding for every platform!
-
-               * Look at assembly Mono.Security.Win32 if you require more
-                 compatiblity with the Microsoft implementation (like accessing
-                 a particuliar keypair container inside a specific CSP).
-       </ul>
-
-
 *** Namespace: <b>System.Security.Cryptography.X509Certificates</b>
 
 **** Status
@@ -67,8 +28,8 @@
                  (using the Mono.Security.ASN1 class). 
 
                * Software Publisher Certificates (SPC) used by Authenticode
-                 (tm) to sign assemblies are supported (extraction from PE 
-                 files) but <b>not yet</b> validated.
+                 (tm) to sign assemblies are supported and <b>minimally</b>
+                 validated.
 
                * Unit tests are generated from a set of existing certificates
                  (about a dozen) each having different properties. Another
                  size and time consideration, i.e. a 7.5Mb C# source file).
        </ul>
 
-**** TODO
-       <ul>
-               * Authenticode(tm) support is incomplete. We can extract the
-                 certificates from PE files but cannot validate the signature
-                 nor the certificate chain (and we're still missing some trust
-                 anchors). See Tools section for more information.
-       </ul>
-
 **** Notes
        <ul>
-               * Except for their structure <b>there are no validation of the
-                 certificates</b> done by this class (this is by design and 
-                 isn't a restriction of Mono!). This means that certificate 
-                 signatures and validity dates are <b>never</b> checked 
-                 (except when used for Authenticode, i.e. 
-                 <code>CreateFromSignedFile</code>).
-
-               * The newer X509Certificate class included in Microsoft's Web 
-                 Service Enhancement (WSE) is a little better (as it includes 
-                 CryptoAPI's validation) when <code>IsCurrent</code> is called.
-                 See assembly <b>Microsoft.Web.Services</b> for more details.
-
                * The class Mono.Security.X509.X509Certificate (in Mono.Security 
                  assembly) is becoming a much better alternative - and will 
                  continue to evolve to support the security tools.
-
-               * Microsoft implementation of <code>X509Certificate</code> is 
-                 done by using CryptoAPI (unmanaged code). From the exceptions 
-                 thrown Authenticode(tm) support is done via COM.
        </ul>
 
 <hr>
 
 **** Status
        <ul>
-               * All classes are present but some Transforms are only stubbed. 
-
-               * We now have a fully managed C14N implementation.
-
-               * Most classes have their unit tests.
-       </ul>
-
-**** TODO
-       <ul>
-               * Complete all Transform derived classes.
+               * We pass the fifteen tests from Merlin's xmldsig suite with
+               success. Which is funny because Microsoft fails in one case 
+               where both a X509Certificate and an X509CRL are present in
+               an X509Data. We also pass most Phaos tests.
+
+               * Most classes have their unit tests. Some standalone tests 
+               are also in CVS to test C14N and both Merlin and Phaos test
+               suites.
        </ul>
 
 <hr>
        </ul>
 *** Namespace: Mono.Security.Cryptography
        <ul>
-               * Additional algorithms: MD2, ARCFOUR (required for SSL)
+               * Additional algorithms: MD2, MD4, ARCFOUR (required for SSL)
                * Convertion helpers
        </ul>
-*** Namespace: Mono.Security.X509
+*** Namespace: Mono.Security.Protocol.*
        <ul>
-               * X.509 structures (certificate, CRL...) building and decoding.
+               * Tls: An 100% managed SSLv3 and TLSv1 implementation from 
+               Carlos Guzman Alvarez.
+               * Ntlm: NTLM authentication (used for HTTP and SQL Server).
        </ul>
-*** Namespace: Mono.Security.X509.Extensions
+*** Namespace: Mono.Security.X509.*
        <ul>
+               * X.509 structures (certificate, CRL...) building and decoding.
+               * PKCS#12 decoding and encoding.
                * X.509 extensions (from public X.509 to private PKIX, Netsapce, 
                  Microsoft, Entrust...).
        </ul>
 
 **** Status
        <ul>
-               * Some part of the work has not yet been commited (still cleaning up).
-
                * A big part of this assembly is also included inside Mono's
                  corlib. The classes are duplicated in this assembly so the 
                  functionalities can be used without a dependency on Mono's 
                  corlib (which depends on Mono's runtime).
 
                * Unit test coverage isn't (yet) complete.
+
+               * Most classes have minimal documentation available in
+                 <b>monodoc</b>.
        </ul>
 
 <hr>
 
 **** Status
        <ul>
-               * A RNGCryptoServiceProvider built on top of CryptoAPI. This
-                 allows Windows users to get around the limitation of the 
-                 runtime RNG (which requires <code>/dev/[u]random/</code>).
+               * A RNGCryptoServiceProvider built on top of CryptoAPI.
 
                * Wrapper classes for unmanaged versions of hash algorithms:
                  MD2, MD4, MD5 and SHA1 are supported. <b>note</b>: some 
                  algorithms shouldn't be used in new design (MD4 is broken, 
                  MD2 and MD5 aren't considered safe for some usage). They are 
                  included to preserve interoperability with older applications
-                 (e.g. some old, but still valid, X.509 certificates use MD2).
+                 (e.g. some old, but still valid, X.509 certificates use MD2,
+                 MD4 is required for NTLM authentication ...).
+
+               * Classes have minimal documentation available in
+                 <b>monodoc</b>.
        </ul>
 
 **** TODO
        <a href="http://www.oasis-open.org/committees/wss/">OASIS</a> or
        other committees.
 
-       <b>[*] There are some licensing issues to consider before starting to 
-       implement WS-Security. All contributors must sign an agreement with 
-       Microsoft before commiting anything related to WS-Security into CVS.
-       </b>
+*** Namespace: Microsoft.Web.Services.Security
+
+**** Status
+       <ul>
+               * Most WSE 1.0 classes are implemented.
+       </ul>
+
+**** TODO
+       <ul>
+               * Some classes from System.Security assembly need to be 
+               duplicated (and somewhat fixed) in WSE for XMLDSIG.
+
+               * There are still missing classes and <b>many</b> missing
+               unit tests.
+       </ul>
+
 
-*** Namespace: Microsoft.Web.Services.Security [*]
-*** Namespace: Microsoft.Web.Services.Timestamp [*]
+*** Namespace: Microsoft.Web.Services.Timestamp
 
 **** Status
        <ul>
-               * Nothing (yet) commited in CVS <b>[*]</b>.
+               * This seems complete for WSE 1.0 but some new classes were 
+               introduced in WSE 2.0.
        </ul>
 
 *** Namespace: Microsoft.Web.Services.Security.X509
 
 **** Status
        <ul>
-               * Nothing (yet) commited in CVS. However the classes in this 
-                 namespace are outside WS-Security scope. So development, for 
-                 those classes, could be done without signing this agreement.
+               * X509Certificate support is complete for both WSE 1.0 and 2.0.
        </ul>
 
 **** TODO
 
 *** Notes
        <ul>
-               * Microsoft has <a href="http://microsoft.com/downloads/details.aspx?FamilyId=21FB9B9A-C5F6-4C95-87B7-FC7AB49B3EDD&displaylang=en">released</a>
-               a technical preview of WSE 2.
+               * Microsoft has released WSE 2.
        </ul>
 
 <hr>
 ** Tools
 
        There are many tools in the .NET framework that indirectly interacts 
-       with some cryptographic classes. Mono will eventually need these tools.
-       Unless noted the tools should work on any CLR (tested with both Mono 
-       and Microsoft).
+       with some cryptographic classes. Unless noted the tools should work on
+       any CLR (tested with both Mono and Microsoft).
 
 **** Status
 
-       The following tools are complete (mostly complete):
+       The following tools are complete (or mostly complete):
        <ul>
                * <code>secutil</code> is a tool to extract certificates and 
                  strongnames from assemblies in a format that can be easily 
                * <code>makecert</code> to create X.509 test certificates that 
                  can be used (once transformed in SPC) to sign assemblies. It's
                  now possible to generate SSL certificates for web servers.
+
+               * <code>sn</code> is a clone of the <code>sn</code> to manage
+                 strongnames. Current version can create, convert, sign and
+                 verify strongnames signatures. Some configuration options 
+                 are still missing, some will only works with Mono.
+
+               * <code>signcode</code> and <code>chktrust</code> for signing 
+                 and validating Authenticode(tm) signatures on assemblies (or 
+                 any PE file) are now working (signature and timestamps) but 
+                 some options aren't yet supported.
+
+               * <code>setreg</code> can change some cryptographic parameters
+               of the runtime. Currently it can add or remove two root test
+               certificates (the one used by Mono's <code>makecert</code>, 
+               the other used by Microsoft's <code>makecert</code>).
+
+               * <code>certmgr</code> can add and remove certificates from 
+               the stores. Most common use is to add new trusted certificates
+               or remove them.
        </ul>
 
        Somewhat usable, somewhat incomplete:
                  <code>System.Windows.Forms</code> (right now only working on 
                  Windows), while <code>gcertview</code> is the same viewer 
                  implemented for GTK# (working on both Windows and Linux).
-
-               * <code>sn</code> is a clone of the <code>sn</code> to manage
-                 strongnames. Current version is limited to creating new keypairs
-                 and converting values.
-
-               * <code>monosn</code> is a clone of the <code>sn</code> to manage
-                 strongnames. This tools is part of the runtime (not the class
-                 library) and as such is written in C and won't run without Mono.
        </ul>
 
 
 **** TODO
        The following tools are still missing or largely incomplete:
        <ul>
-
-               * <code>signcode</code> and <code>chktrust</code> (in progress)
-                 for signing and validating Authenticode(tm) signatures on 
-                 assemblies (or any PE file).
-
                * Other tools like a, GUI-based, certificate manager...
        </ul>
 
        tools are of limited use until supported by the runtime.
 
 <hr>
-** Other stuff
+** References
 
        <ul>
-               * SSL/TLS for secure communication (a prototype is under way).
-                 Some work is already visible in Mono.Security assembly (e.g. 
-                 RC4, RSAManaged ...).
+               * RSA Laboratories' <a href="http://www.rsasecurity.com/rsalabs/faq/index.html">
+               Frequently Asked Questions</a> About Today's Cryptography, Version 4.1
+
+               * Public-Key Cryptography Standards (<a href="http://www.rsasecurity.com/rsalabs/pkcs/index.html">
+               PKCS</a>)
+
+               * National Institute of Standards and Technology - Federal 
+               Information Processing Standards <a href="http://csrc.nist.gov/publications/fips/index.html">
+               NIST FIPS</a>
        </ul>
 
-<hr>   
+<hr>
 ** How to Help
 
        <ul>
                  (using the unit tests) carefully - it's so fast to break an
                  algorithm ;-).
 
-               * Write some documentation on the cryptographic classes for 
-                 <b>monodoc</b> as I'm not a very good writer (at least in English).
+               * Write some documentation or add some sample code for the 
+                 cryptographic classes in <b>monodoc</b>.
        </ul>
-
-       Contact Sebastien Pouliot (<a href="mailto:spouliot@videotron.ca">home</a>
-       , <a href="mailto:spouliot@motus.com">work</a>) if you need additional
-       informations about the status of the cryptographic classes.
-
 <hr>
-Last reviewed: August 9, 2003 (post mono 0.25)
+Last reviewed: June 26, 2004 (mono release candidate 1)