Change md5 to hash and hash_algorithm, fix incompatibility

docs/source/developers/contents.rst

@@ -63,7 +63,7 @@ Models may contain the following entries:
 |                    |``None``   |if any. (:ref:`See            |
 |                    |           |Below<modelcontent>`)         |
 +--------------------+-----------+------------------------------+
-|**md5**             |unicode or |The md5 of the contents.      |
+|**sha256**          |unicode or |The sha256 of the contents.   |
 |                    |``None``   |                              |
 |                    |           |                              |
 +--------------------+-----------+------------------------------+
@@ -80,7 +80,7 @@ model. There are three model types: **notebook**, **file**, and **directory**.
       :class:`nbformat.notebooknode.NotebookNode` representing the .ipynb file
       represented by the model.  See the `NBFormat`_ documentation for a full
       description.
-    - The ``md5`` field a hexdigest string of the md5 value of the notebook
+    - The ``sha256`` field a hexdigest string of the sha256 value of the notebook
       file.
 
 - ``file`` models
@@ -91,14 +91,14 @@ model. There are three model types: **notebook**, **file**, and **directory**.
       file models, ``content`` simply contains the file's bytes after decoding
       as UTF-8.  Non-text (``base64``) files are read as bytes, base64 encoded,
       and then decoded as UTF-8.
-    - The ``md5`` field a hexdigest string of the md5 value of the file.
+    - The ``sha256`` field a hexdigest string of the sha256 value of the file.
 
 - ``directory`` models
     - The ``format`` field is always ``"json"``.
     - The ``mimetype`` field is always ``None``.
     - The ``content`` field contains a list of :ref:`content-free<contentfree>`
       models representing the entities in the directory.
-    - The ``md5`` field is always ``None``.
+    - The ``sha256`` field is always ``None``.
 
 .. note::
 
@@ -137,7 +137,7 @@ model. There are three model types: **notebook**, **file**, and **directory**.
         "path": "foo/a.ipynb",
         "type": "notebook",
         "writable": True,
-        "md5": "7e47382b370c05a1b14706a2a8aff91a",
+        "sha256": "f5e43a0b1c2e7836ab3b4d6b1c35c19e2558688de15a6a14e137a59e4715d34b",
     }
 
     # Notebook Model without Content

jupyter_server/services/api/api.yaml

@@ -106,9 +106,9 @@ paths:
           in: query
           description: "Return content (0 for no content, 1 for return content)"
           type: integer
-        - name: md5
+        - name: sha256
           in: query
-          description: "Return md5 hexdigest string of content (0 for no md5, 1 for return md5)"
+          description: "Return sha256 hexdigest string of content (0 for no sha256, 1 for return sha256)"
           type: integer
       responses:
         404:
@@ -889,7 +889,7 @@ definitions:
       kernel:
         $ref: "#/definitions/Kernel"
   Contents:
-    description: "A contents object.  The content and format keys may be null if content is not contained. The md5 maybe null if md5 is not contained.  If type is 'file', then the mimetype will be null."
+    description: "A contents object.  The content and format keys may be null if content is not contained. The sha256 maybe null if sha256 is not contained.  If type is 'file', then the mimetype will be null."
     type: object
     required:
       - type
@@ -901,7 +901,7 @@ definitions:
       - mimetype
       - format
       - content
-      - md5
+      - sha256
     properties:
       name:
         type: string
@@ -939,9 +939,9 @@ definitions:
       format:
         type: string
         description: Format of content (one of null, 'text', 'base64', 'json')
-      md5:
+      sha256:
         type: string
-        description: "The md5 hexdigest string of content, if requested (otherwise null)."
+        description: "The sha256 hexdigest string of content, if requested (otherwise null)."
   Checkpoints:
     description: A checkpoint object.
     type: object

jupyter_server/services/contents/fileio.py

@@ -357,11 +357,11 @@ def _save_file(self, os_path, content, format):
         with self.atomic_writing(os_path, text=False) as f:
             f.write(bcontent)
 
-    def _get_md5(self, os_path):
+    def _get_sha256(self, os_path):
         c, _ = self._read_file(os_path, "byte")
-        md5 = hashlib.md5()
-        md5.update(c)
-        return md5.hexdigest()
+        sha256 = hashlib.sha256()
+        sha256.update(c)
+        return sha256.hexdigest()
 
 
 class AsyncFileManagerMixin(FileManagerMixin):
@@ -475,8 +475,8 @@ async def _save_file(self, os_path, content, format):
         with self.atomic_writing(os_path, text=False) as f:
             await run_sync(f.write, bcontent)
 
-    async def _get_md5(self, os_path):
+    async def _get_sha256(self, os_path):
         c, _ = await self._read_file(os_path, "byte")
-        md5 = hashlib.md5()
-        await run_sync(md5.update, c)
-        return md5.hexdigest()
+        sha256 = hashlib.sha256()
+        await run_sync(sha256.update, c)
+        return sha256.hexdigest()

jupyter_server/services/contents/filemanager.py

@@ -48,6 +48,7 @@ class FileContentsManager(FileManagerMixin, ContentsManager):
     root_dir = Unicode(config=True)
 
     max_copy_folder_size_mb = Int(500, config=True, help="The max folder size that can be copied")
+    support_sha256 = Bool(True, config=False, help="Support sha256 argument in `get`")
 
     @default("root_dir")
     def _default_root_dir(self):
@@ -268,7 +269,7 @@ def _base_model(self, path):
         model["mimetype"] = None
         model["size"] = size
         model["writable"] = self.is_writable(path)
-        model["md5"] = None
+        model["sha256"] = None
 
         return model
 
@@ -336,7 +337,7 @@ def _dir_model(self, path, content=True):
 
         return model
 
-    def _file_model(self, path, content=True, format=None, md5=False):
+    def _file_model(self, path, content=True, format=None, sha256=False):
         """Build a model for a file
 
         if content is requested, include the file contents.
@@ -365,13 +366,13 @@ def _file_model(self, path, content=True, format=None, md5=False):
                 content=content,
                 format=format,
             )
-        if md5:
-            md5 = self._get_md5(os_path)
-            model.update(md5=md5)
+        if sha256:
+            sha256 = self._get_sha256(os_path)
+            model.update(sha256=sha256)
 
         return model
 
-    def _notebook_model(self, path, content=True, md5=False):
+    def _notebook_model(self, path, content=True, sha256=False):
         """Build a notebook model
 
         if content is requested, the notebook content will be populated
@@ -390,12 +391,12 @@ def _notebook_model(self, path, content=True, md5=False):
             model["content"] = nb
             model["format"] = "json"
             self.validate_notebook_model(model, validation_error)
-        if md5:
-            model["md5"] = self._get_md5(os_path)
+        if sha256:
+            model["sha256"] = self._get_sha256(os_path)
 
         return model
 
-    def get(self, path, content=True, type=None, format=None, md5=None):
+    def get(self, path, content=True, type=None, format=None, sha256=None):
         """Takes a path for an entity and returns its model
 
         Parameters
@@ -410,8 +411,8 @@ def get(self, path, content=True, type=None, format=None, md5=None):
         format : str, optional
             The requested format for file contents. 'text' or 'base64'.
             Ignored if this returns a notebook or directory model.
-        md5: bool, optional
-            Whether to include the md5 of the file contents.
+        sha256: bool, optional
+            Whether to include the sha256 of the file contents.
 
         Returns
         -------
@@ -439,11 +440,11 @@ def get(self, path, content=True, type=None, format=None, md5=None):
                 )
             model = self._dir_model(path, content=content)
         elif type == "notebook" or (type is None and path.endswith(".ipynb")):
-            model = self._notebook_model(path, content=content, md5=md5)
+            model = self._notebook_model(path, content=content, sha256=sha256)
         else:
             if type == "directory":
                 raise web.HTTPError(400, "%s is not a directory" % path, reason="bad type")
-            model = self._file_model(path, content=content, format=format, md5=md5)
+            model = self._file_model(path, content=content, format=format, sha256=sha256)
         self.emit(data={"action": "get", "path": path})
         return model
 
@@ -725,6 +726,8 @@ def _human_readable_size(self, size):
 class AsyncFileContentsManager(FileContentsManager, AsyncFileManagerMixin, AsyncContentsManager):
     """An async file contents manager."""
 
+    support_sha256 = Bool(True, config=False, help="Support sha256 argument in `get`")
+
     @default("checkpoints_class")
     def _checkpoints_class_default(self):
         return AsyncFileCheckpoints
@@ -794,7 +797,7 @@ async def _dir_model(self, path, content=True):
 
         return model
 
-    async def _file_model(self, path, content=True, format=None, md5=False):
+    async def _file_model(self, path, content=True, format=None, sha256=False):
         """Build a model for a file
 
         if content is requested, include the file contents.
@@ -823,13 +826,13 @@ async def _file_model(self, path, content=True, format=None, md5=False):
                 content=content,
                 format=format,
             )
-        if md5:
-            md5 = await self._get_md5(os_path)
-            model.update(md5=md5)
+        if sha256:
+            sha256 = await self._get_sha256(os_path)
+            model.update(sha256=sha256)
 
         return model
 
-    async def _notebook_model(self, path, content=True, md5=False):
+    async def _notebook_model(self, path, content=True, sha256=False):
         """Build a notebook model
 
         if content is requested, the notebook content will be populated
@@ -848,12 +851,12 @@ async def _notebook_model(self, path, content=True, md5=False):
             model["content"] = nb
             model["format"] = "json"
             self.validate_notebook_model(model, validation_error)
-        if md5:
-            model["md5"] = await self._get_md5(os_path)
+        if sha256:
+            model["sha256"] = await self._get_sha256(os_path)
 
         return model
 
-    async def get(self, path, content=True, type=None, format=None, md5=False):
+    async def get(self, path, content=True, type=None, format=None, sha256=False):
         """Takes a path for an entity and returns its model
 
         Parameters
@@ -868,8 +871,8 @@ async def get(self, path, content=True, type=None, format=None, md5=False):
         format : str, optional
             The requested format for file contents. 'text' or 'base64'.
             Ignored if this returns a notebook or directory model.
-        md5: bool, optional
-            Whether to include the md5 of the file contents.
+        sha256: bool, optional
+            Whether to include the sha256 of the file contents.
 
         Returns
         -------
@@ -892,11 +895,11 @@ async def get(self, path, content=True, type=None, format=None, md5=False):
                 )
             model = await self._dir_model(path, content=content)
         elif type == "notebook" or (type is None and path.endswith(".ipynb")):
-            model = await self._notebook_model(path, content=content, md5=md5)
+            model = await self._notebook_model(path, content=content, sha256=sha256)
         else:
             if type == "directory":
                 raise web.HTTPError(400, "%s is not a directory" % path, reason="bad type")
-            model = await self._file_model(path, content=content, format=format, md5=md5)
+            model = await self._file_model(path, content=content, format=format, sha256=sha256)
         self.emit(data={"action": "get", "path": path})
         return model