在 Swift 框架中导入 CommonCrypto

Question

如何在 iOS 的 Swift 框架中导入 CommonCrypto？

我了解如何在 Swift 应用程序中使用 CommonCrypto： 您将#import <CommonCrypto/CommonCrypto.h> 添加到桥接头。 但是，Swift 框架不支持桥接头。 documentation 说：

您可以导入具有纯 Objective-C 代码库、纯 Swift 代码库或混合语言代码库的外部框架。这 导入外部框架的过程是否相同 框架是用一种语言编写的或包含来自这两种语言的文件 语言。导入外部框架时，请确保 为您要导入的框架定义模块构建设置 是的。

你可以将一个框架导入到不同的 Swift 文件中 使用以下语法定位目标：

import FrameworkName

很遗憾，导入 CommonCrypto 不起作用。也不会将#import <CommonCrypto/CommonCrypto.h> 添加到伞形标题中。

Answer 1

更新 Xcode 后，我也遇到了同样的情况。 我尝试了我能做的所有事情，例如重新安装 cocoapods 和清理项目，但没有奏效。 现在重启系统后解决了。

Answer 2

如果您遇到以下问题：

ld: 找不到 -lapple_crypto 的库 clang：错误：链接器命令失败，退出代码为 1（使用 -v 查看调用）

在 Xcode 10 中，Swift 4.0。 CommonCrypto 是框架的一部分。

添加

 import CommonCrypto

删除

• 来自链接二进制文件的 CommonCrpto lib 文件与来自 Build 的库 阶段
• import CommonCrypto 来自桥接头

这对我有用！

Answer 3

好消息！ Swift 4.2 (Xcode 10) 终于提供了 CommonCrypto！

只需在您的 swift 文件中添加 import CommonCrypto。

Answer 4

对于使用 swift 4.2 和 Xcode 10 的任何人：

CommonCrypto 模块现在由系统提供，因此您可以像任何其他系统框架一样直接导入它。

import CommonCrypto

Answer 5

我不确定 Xcode 9.2 是否有所改变，但现在实现这一点要简单得多。我唯一要做的就是在我的框架项目目录中创建一个名为“CommonCrypto”的文件夹，并在其中创建两个文件，一个名为“cc.h”，如下所示：

#include <CommonCrypto/CommonCrypto.h>
#include <CommonCrypto/CommonRandom.h>

还有一个叫module.modulemap：

module CommonCrypto {
    export *
    header "cc.h"
}

（我不知道为什么不能直接在modulemap文件中引用SDKROOT区域的头文件，但我无法让它工作）

第三件事是找到“导入路径”设置并设置为$(SRCROOT)。 事实上，如果您不希望它位于根级别，您可以将其设置为您希望 CommonCrypto 文件夹所在的任何文件夹。

之后你应该可以使用了

import CommonCrypto

在任何 swift 文件和所有类型/功能/等中。可用。

但请注意 - 如果您的应用使用 libCommonCrypto（或 libcoreCrypto），不太老练的黑客非常容易将调试器附加到您的应用并找出传递给这些函数的密钥。

Answer 6

更简单和更健壮的方法是创建一个名为“CommonCryptoModuleMap”的聚合目标，其中包含运行脚本阶段，以自动生成模块映射并使用正确的 Xcode/SDK 路径：

运行脚本阶段应该包含这个 bash：

# This if-statement means we'll only run the main script if the CommonCryptoModuleMap directory doesn't exist
# Because otherwise the rest of the script causes a full recompile for anything where CommonCrypto is a dependency
# Do a "Clean Build Folder" to remove this directory and trigger the rest of the script to run
if [ -d "${BUILT_PRODUCTS_DIR}/CommonCryptoModuleMap" ]; then
    echo "${BUILT_PRODUCTS_DIR}/CommonCryptoModuleMap directory already exists, so skipping the rest of the script."
    exit 0
fi

mkdir -p "${BUILT_PRODUCTS_DIR}/CommonCryptoModuleMap"
cat <<EOF > "${BUILT_PRODUCTS_DIR}/CommonCryptoModuleMap/module.modulemap"
module CommonCrypto [system] {
    header "${SDKROOT}/usr/include/CommonCrypto/CommonCrypto.h"
    export *
}
EOF

使用 shell 代码和 ${SDKROOT} 意味着您不必对 Xcode.app 路径进行硬编码，这可能会因系统而异，尤其是当您使用 xcode-select 切换到测试版或正在构建时在非标准位置安装多个版本的 CI 服务器上。您也不需要对 SDK 进行硬编码，因此这应该适用于 iOS、macOS 等。您也不需要在项目的源目录中放置任何内容。

创建此目标后，使用 Target Dependencies 项使您的库/框架依赖它：

这将确保在构建框架之前生成模块映射。

ma​​cOS 注意：如果您也支持macOS，则需要将macosx 添加到您刚刚创建的新聚合目标的Supported Platforms 构建设置中，否则它不会将模块映射与其他框架产品一起放入正确的Debug 派生数据文件夹中。

接下来，将模块映射的父目录 ${BUILT_PRODUCTS_DIR}/CommonCryptoModuleMap 添加到 Swift 部分 (SWIFT_INCLUDE_PATHS) 下的“导入路径”构建设置：

如果您在项目或 xcconfig 级别定义了搜索路径，请记住添加 $(inherited) 行。

就是这样，你现在应该可以import CommonCrypto

Xcode 10 更新

Xcode 10 现在附带了一个 CommonCrypto 模块映射，因此不需要这种解决方法。如果您想同时支持 Xcode 9 和 10，您可以在运行脚本阶段检查模块映射是否存在，例如

COMMON_CRYPTO_DIR="${SDKROOT}/usr/include/CommonCrypto"
if [ -f "${COMMON_CRYPTO_DIR}/module.modulemap" ]
then
   echo "CommonCrypto already exists, skipping"
else
    # generate the module map, using the original code above
fi

Answer 7

我在 jjrscott 的回答中添加了一些 cocoapods 魔法，以防您需要在 cocoapods 库中使用 CommonCrypto。

---

1) 将此行添加到您的 podspec：

s.script_phase = { :name => 'CommonCrypto', :script => 'sh $PROJECT_DIR/../../install_common_crypto.sh', :execution_position => :before_compile }

2) 将其保存在您的库文件夹或您喜欢的任何位置（但不要忘记相应地更改 script_phase ...）

# This if-statement means we'll only run the main script if the
# CommonCrypto.framework directory doesn't exist because otherwise
# the rest of the script causes a full recompile for anything
# where CommonCrypto is a dependency
# Do a "Clean Build Folder" to remove this directory and trigger
# the rest of the script to run
FRAMEWORK_DIR="${BUILT_PRODUCTS_DIR}/CommonCrypto.framework"

if [ -d "${FRAMEWORK_DIR}" ]; then
echo "${FRAMEWORK_DIR} already exists, so skipping the rest of the script."
exit 0
fi

mkdir -p "${FRAMEWORK_DIR}/Modules"
echo "module CommonCrypto [system] {
    header "${SDKROOT}/usr/include/CommonCrypto/CommonCrypto.h"
    export *
}" >> "${FRAMEWORK_DIR}/Modules/module.modulemap"

ln -sf "${SDKROOT}/usr/include/CommonCrypto" "${FRAMEWORK_DIR}/Headers"

像魅力一样工作:)

Answer 8

我认为我对 Mike Weller 的出色工作有所改进。

在包含此 bash 的 Compile Sources 阶段之前添加一个运行脚本阶段：

# This if-statement means we'll only run the main script if the
# CommonCrypto.framework directory doesn't exist because otherwise
# the rest of the script causes a full recompile for anything
# where CommonCrypto is a dependency
# Do a "Clean Build Folder" to remove this directory and trigger
# the rest of the script to run

FRAMEWORK_DIR="${BUILT_PRODUCTS_DIR}/CommonCrypto.framework"

if [ -d "${FRAMEWORK_DIR}" ]; then
echo "${FRAMEWORK_DIR} already exists, so skipping the rest of the script."
exit 0
fi

mkdir -p "${FRAMEWORK_DIR}/Modules"
cat <<EOF > "${FRAMEWORK_DIR}/Modules/module.modulemap"
module CommonCrypto [system] {
    header "${SDKROOT}/usr/include/CommonCrypto/CommonCrypto.h"
    export *
}
EOF

ln -sf "${SDKROOT}/usr/include/CommonCrypto" "${FRAMEWORK_DIR}/Headers"

此脚本在正确的位置使用 module.map 构建一个简单的框架，然后依赖于 Xcode 自动搜索 BUILT_PRODUCTS_DIR 的框架。

我将原始 CommonCrypto 包含文件夹链接为框架的 Headers 文件夹，因此结果也应该适用于 Objective C 项目。

Answer 9

我发现了一个在 Swift 框架中成功使用 CommonCrypto 的 GitHub 项目：SHA256-Swift。另外，这篇关于the same problem with sqlite3 的文章很有用。

基于以上，步骤为：

1) 在项目目录中创建一个CommonCrypto 目录。在其中创建一个module.map 文件。模块映射将允许我们将 CommonCrypto 库用作 Swift 中的模块。它的内容是：

module CommonCrypto [system] {
    header "/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneSimulator.platform/Developer/SDKs/iPhoneSimulator8.0.sdk/usr/include/CommonCrypto/CommonCrypto.h"
    link "CommonCrypto"
    export *
}

2) 在 Build Settings 中，在 Swift Compiler - Search Paths 中，将 CommonCrypto 目录添加到 Import Paths (SWIFT_INCLUDE_PATHS)。

3) 最后，在您的 Swift 文件中导入 CommonCrypto，作为任何其他模块。例如：

import CommonCrypto

extension String {

    func hnk_MD5String() -> String {
        if let data = self.dataUsingEncoding(NSUTF8StringEncoding)
        {
            let result = NSMutableData(length: Int(CC_MD5_DIGEST_LENGTH))
            let resultBytes = UnsafeMutablePointer<CUnsignedChar>(result.mutableBytes)
            CC_MD5(data.bytes, CC_LONG(data.length), resultBytes)
            let resultEnumerator = UnsafeBufferPointer<CUnsignedChar>(start: resultBytes, length: result.length)
            let MD5 = NSMutableString()
            for c in resultEnumerator {
                MD5.appendFormat("%02x", c)
            }
            return MD5
        }
        return ""
    }
}

限制

在另一个项目中使用自定义框架在编译时失败，错误为missing required module 'CommonCrypto'。这是因为 CommonCrypto 模块似乎没有包含在自定义框架中。一种解决方法是在使用该框架的项目中重复第 2 步（设置 Import Paths）。

模块映射不是独立于平台的（它当前指向一个特定的平台，iOS 8 模拟器）。我不知道如何使标题路径相对于当前平台。

iOS 8 的更新link "CommonCrypto" 行，以获得成功的编译。

更新/编辑

我不断收到以下构建错误：

ld：未找到用于架构 x86_64 的 -lCommonCrypto 的库 clang：错误：链接器命令失败，退出代码为 1（使用 -v 查看调用）

除非我从我创建的module.map 文件中删除了link "CommonCrypto" 行。一旦我删除了这条线，它就可以正常运行了。

Answer 10

警告：iTunesConnect 可能会reject 使用此方法的应用程序。

---

我团队的新成员不小心破坏了其中一个最佳答案给出的解决方案，因此我决定将其整合到一个名为 CommonCryptoModule 的小型包装项目中。您可以手动或通过 Cocoapods 安装它：

pod 'CommonCryptoModule', '~> 1.0.2'

然后，你所要做的就是在你需要CommonCrypto的地方导入模块，像这样：

import CommonCryptoModule

希望其他人觉得这很有用。

Answer 11

这个答案讨论了如何使其在框架内以及 Cocoapods 和 Carthage 中工作

? modulemap 方法

我在 CommonCrypto https://github.com/onmyway133/arcane、https://github.com/onmyway133/Reindeer 的包装器中使用 modulemap

对于那些获得header not found的人，请查看https://github.com/onmyway133/Arcane/issues/4或运行xcode-select --install

• 创建一个文件夹CCommonCrypto，其中包含module.modulemap

    module CCommonCrypto {
      header "/usr/include/CommonCrypto/CommonCrypto.h"
      export *
    }
  

• 转到内置设置 -> 导入路径

    ${SRCROOT}/Sources/CCommonCrypto
  

? 带有模块映射方法的 Cocoapods

• 这是 podspec https://github.com/onmyway133/Arcane/blob/master/Arcane.podspec

    s.source_files = 'Sources/**/*.swift'
    s.xcconfig = { 'SWIFT_INCLUDE_PATHS' =>
    '$(PODS_ROOT)/CommonCryptoSwift/Sources/CCommonCrypto' }
    s.preserve_paths = 'Sources/CCommonCrypto/module.modulemap'
  

• 使用module_map 不起作用，请参阅https://github.com/CocoaPods/CocoaPods/issues/5271

• 通过 path 使用本地开发 Pod 不起作用，请参阅 https://github.com/CocoaPods/CocoaPods/issues/809

• 这就是为什么你看到我的示例 Podfile https://github.com/onmyway133/CommonCrypto.swift/blob/master/Example/CommonCryptoSwiftDemo/Podfile 指向 git 存储库

    target 'CommonCryptoSwiftDemo' do
      pod 'CommonCryptoSwift', :git => 'https://github.com/onmyway133/CommonCrypto.swift'
    end
  

?公共标头方法

• Ji 是 libxml2 的包装器，它使用公共标头方法

• 它有一个头文件https://github.com/honghaoz/Ji/blob/master/Source/Ji.h，其中Target Membership 设置为Public

• 它有一个libxml2的头文件列表https://github.com/honghaoz/Ji/tree/master/Source/Ji-libxml

• 它有构建设置 -> 标题搜索路径

    $(SDKROOT)/usr/include/libxml2
  

• 它有构建设置 -> 其他链接器标志

    -lxml2
  

? 带有公共标头方法的 Cocoapods

• 看看 podspec https://github.com/honghaoz/Ji/blob/master/Ji.podspec

    s.libraries        = "xml2"
    s.xcconfig         = { 'HEADER_SEARCH_PATHS' =>           '$(SDKROOT)/usr/include/libxml2', 'OTHER_LDFLAGS' => '-lxml2' }
  

? 有趣的相关帖子

• How to call C from Swift?
• https://spin.atomicobject.com/2015/02/23/c-libraries-swift/

Answer 12

modulemap 解决方案可以很好，并且对 SDK 更改具有鲁棒性，但我发现它们在实践中使用起来很尴尬，并且在将东西分发给其他人时并不像我希望的那样可靠。为了让这一切变得更加万无一失，我采取了不同的方式：

只需复制标题即可。

我知道，脆弱。但 Apple 几乎从未对 CommonCrypto 做出重大改变，我梦想着他们不会在没有最终使 CommonCrypto 成为模块化标头的情况下以任何重大方式改变它。

“复制标头”是指“将您需要的所有标头剪切并粘贴到项目中的一个大型标头中，就像预处理器所做的那样。”作为您可以复制或改编的示例，请参阅RNCryptor.h。

请注意，所有这些文件均在 APSL 2.0 下获得许可，并且这种方法有意维护版权和许可声明。我的连接步骤已获得 MIT 许可，并且仅适用于下一个许可通知）。

我并不是说这是一个漂亮的解决方案，但到目前为止，它似乎是一个非常简单的实施和支持解决方案。

Answer 13

@mogstad 非常友好地将 @stephencelis 解决方案包装在 Cocoapod 中：

pod 'libCommonCrypto'

其他可用的 pod 对我不起作用。

Answer 14

我知道这是一个老问题。但我想出了一种在 Swift 项目中使用该库的替代方法，这可能对那些不想导入这些答案中介绍的框架的人有所帮助。

在 Swift 项目中，创建一个 Objective-C 桥接头，在 Objective-C 中创建 NSData 类别（或使用该库的自定义类）。唯一的缺点是您必须在 Objective-C 中编写所有实现代码。 例如：

#import "NSData+NSDataEncryptionExtension.h"
#import <CommonCrypto/CommonCryptor.h>

@implementation NSData (NSDataEncryptionExtension)
- (NSData *)AES256EncryptWithKey:(NSString *)key {
    //do something
}

- (NSData *)AES256DecryptWithKey:(NSString *)key {
//do something
}

然后在你的objective-c桥接头中，添加这个

#import "NSData+NSDataEncryptionExtension.h"

然后在 Swift 类中做类似的事情：

public extension String {
func encryp(withKey key:String) -> String? {
    if let data = self.data(using: .utf8), let encrypedData = NSData(data: data).aes256Encrypt(withKey: key) {
        return encrypedData.base64EncodedString()
    }
    return nil
}
func decryp(withKey key:String) -> String? {
    if let data = NSData(base64Encoded: self, options: []), let decrypedData = data.aes256Decrypt(withKey: key) {
        return decrypedData.UTF8String
    }
    return nil
}
}

它按预期工作。

Answer 15

您实际上可以构建一个“正常工作”的解决方案（无需将 module.modulemap 和 SWIFT_INCLUDE_PATHS 设置复制到您的项目中，正如此处其他解决方案所要求的那样），但它确实需要您创建一个虚拟框架/模块，您将正确地导入您的框架。我们还可以确保它不受平台限制（iphoneos、iphonesimulator 或 macosx）。

1. 向您的项目添加一个新的框架目标，并以系统库命名，例如，“CommonCrypto”。 （您可以删除伞形标题 CommonCrypto.h。）

2. 添加一个新的配置设置文件并将其命名，例如，“CommonCrypto.xcconfig”。 （不要检查您的任何目标是否包含在内。）用以下内容填充它：

   MODULEMAP_FILE[sdk=iphoneos*]        = \
       $(SRCROOT)/CommonCrypto/iphoneos.modulemap
   MODULEMAP_FILE[sdk=iphonesimulator*] = \
       $(SRCROOT)/CommonCrypto/iphonesimulator.modulemap
   MODULEMAP_FILE[sdk=macosx*]          = \
       $(SRCROOT)/CommonCrypto/macosx.modulemap
   

3. 创建上面三个引用的模块映射文件，并用以下内容填充它们：

   • iphoneos.modulemap

     module CommonCrypto [system] {
         header "/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS.sdk/usr/include/CommonCrypto/CommonCrypto.h"
         export *
     }
     

   • iphonesimulator.modulemap

     module CommonCrypto [system] {
         header "/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneSimulator.platform/Developer/SDKs/iPhoneSimulator.sdk/usr/include/CommonCrypto/CommonCrypto.h"
         export *
     }
     

   • ma​​cosx.modulemap

     module CommonCrypto [system] {
         header "/Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX10.11.sdk/usr/include/CommonCrypto/CommonCrypto.h"
         export *
     }
     

   （如果您运行的是 beta 版本，请将“Xcode.app”替换为“Xcode-beta.app”。如果未运行 El Capitan，请将 10.11 替换为您当前的 OS SDK。）

4. 在项目设置的 Info 选项卡上的 Configurations 下，设置 Debug 和 Release > CommonCrypto 到 CommonCrypto 的配置（参考 CommonCrypto.xcconfig）。

5. 在框架目标的 Build Phases 选项卡上，将 CommonCrypto 框架添加到 Target Dependencies。此外，将 libcommonCrypto.dylib 添加到 Link Binary With Libraries 构建阶段。

6. 在 Products 中选择 CommonCrypto.framework 并确保您的包装器的 Target Membership 设置为 Optional。

您现在应该能够在您的包装器框架中构建、运行和import CommonCrypto。

例如，查看SQLite.swift 如何使用虚拟 sqlite3.framework。

Answer 16

这很简单。添加

#import <CommonCrypto/CommonCrypto.h>

到 .h 文件（项目的桥接头文件）。作为约定，您可以将其称为 YourProjectName-Bridging-Header.h。

然后转到您的项目 Build Settings 并查找 Swift Compiler - Code Generation。在它下面，将您的桥接头名称添加到条目“Objetive-C Bridging Header”中。

你已经完成了。您的 Swift 代码中不需要导入。此桥接头文件中列出的任何公共 Objective-C 标头对 Swift 都是可见的。