Update documentation

Author: svedi

README.md

@@ -102,7 +102,9 @@ library. We currently support the following `Configurations` and `MachineCodeCom
 
 | MachineCodeComputer             | Description                                     |
 | ------------------------------- | ----------------------------------------------- |
-| `MachineCodeComputer_static`    | Does not automatically compute a machine code, instead the machine code is set by calling a function |
+| `MachineCodeComputer_COM` | Works on Windows and computes a machine code using functionallity provided through COM. |
+| `MachineCodeComputer_static` | Does not automatically compute a machine code, instead the machine code is set by calling `set_machine_code()`. |
+| `MachineCodeComputer_SystemdDBusInodes_SHA256` | Works on Linux systems and computes a machine code based on information provided by Systemd, DBus and the filesystem. |
 
 The next step is to create and set up a handle class responsible for making requests
 to the Cryptolens Web API.
@@ -117,6 +119,7 @@ Cryptolens cryptolens_handle(e);
 cryptolens_handle.signature_verifier.set_modulus_base64(e, "ABCDEFGHI1234");
 cryptolens_handle.signature_verifier.set_exponent_base64(e, "ABCD");
 
+// This line is only for MachineCodeComputer_static and sets the machine code to a static value
 cryptolens_handle.machine_code_computer.set_machine_code(e, "289jf2afs3");
 ```
 

examples/VisualStudio/Example_Activate/Example_Activate.cpp

@@ -6,6 +6,12 @@
 #include <cryptolens/MachineCodeComputer_static.hpp>
 
 namespace cryptolens = ::cryptolens_io::v20190401;
+
+// Set up an alias for the handler class used to interact with the library. This configuration checks the expiry date
+// on the license. Use Configuration_Windows_IgnoreExpires to ignore the expiry date.
+//
+// For this example we use MachineCodeComputer_static where the machine code is set using set_machine_code(). Other
+// ways of computing the machine code are available, see README.md.
 using Cryptolens = cryptolens::basic_Cryptolens<cryptolens::Configuration_Windows<cryptolens::MachineCodeComputer_static>>;
 
 /*
@@ -18,10 +24,11 @@ int main()
 	Cryptolens cryptolens_handle(e);
 
 	// Setting up the signature verifier with credentials from "Security Settings"
-	// on serialkeymanager.com
+	// on cryptolens.io
 	cryptolens_handle.signature_verifier.set_modulus_base64(e, "khbyu3/vAEBHi339fTuo2nUaQgSTBj0jvpt5xnLTTF35FLkGI+5Z3wiKfnvQiCLf+5s4r8JB/Uic/i6/iNjPMILlFeE0N6XZ+2pkgwRkfMOcx6eoewypTPUoPpzuAINJxJRpHym3V6ZJZ1UfYvzRcQBD/lBeAYrvhpCwukQMkGushKsOS6U+d+2C9ZNeP+U+uwuv/xu8YBCBAgGb8YdNojcGzM4SbCtwvJ0fuOfmCWZvUoiumfE4x7rAhp1pa9OEbUe0a5HL+1v7+JLBgkNZ7Z2biiHaM6za7GjHCXU8rojatEQER+MpgDuQV3ZPx8RKRdiJgPnz9ApBHFYDHLDzDw==");
 	cryptolens_handle.signature_verifier.set_exponent_base64(e, "AQAB");
 
+        // This line is only for MachineCodeComputer_static and sets the machine code to a static value
 	cryptolens_handle.machine_code_computer.set_machine_code(e, "289jf2afs3");
 
 	cryptolens::optional<cryptolens::LicenseKey> license_key =

examples/VisualStudio/Example_External/Example_External.cpp

@@ -6,6 +6,12 @@
 #include <cryptolens/MachineCodeComputer_static.hpp>
 
 namespace cryptolens = ::cryptolens_io::v20190401;
+
+// Set up an alias for the handler class used to interact with the library. This configuration checks the expiry date
+// on the license. Use Configuration_Windows_IgnoreExpires to ignore the expiry date.
+//
+// For this example we use MachineCodeComputer_static where the machine code is set using set_machine_code(). Other
+// ways of computing the machine code are available, see README.md.
 using Cryptolens = cryptolens::basic_Cryptolens<cryptolens::Configuration_Windows<cryptolens::MachineCodeComputer_static>>;
 
 /*
@@ -23,6 +29,7 @@ int main()
 	cryptolens_handle.signature_verifier.set_modulus_base64(e, "khbyu3/vAEBHi339fTuo2nUaQgSTBj0jvpt5xnLTTF35FLkGI+5Z3wiKfnvQiCLf+5s4r8JB/Uic/i6/iNjPMILlFeE0N6XZ+2pkgwRkfMOcx6eoewypTPUoPpzuAINJxJRpHym3V6ZJZ1UfYvzRcQBD/lBeAYrvhpCwukQMkGushKsOS6U+d+2C9ZNeP+U+uwuv/xu8YBCBAgGb8YdNojcGzM4SbCtwvJ0fuOfmCWZvUoiumfE4x7rAhp1pa9OEbUe0a5HL+1v7+JLBgkNZ7Z2biiHaM6za7GjHCXU8rojatEQER+MpgDuQV3ZPx8RKRdiJgPnz9ApBHFYDHLDzDw==");
 	cryptolens_handle.signature_verifier.set_exponent_base64(e, "AQAB");
 
+        // This line is only for MachineCodeComputer_static and sets the machine code to a static value
 	cryptolens_handle.machine_code_computer.set_machine_code(e, "289jf2afs3");
 
 	// Reply from Cryptolens Web API

examples/VisualStudio/Example_Floating/Example_Floating.cpp

@@ -6,6 +6,12 @@
 #include <cryptolens/MachineCodeComputer_static.hpp>
 
 namespace cryptolens = ::cryptolens_io::v20190401;
+
+// Set up an alias for the handler class used to interact with the library. This configuration checks the expiry date
+// on the license. Use Configuration_Windows_IgnoreExpires to ignore the expiry date.
+//
+// For this example we use MachineCodeComputer_static where the machine code is set using set_machine_code(). Other
+// ways of computing the machine code are available, see README.md.
 using Cryptolens = cryptolens::basic_Cryptolens<cryptolens::Configuration_Windows<cryptolens::MachineCodeComputer_static>>;
 
 /*
@@ -22,6 +28,7 @@ void activate(char const* machine_code)
 	cryptolens_handle.signature_verifier.set_modulus_base64(e, "khbyu3/vAEBHi339fTuo2nUaQgSTBj0jvpt5xnLTTF35FLkGI+5Z3wiKfnvQiCLf+5s4r8JB/Uic/i6/iNjPMILlFeE0N6XZ+2pkgwRkfMOcx6eoewypTPUoPpzuAINJxJRpHym3V6ZJZ1UfYvzRcQBD/lBeAYrvhpCwukQMkGushKsOS6U+d+2C9ZNeP+U+uwuv/xu8YBCBAgGb8YdNojcGzM4SbCtwvJ0fuOfmCWZvUoiumfE4x7rAhp1pa9OEbUe0a5HL+1v7+JLBgkNZ7Z2biiHaM6za7GjHCXU8rojatEQER+MpgDuQV3ZPx8RKRdiJgPnz9ApBHFYDHLDzDw==");
 	cryptolens_handle.signature_verifier.set_exponent_base64(e, "AQAB");
 
+        // This line is only for MachineCodeComputer_static and sets the machine code to a static value
 	cryptolens_handle.machine_code_computer.set_machine_code(e, machine_code);
 
 	cryptolens::optional<cryptolens::LicenseKey> license_key =

examples/VisualStudio/Example_Offline/Example_Offline.cpp

@@ -9,6 +9,12 @@
 #include <cryptolens/MachineCodeComputer_static.hpp>
 
 namespace cryptolens = ::cryptolens_io::v20190401;
+
+// Set up an alias for the handler class used to interact with the library. This configuration checks the expiry date
+// on the license. Use Configuration_Windows_IgnoreExpires to ignore the expiry date.
+//
+// For this example we use MachineCodeComputer_static where the machine code is set using set_machine_code(). Other
+// ways of computing the machine code are available, see README.md.
 using Cryptolens = cryptolens::basic_Cryptolens<cryptolens::Configuration_Windows<cryptolens::MachineCodeComputer_static>>;
 
 /*
@@ -58,6 +64,7 @@ int write_license_key_to_file(LPCWSTR file_name)
 	cryptolens_handle.signature_verifier.set_modulus_base64(e, "khbyu3/vAEBHi339fTuo2nUaQgSTBj0jvpt5xnLTTF35FLkGI+5Z3wiKfnvQiCLf+5s4r8JB/Uic/i6/iNjPMILlFeE0N6XZ+2pkgwRkfMOcx6eoewypTPUoPpzuAINJxJRpHym3V6ZJZ1UfYvzRcQBD/lBeAYrvhpCwukQMkGushKsOS6U+d+2C9ZNeP+U+uwuv/xu8YBCBAgGb8YdNojcGzM4SbCtwvJ0fuOfmCWZvUoiumfE4x7rAhp1pa9OEbUe0a5HL+1v7+JLBgkNZ7Z2biiHaM6za7GjHCXU8rojatEQER+MpgDuQV3ZPx8RKRdiJgPnz9ApBHFYDHLDzDw==");
 	cryptolens_handle.signature_verifier.set_exponent_base64(e, "AQAB");
 
+        // This line is only for MachineCodeComputer_static and sets the machine code to a static value
 	cryptolens_handle.machine_code_computer.set_machine_code(e, "289jf2afs3");
 
 	cryptolens::optional<cryptolens::LicenseKey> license_key =

examples/unix/example_activate.cpp

@@ -9,13 +9,17 @@
 
 namespace cryptolens = ::cryptolens_io::v20190401;
 
+// Set up an alias for the handler class used to interact with the library. This configuration checks the expiry date
+// on the license. Use Configuration_Unix_IgnoreExpires to ignore the expiry date.
+//
+// For this example we use MachineCodeComputer_static where the machine code is set using set_machine_code(). Other
+// ways of computing the machine code are available, see README.md.
 using Cryptolens = cryptolens::basic_Cryptolens<cryptolens::Configuration_Unix<cryptolens::MachineCodeComputer_static>>;
 
 /*
  * This example uses the basic_Cryptolens class to make a request to the WebAPI
  * and then checks some properties of the license keys.
  */
-
 int main()
 {
   curl_global_init(CURL_GLOBAL_SSL);
@@ -26,6 +30,8 @@ int main()
   // on cryptolens.io
   cryptolens_handle.signature_verifier.set_modulus_base64(e, "khbyu3/vAEBHi339fTuo2nUaQgSTBj0jvpt5xnLTTF35FLkGI+5Z3wiKfnvQiCLf+5s4r8JB/Uic/i6/iNjPMILlFeE0N6XZ+2pkgwRkfMOcx6eoewypTPUoPpzuAINJxJRpHym3V6ZJZ1UfYvzRcQBD/lBeAYrvhpCwukQMkGushKsOS6U+d+2C9ZNeP+U+uwuv/xu8YBCBAgGb8YdNojcGzM4SbCtwvJ0fuOfmCWZvUoiumfE4x7rAhp1pa9OEbUe0a5HL+1v7+JLBgkNZ7Z2biiHaM6za7GjHCXU8rojatEQER+MpgDuQV3ZPx8RKRdiJgPnz9ApBHFYDHLDzDw==");
   cryptolens_handle.signature_verifier.set_exponent_base64(e, "AQAB");
+
+  // This line is only for MachineCodeComputer_static and sets the machine code to a static value
   cryptolens_handle.machine_code_computer.set_machine_code(e, "289jf2afs3");
 
   cryptolens::optional<cryptolens::LicenseKey> license_key =

examples/unix/example_create_trial_key.cpp

@@ -9,13 +9,17 @@
 
 namespace cryptolens = ::cryptolens_io::v20190401;
 
+// Set up an alias for the handler class used to interact with the library. This configuration checks the expiry date
+// on the license. Use Configuration_Unix_IgnoreExpires to ignore the expiry date.
+//
+// For this example we use MachineCodeComputer_static where the machine code is set using set_machine_code(). Other
+// ways of computing the machine code are available, see README.md.
 using Cryptolens = cryptolens::basic_Cryptolens<cryptolens::Configuration_Unix<cryptolens::MachineCodeComputer_static>>;
 
 /*
  * This example uses the basic_Cryptolens class to make a request to the WebAPI
  * and then checks some properties of the license keys.
  */
-
 int main()
 {
   curl_global_init(CURL_GLOBAL_SSL);
@@ -26,6 +30,8 @@ int main()
   // on cryptolens.io
   cryptolens_handle.signature_verifier.set_modulus_base64(e, "khbyu3/vAEBHi339fTuo2nUaQgSTBj0jvpt5xnLTTF35FLkGI+5Z3wiKfnvQiCLf+5s4r8JB/Uic/i6/iNjPMILlFeE0N6XZ+2pkgwRkfMOcx6eoewypTPUoPpzuAINJxJRpHym3V6ZJZ1UfYvzRcQBD/lBeAYrvhpCwukQMkGushKsOS6U+d+2C9ZNeP+U+uwuv/xu8YBCBAgGb8YdNojcGzM4SbCtwvJ0fuOfmCWZvUoiumfE4x7rAhp1pa9OEbUe0a5HL+1v7+JLBgkNZ7Z2biiHaM6za7GjHCXU8rojatEQER+MpgDuQV3ZPx8RKRdiJgPnz9ApBHFYDHLDzDw==");
   cryptolens_handle.signature_verifier.set_exponent_base64(e, "AQAB");
+
+  // This line is only for MachineCodeComputer_static and sets the machine code to a static value
   cryptolens_handle.machine_code_computer.set_machine_code(e, "289jf2afs4");
 
   // We use two tokens, one for the call the activate() and one for the call to create_trial_key()

examples/unix/example_external.cpp

@@ -6,6 +6,12 @@
 #include <cryptolens/MachineCodeComputer_static.hpp>
 
 namespace cryptolens = ::cryptolens_io::v20190401;
+
+// Set up an alias for the handler class used to interact with the library. This configuration checks the expiry date
+// on the license. Use Configuration_Unix_IgnoreExpires to ignore the expiry date.
+//
+// For this example we use MachineCodeComputer_static where the machine code is set using set_machine_code(). Other
+// ways of computing the machine code are available, see README.md.
 using Cryptolens = cryptolens::basic_Cryptolens<cryptolens::Configuration_Unix<cryptolens::MachineCodeComputer_static>>;
 
 /*
@@ -21,6 +27,8 @@ int main()
   // on cryptolens.io
   cryptolens_handle.signature_verifier.set_modulus_base64(e, "khbyu3/vAEBHi339fTuo2nUaQgSTBj0jvpt5xnLTTF35FLkGI+5Z3wiKfnvQiCLf+5s4r8JB/Uic/i6/iNjPMILlFeE0N6XZ+2pkgwRkfMOcx6eoewypTPUoPpzuAINJxJRpHym3V6ZJZ1UfYvzRcQBD/lBeAYrvhpCwukQMkGushKsOS6U+d+2C9ZNeP+U+uwuv/xu8YBCBAgGb8YdNojcGzM4SbCtwvJ0fuOfmCWZvUoiumfE4x7rAhp1pa9OEbUe0a5HL+1v7+JLBgkNZ7Z2biiHaM6za7GjHCXU8rojatEQER+MpgDuQV3ZPx8RKRdiJgPnz9ApBHFYDHLDzDw==");
   cryptolens_handle.signature_verifier.set_exponent_base64(e, "AQAB");
+
+  // This line is only for MachineCodeComputer_static and sets the machine code to a static value
   cryptolens_handle.machine_code_computer.set_machine_code(e, "289jf2afs3");
 
   // Reply from Cryptolens Web API

examples/unix/example_floating.cpp

@@ -8,6 +8,12 @@
 #include <cryptolens/MachineCodeComputer_static.hpp>
 
 namespace cryptolens = ::cryptolens_io::v20190401;
+
+// Set up an alias for the handler class used to interact with the library. This configuration checks the expiry date
+// on the license. Use Configuration_Unix_IgnoreExpires to ignore the expiry date.
+//
+// For this example we use MachineCodeComputer_static where the machine code is set using set_machine_code(). Other
+// ways of computing the machine code are available, see README.md.
 using Cryptolens = cryptolens::basic_Cryptolens<cryptolens::Configuration_Unix<cryptolens::MachineCodeComputer_static>>;
 
 /*
@@ -23,6 +29,8 @@ void activate(char const* machine_code)
   // on cryptolens.io
   cryptolens_handle.signature_verifier.set_modulus_base64(e, "khbyu3/vAEBHi339fTuo2nUaQgSTBj0jvpt5xnLTTF35FLkGI+5Z3wiKfnvQiCLf+5s4r8JB/Uic/i6/iNjPMILlFeE0N6XZ+2pkgwRkfMOcx6eoewypTPUoPpzuAINJxJRpHym3V6ZJZ1UfYvzRcQBD/lBeAYrvhpCwukQMkGushKsOS6U+d+2C9ZNeP+U+uwuv/xu8YBCBAgGb8YdNojcGzM4SbCtwvJ0fuOfmCWZvUoiumfE4x7rAhp1pa9OEbUe0a5HL+1v7+JLBgkNZ7Z2biiHaM6za7GjHCXU8rojatEQER+MpgDuQV3ZPx8RKRdiJgPnz9ApBHFYDHLDzDw==");
   cryptolens_handle.signature_verifier.set_exponent_base64(e, "AQAB");
+
+  // This line is only for MachineCodeComputer_static and sets the machine code to a static value
   cryptolens_handle.machine_code_computer.set_machine_code(e, machine_code);
 
   cryptolens::optional<cryptolens::LicenseKey> license_key =

examples/unix/example_offline.cpp

@@ -11,6 +11,12 @@
 #include <cryptolens/MachineCodeComputer_static.hpp>
 
 namespace cryptolens = ::cryptolens_io::v20190401;
+
+// Set up an alias for the handler class used to interact with the library. This configuration checks the expiry date
+// on the license. Use Configuration_Unix_IgnoreExpires to ignore the expiry date.
+//
+// For this example we use MachineCodeComputer_static where the machine code is set using set_machine_code(). Other
+// ways of computing the machine code are available, see README.md.
 using Cryptolens = cryptolens::basic_Cryptolens<cryptolens::Configuration_Unix<cryptolens::MachineCodeComputer_static>>;
 
 /*
@@ -58,6 +64,8 @@ int write_license_key_to_file(char const* file_name)
   // on cryptolens.io
   cryptolens_handle.signature_verifier.set_modulus_base64(e, "khbyu3/vAEBHi339fTuo2nUaQgSTBj0jvpt5xnLTTF35FLkGI+5Z3wiKfnvQiCLf+5s4r8JB/Uic/i6/iNjPMILlFeE0N6XZ+2pkgwRkfMOcx6eoewypTPUoPpzuAINJxJRpHym3V6ZJZ1UfYvzRcQBD/lBeAYrvhpCwukQMkGushKsOS6U+d+2C9ZNeP+U+uwuv/xu8YBCBAgGb8YdNojcGzM4SbCtwvJ0fuOfmCWZvUoiumfE4x7rAhp1pa9OEbUe0a5HL+1v7+JLBgkNZ7Z2biiHaM6za7GjHCXU8rojatEQER+MpgDuQV3ZPx8RKRdiJgPnz9ApBHFYDHLDzDw==");
   cryptolens_handle.signature_verifier.set_exponent_base64(e, "AQAB");
+
+  // This line is only for MachineCodeComputer_static and sets the machine code to a static value
   cryptolens_handle.machine_code_computer.set_machine_code(e, "289jf2afs3");
 
   cryptolens::optional<cryptolens::LicenseKey> license_key =