[GR-28391] Implement crypt module

msimacek · msimacek · commit 848f826dc48f · 2021-04-21T13:55:14.000Z
PullRequest: graalpython/1765
diff --git a/graalpython/com.oracle.graal.python.cext/posix/posix.c b/graalpython/com.oracle.graal.python.cext/posix/posix.c
@@ -818,6 +818,15 @@ int32_t set_sockaddr_in6_members(int8_t *addr, int32_t port, int8_t *address, in
     return sizeof(sa);
 }
 
+int64_t call_crypt(const char *word, const char *salt, int32_t *len) {
+    const char *result = crypt(word, salt);
+    if (result == NULL) {
+        return NULL;
+    }
+    *len = strlen(result);
+    return (int64_t)(uintptr_t)result;
+}
+
 int32_t get_errno() {
     return errno;
 }
diff --git a/graalpython/com.oracle.graal.python.cext/setup.py b/graalpython/com.oracle.graal.python.cext/setup.py
@@ -471,6 +471,7 @@ def build_libposix(capi_home):
     files = [os.path.abspath(os.path.join(src_dir, f)) for f in os.listdir(src_dir) if f.endswith(".c")]
     module = Extension(libposix_name,
                        sources=files,
+                       libraries=['crypt'] if not darwin_native else [],
                        extra_compile_args=cflags_warnings + ['-Wall', '-Werror'])
     args = [verbosity, 'build', 'install_lib', '-f', '--install-dir=%s' % capi_home, "clean"]
     setup(
diff --git a/graalpython/com.oracle.graal.python.test/src/tests/unittest_tags/test_crypt.txt b/graalpython/com.oracle.graal.python.test/src/tests/unittest_tags/test_crypt.txt
@@ -0,0 +1,8 @@
+*graalpython.lib-python.3.test.test_crypt.CryptTestCase.test_blowfish_rounds
+*graalpython.lib-python.3.test.test_crypt.CryptTestCase.test_crypt
+*graalpython.lib-python.3.test.test_crypt.CryptTestCase.test_invalid_rounds
+*graalpython.lib-python.3.test.test_crypt.CryptTestCase.test_methods
+*graalpython.lib-python.3.test.test_crypt.CryptTestCase.test_salt
+*graalpython.lib-python.3.test.test_crypt.CryptTestCase.test_saltedcrypt
+*graalpython.lib-python.3.test.test_crypt.CryptTestCase.test_sha2_rounds
+*graalpython.lib-python.3.test.test_crypt.TestWhyCryptDidNotImport.test_import_failure_message
diff --git a/graalpython/com.oracle.graal.python.test/src/tests/unittest_tags/test_queue.txt b/graalpython/com.oracle.graal.python.test/src/tests/unittest_tags/test_queue.txt
@@ -19,9 +19,6 @@
 *graalpython.lib-python.3.test.test_queue.CQueueTest.test_shrinking_queue
 *graalpython.lib-python.3.test.test_queue.CSimpleQueueTest.test_basic
 *graalpython.lib-python.3.test.test_queue.CSimpleQueueTest.test_is_default
-*graalpython.lib-python.3.test.test_queue.CSimpleQueueTest.test_many_threads
-*graalpython.lib-python.3.test.test_queue.CSimpleQueueTest.test_many_threads_nonblock
-*graalpython.lib-python.3.test.test_queue.CSimpleQueueTest.test_many_threads_timeout
 *graalpython.lib-python.3.test.test_queue.CSimpleQueueTest.test_negative_timeout_raises_exception
 *graalpython.lib-python.3.test.test_queue.CSimpleQueueTest.test_order
 *graalpython.lib-python.3.test.test_queue.CSimpleQueueTest.test_reentrancy
@@ -46,9 +43,6 @@
 *graalpython.lib-python.3.test.test_queue.PyQueueTest.test_queue_task_done
 *graalpython.lib-python.3.test.test_queue.PyQueueTest.test_shrinking_queue
 *graalpython.lib-python.3.test.test_queue.PySimpleQueueTest.test_basic
-*graalpython.lib-python.3.test.test_queue.PySimpleQueueTest.test_many_threads
-*graalpython.lib-python.3.test.test_queue.PySimpleQueueTest.test_many_threads_nonblock
-*graalpython.lib-python.3.test.test_queue.PySimpleQueueTest.test_many_threads_timeout
 *graalpython.lib-python.3.test.test_queue.PySimpleQueueTest.test_negative_timeout_raises_exception
 *graalpython.lib-python.3.test.test_queue.PySimpleQueueTest.test_order
 *graalpython.lib-python.3.test.test_queue.PySimpleQueueTest.test_references
diff --git a/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/Python3Core.java b/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/Python3Core.java
@@ -58,6 +58,7 @@
 import com.oracle.graal.python.builtins.modules.CodecsTruffleModuleBuiltins;
 import com.oracle.graal.python.builtins.modules.CollectionsModuleBuiltins;
 import com.oracle.graal.python.builtins.modules.ContextvarsModuleBuiltins;
+import com.oracle.graal.python.builtins.modules.CryptModuleBuiltins;
 import com.oracle.graal.python.builtins.modules.CtypesModuleBuiltins;
 import com.oracle.graal.python.builtins.modules.ErrnoModuleBuiltins;
 import com.oracle.graal.python.builtins.modules.FaulthandlerModuleBuiltins;
@@ -391,6 +392,7 @@ private static PythonBuiltins[] initializeBuiltins(boolean nativeAccessAllowed)
                         new PropertyBuiltins(),
                         new BaseExceptionBuiltins(),
                         new PosixModuleBuiltins(),
+                        new CryptModuleBuiltins(),
                         new ScandirIteratorBuiltins(),
                         new DirEntryBuiltins(),
                         new ImpModuleBuiltins(),
diff --git a/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/modules/CryptModuleBuiltins.java b/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/modules/CryptModuleBuiltins.java
@@ -0,0 +1,86 @@
+/*
+ * Copyright (c) 2021, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * The Universal Permissive License (UPL), Version 1.0
+ *
+ * Subject to the condition set forth below, permission is hereby granted to any
+ * person obtaining a copy of this software, associated documentation and/or
+ * data (collectively the "Software"), free of charge and under any and all
+ * copyright rights in the Software, and any and all patent rights owned or
+ * freely licensable by each licensor hereunder covering either (i) the
+ * unmodified Software as contributed to or provided by such licensor, or (ii)
+ * the Larger Works (as defined below), to deal in both
+ *
+ * (a) the Software, and
+ *
+ * (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
+ * one is included with the Software each a "Larger Work" to which the Software
+ * is contributed by such licensors),
+ *
+ * without restriction, including without limitation the rights to copy, create
+ * derivative works of, display, perform, and distribute the Software and make,
+ * use, sell, offer for sale, import, export, have made, and have sold the
+ * Software and the Larger Work(s), and to sublicense the foregoing rights on
+ * either these or other terms.
+ *
+ * This license is subject to the following condition:
+ *
+ * The above copyright notice and either this complete permission notice or at a
+ * minimum a reference to the UPL must be included in all copies or substantial
+ * portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+package com.oracle.graal.python.builtins.modules;
+
+import java.util.List;
+
+import com.oracle.graal.python.annotations.ArgumentClinic;
+import com.oracle.graal.python.builtins.Builtin;
+import com.oracle.graal.python.builtins.CoreFunctions;
+import com.oracle.graal.python.builtins.PythonBuiltins;
+import com.oracle.graal.python.nodes.function.PythonBuiltinBaseNode;
+import com.oracle.graal.python.nodes.function.builtins.PythonBinaryClinicBuiltinNode;
+import com.oracle.graal.python.nodes.function.builtins.clinic.ArgumentClinicProvider;
+import com.oracle.graal.python.runtime.PosixSupportLibrary;
+import com.oracle.truffle.api.dsl.GenerateNodeFactory;
+import com.oracle.truffle.api.dsl.NodeFactory;
+import com.oracle.truffle.api.dsl.Specialization;
+import com.oracle.truffle.api.frame.VirtualFrame;
+import com.oracle.truffle.api.library.CachedLibrary;
+
+@CoreFunctions(defineModule = "_crypt")
+public class CryptModuleBuiltins extends PythonBuiltins {
+    @Override
+    protected List<? extends NodeFactory<? extends PythonBuiltinBaseNode>> getNodeFactories() {
+        return CryptModuleBuiltinsFactory.getFactories();
+    }
+
+    @Builtin(name = "crypt", minNumOfPositionalArgs = 2, numOfPositionalOnlyArgs = 2, parameterNames = {"word", "salt"})
+    @ArgumentClinic(name = "word", conversion = ArgumentClinic.ClinicConversion.String)
+    @ArgumentClinic(name = "salt", conversion = ArgumentClinic.ClinicConversion.String)
+    @GenerateNodeFactory
+    abstract static class CryptNode extends PythonBinaryClinicBuiltinNode {
+        @Specialization
+        Object crypt(VirtualFrame frame, String word, String salt,
+                        @CachedLibrary("getPosixSupport()") PosixSupportLibrary posixLib) {
+            try {
+                return posixLib.crypt(getPosixSupport(), word, salt);
+            } catch (PosixSupportLibrary.PosixException e) {
+                throw raiseOSErrorFromPosixException(frame, e);
+            }
+        }
+
+        @Override
+        protected ArgumentClinicProvider getArgumentClinic() {
+            return CryptModuleBuiltinsClinicProviders.CryptNodeClinicProviderGen.INSTANCE;
+        }
+    }
+}
diff --git a/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/runtime/EmulatedPosixSupport.java b/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/runtime/EmulatedPosixSupport.java
@@ -2376,6 +2376,12 @@ public AddrInfoCursor getaddrinfo(Object node, Object service, int family, int s
         throw shouldNotReachHere("Not implemented");
     }
 
+    @ExportMessage
+    @SuppressWarnings({"unused", "static-method"})
+    public String crypt(String word, String salt) throws PosixException {
+        throw new UnsupportedPosixFeatureException("crypt not supported");
+    }
+
     @ExportMessage
     @SuppressWarnings("static-method")
     public UniversalSockAddr createUniversalSockAddr(FamilySpecificSockAddr src) {
diff --git a/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/runtime/ImageBuildtimePosixSupport.java b/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/runtime/ImageBuildtimePosixSupport.java
@@ -45,14 +45,14 @@
 import java.util.HashSet;
 import java.util.IdentityHashMap;
 
-import com.oracle.graal.python.runtime.PosixSupportLibrary.InvalidAddressException;
 import org.graalvm.nativeimage.ImageInfo;
 
 import com.oracle.graal.python.runtime.PosixSupportLibrary.AcceptResult;
 import com.oracle.graal.python.runtime.PosixSupportLibrary.AddrInfoCursor;
 import com.oracle.graal.python.runtime.PosixSupportLibrary.Buffer;
 import com.oracle.graal.python.runtime.PosixSupportLibrary.FamilySpecificSockAddr;
 import com.oracle.graal.python.runtime.PosixSupportLibrary.GetAddrInfoException;
+import com.oracle.graal.python.runtime.PosixSupportLibrary.InvalidAddressException;
 import com.oracle.graal.python.runtime.PosixSupportLibrary.PosixException;
 import com.oracle.graal.python.runtime.PosixSupportLibrary.RecvfromResult;
 import com.oracle.graal.python.runtime.PosixSupportLibrary.SelectResult;
@@ -824,6 +824,13 @@ final AddrInfoCursor getaddrinfo(Object node, Object service, int family, int so
         return nativeLib.getaddrinfo(nativePosixSupport, node, service, family, sockType, protocol, flags);
     }
 
+    @ExportMessage
+    final String crypt(String word, String salt,
+                    @CachedLibrary("this.nativePosixSupport") PosixSupportLibrary nativeLib) throws PosixException {
+        checkNotInImageBuildtime();
+        return nativeLib.crypt(nativePosixSupport, word, salt);
+    }
+
     @ExportMessage
     final UniversalSockAddr createUniversalSockAddr(FamilySpecificSockAddr src,
                     @CachedLibrary("this.nativePosixSupport") PosixSupportLibrary nativeLib) {
diff --git a/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/runtime/LoggingPosixSupport.java b/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/runtime/LoggingPosixSupport.java
@@ -1082,6 +1082,17 @@ final AddrInfoCursor getaddrinfo(Object node, Object service, int family, int so
         }
     }
 
+    @ExportMessage
+    final String crypt(String word, String salt,
+                    @CachedLibrary("this.delegate") PosixSupportLibrary lib) throws PosixException {
+        logEnter("crypt", "%s, %s", word, salt);
+        try {
+            return logExit("crypt", "%s", lib.crypt(delegate, word, salt));
+        } catch (PosixException e) {
+            throw logException("crypt", e);
+        }
+    }
+
     @ExportMessage
     final UniversalSockAddr createUniversalSockAddr(FamilySpecificSockAddr src,
                     @CachedLibrary("this.delegate") PosixSupportLibrary lib) {
diff --git a/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/runtime/NFIPosixSupport.java b/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/runtime/NFIPosixSupport.java
@@ -64,7 +64,6 @@
 import java.util.concurrent.atomic.AtomicReferenceArray;
 import java.util.logging.Level;
 
-import com.oracle.graal.python.runtime.PosixSupportLibrary.InvalidAddressException;
 import org.graalvm.nativeimage.ImageInfo;
 
 import com.oracle.graal.python.PythonLanguage;
@@ -78,6 +77,7 @@
 import com.oracle.graal.python.runtime.PosixSupportLibrary.GetAddrInfoException;
 import com.oracle.graal.python.runtime.PosixSupportLibrary.Inet4SockAddr;
 import com.oracle.graal.python.runtime.PosixSupportLibrary.Inet6SockAddr;
+import com.oracle.graal.python.runtime.PosixSupportLibrary.InvalidAddressException;
 import com.oracle.graal.python.runtime.PosixSupportLibrary.PosixException;
 import com.oracle.graal.python.runtime.PosixSupportLibrary.RecvfromResult;
 import com.oracle.graal.python.runtime.PosixSupportLibrary.SelectResult;
@@ -126,6 +126,8 @@ public final class NFIPosixSupport extends PosixSupport {
 
     private static final Unsafe UNSAFE = initUnsafe();
 
+    private static final Object CRYPT_LOCK = new Object();
+
     private static Unsafe initUnsafe() {
         try {
             return Unsafe.getUnsafe();
@@ -240,7 +242,9 @@ private enum PosixNativeFunction {
         get_sockaddr_in_members("([sint8], [sint32]):void"),
         get_sockaddr_in6_members("([sint8], [sint32], [sint8]):void"),
         set_sockaddr_in_members("([sint8], sint32, sint32):sint32"),
-        set_sockaddr_in6_members("([sint8], sint32, [sint8], sint32, sint32):sint32");
+        set_sockaddr_in6_members("([sint8], sint32, [sint8], sint32, sint32):sint32"),
+
+        call_crypt("([sint8], [sint8], [sint32]):sint64");
 
         private final String signature;
 
@@ -1589,6 +1593,32 @@ public AddrInfoCursor getaddrinfo(Object node, Object service, int family, int s
         return new AddrInfoCursorImpl(this, ptr[0], invokeNode);
     }
 
+    @ExportMessage
+    public String crypt(String word, String salt,
+                    @Shared("invoke") @Cached InvokeNativeFunction invokeNode) throws PosixException {
+        int[] lenArray = new int[1];
+        /*
+         * From the manpage: Upon successful completion, crypt returns a pointer to a string which
+         * encodes both the hashed passphrase, and the settings that were used to encode it. See
+         * crypt(5) for more detail on the format of hashed passphrases. crypt places its result in
+         * a static storage area, which will be overwritten by subsequent calls to crypt. It is not
+         * safe to call crypt from multiple threads simultaneously. Upon error, it may return a NULL
+         * pointer or a pointer to an invalid hash, depending on the implementation.
+         */
+        // Note GIL is not enough as crypt is using global memory so we need a really global lock
+        synchronized (CRYPT_LOCK) {
+            long resultPtr = invokeNode.callLong(this, PosixNativeFunction.call_crypt, stringToUTF8CString(word), stringToUTF8CString(salt), wrap(lenArray));
+            // CPython doesn't handle the case of "invalid hash" return specially and neither do we
+            if (resultPtr == 0) {
+                throw getErrnoAndThrowPosixException(invokeNode);
+            }
+            int len = lenArray[0];
+            byte[] resultBytes = new byte[len];
+            UNSAFE.copyMemory(null, resultPtr, resultBytes, Unsafe.ARRAY_BYTE_BASE_OFFSET, len);
+            return PythonUtils.newString(resultBytes);
+        }
+    }
+
     private String gai_strerror(int errorCode,
                     @Shared("invoke") @Cached InvokeNativeFunction invokeNode) {
         byte[] buf = new byte[1024];
@@ -2002,6 +2032,11 @@ private Object bufferToCString(Buffer path) {
         return wrap(nullTerminate(path.data, (int) path.length));
     }
 
+    private Object stringToUTF8CString(String input) {
+        byte[] utf8 = BytesUtils.utf8StringToBytes(input);
+        return wrap(nullTerminate(utf8, utf8.length));
+    }
+
     private static byte[] nullTerminate(byte[] str, int length) {
         byte[] terminated = new byte[length + 1];
         PythonUtils.arraycopy(str, 0, terminated, 0, length);
diff --git a/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/runtime/PosixSupportLibrary.java b/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/runtime/PosixSupportLibrary.java
@@ -648,6 +648,17 @@ public String toString() {
     public interface AddrInfoCursor {
     }
 
+    /**
+     * Corresponds to POSIX crypt function that hashes passwords with salt.
+     *
+     * @param word password to be hashed
+     * @param salt random salt, optionally prefixed with $DIGIT$ hash method indication
+     * @return hashed password
+     * @throws PosixException when an error occurs in the underlying crypt call
+     * @see "crypt(3) manpage"
+     */
+    public abstract String crypt(Object receiver, String word, String salt) throws PosixException;
+
     /**
      * Provides messages for manipulating {@link AddrInfoCursor}.
      */
diff --git a/mx.graalpython/mx_graalpython.py b/mx.graalpython/mx_graalpython.py
@@ -510,7 +510,6 @@ def _python_graalvm_launcher(args, extra_dy=None):
         args.remove("svm")
         dy += ",/substratevm"
     dy = ["--dynamicimports", dy]
-    mx.run_mx(dy + ["clean"])   # workaround for GR-30487
     mx.run_mx(dy + ["build"])
     out = mx.OutputCapture()
     mx.run_mx(dy + ["graalvm-home"], out=mx.TeeOutputCapture(out))
