From c4abad94cc3b63f842de6b75cf7bb992e1a8308a Mon Sep 17 00:00:00 2001
From: Thorsten Sommer <mail@tsommer.org>
Date: Sat, 22 Aug 2020 20:20:07 +0200
Subject: [PATCH] Added documentation

---
 ExaArray/ExaArray1D.cs | 12 ++++++++++--
 ExaArray/ExaArray2D.cs | 13 +++++++++++--
 2 files changed, 21 insertions(+), 4 deletions(-)

diff --git a/ExaArray/ExaArray1D.cs b/ExaArray/ExaArray1D.cs
index c837fbf..753f86e 100644
--- a/ExaArray/ExaArray1D.cs
+++ b/ExaArray/ExaArray1D.cs
@@ -226,9 +226,13 @@ namespace Exa
         #region Store and load
 
         /// <summary>
-        /// Stores the exa array into a stream.
+        /// Stores the exa array into a stream. <b>Please read the remarks regarding security issues.</b>
         /// </summary>
         /// <remarks>
+        /// The data stored in this way should never be part of a public API. Serializing and
+        /// deserializing is not secure: an attacker can manipulate the data in a targeted
+        /// manner to compromise the API server, etc.
+        ///
         /// This method does not dispose the stream.
         /// </remarks>
         public void Store(Stream outputStream)
@@ -238,9 +242,13 @@ namespace Exa
         }
 
         /// <summary>
-        /// Restores an exa array from the given stream.
+        /// Restores an exa array from the given stream. <b>Please read the remarks regarding security issues.</b>
         /// </summary>
         /// <remarks>
+        /// The data loaded in this way should never be part of a public API. Serializing and
+        /// deserializing is not secure: an attacker can manipulate the data in a targeted
+        /// manner to compromise the API server, etc.
+        /// 
         /// This method does not dispose the stream.
         /// </remarks>
         public static ExaArray1D<T> Restore(Stream inputStream)
diff --git a/ExaArray/ExaArray2D.cs b/ExaArray/ExaArray2D.cs
index 6c61b90..ea94eea 100644
--- a/ExaArray/ExaArray2D.cs
+++ b/ExaArray/ExaArray2D.cs
@@ -8,6 +8,7 @@ namespace Exa
     /// <summary>
     /// The two-dimensional exa-scale array. Can grow up to 18,446,744,073,709,551,615 elements in total.
     /// </summary>
+    [Serializable]
     public sealed class ExaArray2D<T> : ISerializable
     {
         /// <summary>
@@ -86,9 +87,13 @@ namespace Exa
         #region Store and load
 
         /// <summary>
-        /// Stores the exa array into a stream.
+        /// Stores the exa array into a stream. <b>Please read the remarks regarding security issues.</b>
         /// </summary>
         /// <remarks>
+        /// The data stored in this way should never be part of a public API. Serializing and
+        /// deserializing is not secure: an attacker can manipulate the data in a targeted
+        /// manner to compromise the API server, etc.
+        ///
         /// This method does not dispose the stream.
         /// </remarks>
         public void Store(Stream outputStream)
@@ -98,9 +103,13 @@ namespace Exa
         }
 
         /// <summary>
-        /// Restores an exa array from the given stream.
+        /// Restores an exa array from the given stream. <b>Please read the remarks regarding security issues.</b>
         /// </summary>
         /// <remarks>
+        /// The data loaded in this way should never be part of a public API. Serializing and
+        /// deserializing is not secure: an attacker can manipulate the data in a targeted
+        /// manner to compromise the API server, etc.
+        /// 
         /// This method does not dispose the stream.
         /// </remarks>
         public static ExaArray2D<T> Restore(Stream inputStream)