Mengimpor CommonCrypto dalam kerangka kerja Swift

Bagaimana Anda mengimpor CommonCryptodalam kerangka kerja Swift untuk iOS?

Saya mengerti cara menggunakan CommonCryptodi aplikasi Swift: Anda menambah #import <CommonCrypto/CommonCrypto.h>header penghubung. Namun, kerangka kerja Swift tidak mendukung bridging header. The dokumentasi mengatakan:

Anda dapat mengimpor kerangka kerja eksternal yang memiliki basis kode Objective-C murni, basis kode Swift murni, atau basis kode bahasa campuran. Proses untuk mengimpor kerangka kerja eksternal adalah sama apakah kerangka kerja ditulis dalam satu bahasa atau berisi file dari kedua bahasa. Saat Anda mengimpor kerangka kerja eksternal, pastikan pengaturan Tentukan modul untuk kerangka kerja yang Anda impor diatur ke Ya.

Anda dapat mengimpor kerangka kerja ke file Swift apa pun dalam target yang berbeda menggunakan sintaks berikut:

import FrameworkName

Sayangnya, impor CommonCryptotidak berfungsi. Juga tidak menambah #import <CommonCrypto/CommonCrypto.h>header payung.

Sesuatu yang sedikit lebih sederhana dan lebih kuat adalah membuat target Agregat yang disebut "CommonCryptoModuleMap" dengan fase Run Script untuk menghasilkan peta modul secara otomatis dan dengan jalur Xcode / SDK yang benar:

Fase Run Script harus mengandung bash ini:

# 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

Menggunakan kode shell dan ${SDKROOT}berarti Anda tidak perlu membuat kode jalur Xcode.app yang sulit yang dapat memvariasikan sistem-ke-sistem, terutama jika Anda menggunakan xcode-selectuntuk beralih ke versi beta, atau sedang membangun pada server CI di mana banyak versi diinstal di lokasi yang tidak standar. Anda juga tidak perlu membuat kode SDK jadi ini harus bekerja untuk iOS, macOS, dll. Anda juga tidak perlu memiliki apa pun yang duduk di direktori sumber proyek Anda.

Setelah membuat target ini, buat perpustakaan / kerangka kerja Anda bergantung padanya dengan item Ketergantungan Target:

Ini akan memastikan peta modul dihasilkan sebelum kerangka kerja Anda dibuat.

catatan macOS : Jika Anda mendukung macOSjuga, Anda harus menambahkan macosxke Supported Platformspengaturan build pada target agregat baru yang baru saja Anda buat, jika tidak, ia tidak akan menempatkan peta modul dalam Debugfolder data turunan yang benar dengan sisa dari produk kerangka kerja.

Selanjutnya, tambahkan direktori induk peta modul ${BUILT_PRODUCTS_DIR}/CommonCryptoModuleMap,, ke pengaturan build "Import Paths" di bawah bagian Swift ( SWIFT_INCLUDE_PATHS):

Ingatlah untuk menambahkan $(inherited)baris jika Anda memiliki jalur pencarian yang ditentukan pada level proyek atau xcconfig.

Itu saja, Anda sekarang harus bisa import CommonCrypto

Pembaruan untuk Xcode 10

Xcode 10 sekarang dikirimkan dengan peta modul CommonCrypto yang menjadikan penyelesaian ini tidak perlu. Jika Anda ingin mendukung Xcode 9 dan 10, Anda dapat melakukan pemeriksaan pada fase Run Script untuk melihat apakah peta modul ada atau tidak, misalnya

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

Anda sebenarnya dapat membangun solusi yang "hanya berfungsi" (tidak perlu menyalin module.modulemap dan SWIFT_INCLUDE_PATHSpengaturan ke proyek Anda, seperti yang dipersyaratkan oleh solusi lain di sini), tetapi itu memang mengharuskan Anda untuk membuat kerangka kerja / modul yang Anda inginkan. akan mengimpor ke dalam kerangka kerja Anda dengan tepat. Kami juga bisa memastikan bekerja terlepas dari platform ( iphoneos, iphonesimulator, atau macosx).

1. Tambahkan target kerangka kerja baru ke proyek Anda dan beri nama setelah pustaka sistem, misalnya , "CommonCrypto". (Anda dapat menghapus header payung, CommonCrypto.h .)

2. Tambahkan File Pengaturan Konfigurasi baru dan beri nama, misalnya , "CommonCrypto.xcconfig". (Jangan periksa target Anda untuk dimasukkan.) Isi dengan yang berikut ini:

   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. Buat tiga file peta modul referensi, di atas, dan isi dengan yang berikut:

   • 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 *
     }

   • macosx.modulemap

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

   (Ganti "Xcode.app" dengan "Xcode-beta.app" jika Anda menjalankan versi beta. Ganti 10.11dengan OSKK Anda saat ini jika tidak menjalankan El Capitan.)

4. Pada tab Info pada pengaturan proyek Anda, di bawah Konfigurasi , atur konfigurasi Debug dan Release dari CommonCrypto ke CommonCrypto (merujuk CommonCrypto.xcconfig ).

5. Pada tab Bangun fase target kerangka kerja Anda , tambahkan kerangka CommonCrypto ke Ketergantungan Target . Selain itu tambahkan libcommonCrypto.dylib ke fase pembuatan Link Binary With Libraries .

6. Pilih CommonCrypto.framework dalam Produk dan pastikan Keanggotaan Targetnya untuk pembungkus Anda diatur ke Opsional .

Anda sekarang seharusnya bisa membangun, menjalankan dan import CommonCryptodalam kerangka pembungkus Anda.

Sebagai contoh, lihat bagaimana SQLite.swift menggunakan dummy sqlite3.framework .

Saya menemukan proyek GitHub yang berhasil menggunakan CommonCrypto dalam kerangka kerja Swift: SHA256-Swift . Juga, artikel ini tentang masalah yang sama dengan sqlite3 bermanfaat.

Berdasarkan hal di atas, langkah-langkahnya adalah:

1) Buat CommonCryptodirektori di dalam direktori proyek. Di dalam, buat module.mapfile. Peta modul akan memungkinkan kita untuk menggunakan perpustakaan CommonCrypto sebagai modul dalam Swift. Isinya adalah:

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) Dalam Pengaturan Bangun, di dalam Swift Compiler - Jalur Pencarian , tambahkan CommonCryptodirektori ke Jalur Impor ( SWIFT_INCLUDE_PATHS).

3) Akhirnya, impor CommonCrypto ke dalam file Swift Anda seperti modul lainnya. Sebagai contoh:

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 ""
    }
}

Keterbatasan

Menggunakan kerangka kerja kustom di proyek lain gagal pada waktu kompilasi dengan kesalahan missing required module 'CommonCrypto'. Ini karena modul CommonCrypto tampaknya tidak disertakan dengan kerangka kerja kustom. Solusinya adalah mengulangi langkah 2 (pengaturan Import Paths) dalam proyek yang menggunakan kerangka kerja.

Peta modul bukan platform independen (saat ini menunjuk ke platform tertentu, iOS 8 Simulator). Saya tidak tahu cara membuat jalur tajuk relatif terhadap platform saat ini.

Pembaruan untuk iOS 8 <= Kami harus menghapus tautan baris "CommonCrypto" , untuk mendapatkan kompilasi yang berhasil.

UPDATE / EDIT

Saya terus mendapatkan galat build berikut:

ld: library tidak ditemukan untuk -lCommonCrypto untuk arsitektur x86_64 clang: error: perintah linker gagal dengan kode keluar 1 (gunakan -v untuk melihat doa)

Kecuali saya menghapus baris link "CommonCrypto"dari module.mapfile yang saya buat. Setelah saya menghapus baris ini, itu dibangun ok.

Jawaban ini membahas cara membuatnya bekerja di dalam kerangka kerja, dan dengan Cocoapods dan Carthage

🐟 pendekatan modulemap

Saya menggunakan modulemappembungkus saya di sekitar CommonCrypto https://github.com/onmyway133/arcane , https://github.com/onmyway133/Reindeer

Untuk yang mendapatkannya header not found, silakan lihat https://github.com/onmyway133/Arcane/issues/4 atau jalankanxcode-select --install

• Buat folder yang CCommonCryptoberisimodule.modulemap

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

• Pergi ke Pengaturan Dibangun -> Impor Jalur

    ${SRCROOT}/Sources/CCommonCrypto

🌳 Cocoapods dengan pendekatan modulemap

• Ini adalah 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'

• Menggunakan module_maptidak berfungsi, lihat https://github.com/CocoaPods/CocoaPods/issues/5271

• Menggunakan Pod Pengembangan Lokal dengan pathtidak berfungsi, lihat https://github.com/CocoaPods/CocoaPods/issues/809

• Itu sebabnya Anda melihat bahwa Contoh Podfile saya https://github.com/onmyway133/CommonCrypto.swift/blob/master/Example/CommonCryptoSwiftDemo/Podfile menunjuk ke git repo

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

🐘 pendekatan tajuk publik

• Ji adalah pembungkus di sekitar libxml2, dan menggunakan pendekatan header publik

• Ini memiliki file header https://github.com/honghaoz/Ji/blob/master/Source/Ji.h denganTarget Membership set kePublic

• Ini memiliki daftar file header untuk libxml2 https://github.com/honghaoz/Ji/tree/master/Source/Ji-libxml

• Ini memiliki Pengaturan Bangun -> Jalur Pencarian Header

    $(SDKROOT)/usr/include/libxml2

• Ini memiliki Pengaturan Bangun -> Bendera Penghubung Lainnya

    -lxml2

🐏 Cocoapods dengan pendekatan tajuk publik

• Lihatlah 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' }

🐝 Posting terkait yang menarik

• Bagaimana cara memanggil C dari Swift?
• https://spin.atomicobject.com/2015/02/23/c-libraries-swift/

Kabar baik! Swift 4.2 (Xcode 10) akhirnya menyediakan CommonCrypto!

Cukup tambahkan import CommonCryptofile cepat Anda.

PERINGATAN: iTunesConnect dapat menolak aplikasi yang menggunakan metode ini.

Anggota baru di tim saya secara tidak sengaja memecahkan solusi yang diberikan oleh salah satu jawaban teratas, jadi saya memutuskan untuk mengkonsolidasikannya dalam proyek pembungkus kecil yang disebut CommonCryptoModule . Anda dapat menginstalnya secara manual atau melalui Cocoapods:

pod 'CommonCryptoModule', '~> 1.0.2'

Kemudian, yang harus Anda lakukan adalah mengimpor modul di tempat yang Anda butuhkan CommonCrypto, seperti:

import CommonCryptoModule

Semoga orang lain menemukan ini berguna.

Saya pikir saya memiliki peningkatan pada karya Mike Weller yang sangat baik.

Tambahkan fase Run Script sebelum Compile Sources fase yang mengandung bash ini:

# 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"

Script ini membangun kerangka tulang kosong dengan module.map di tempat yang benar dan kemudian bergantung pada pencarian otomatis Xcode untuk BUILT_PRODUCTS_DIR kerangka kerja .

Saya menautkan folder asli CommonCrypto sebagai folder Header kerangka kerja sehingga hasilnya juga berfungsi untuk proyek Objective C.

Bagi siapa pun yang menggunakan swift 4.2 dengan Xcode 10 :

Modul CommonCrypto sekarang disediakan oleh sistem, sehingga Anda dapat langsung mengimpornya seperti kerangka kerja sistem lainnya.

import CommonCrypto

@mogstad telah berbaik hati untuk membungkus solusi @stephencelis dalam Cocoapod:

pod 'libCommonCrypto'

Pod lain yang tersedia tidak berfungsi untuk saya.

Solusi modulemap bisa bagus, dan kuat terhadap perubahan SDK, tapi saya merasa canggung untuk digunakan dalam praktik, dan tidak dapat diandalkan seperti yang saya inginkan saat membagikan sesuatu kepada orang lain. Untuk membuatnya lebih mudah, saya pergi dengan cara yang berbeda:

Cukup salin tajuknya.

Saya tahu, rapuh. Tetapi Apple hampir tidak pernah membuat perubahan signifikan pada CommonCrypto dan saya hidup dalam mimpi bahwa mereka tidak akan mengubahnya dengan cara yang signifikan tanpa akhirnya membuat CommonCrypto menjadi header modular.

Dengan "salin tajuk" Maksud saya "memotong dan menempelkan semua tajuk yang Anda butuhkan menjadi satu tajuk besar dalam proyek Anda seperti yang akan dilakukan oleh preprosesor." Sebagai contoh ini yang bisa Anda salin atau adaptasi, lihat RNCryptor.h .

Perhatikan bahwa semua file ini dilisensikan di bawah APSL 2.0, dan pendekatan ini sengaja mempertahankan pemberitahuan hak cipta dan lisensi. Langkah penggabungan saya dilisensikan di bawah MIT, dan itu hanya berlaku hingga pemberitahuan lisensi berikutnya).

Saya tidak mengatakan ini adalah solusi yang indah, tetapi sejauh ini tampaknya telah menjadi solusi yang sangat sederhana baik untuk implementasi maupun dukungan.

Saya tahu ini adalah pertanyaan lama. Tetapi saya menemukan cara alternatif untuk menggunakan perpustakaan di proyek Swift, yang mungkin bermanfaat bagi mereka yang tidak ingin mengimpor kerangka kerja yang diperkenalkan dalam jawaban ini.

Di proyek Swift, buat header bridging Objective-C, buat kategori NSData (atau kelas kustom yang menggunakan perpustakaan) di Objective-C. Satu-satunya kelemahan adalah bahwa Anda harus menulis semua kode implementasi di Objective-C. Sebagai contoh:

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

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

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

Dan kemudian di header bridging objektif-c Anda, tambahkan ini

#import "NSData+NSDataEncryptionExtension.h"

Dan kemudian di kelas Swift melakukan hal serupa:

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
}
}

Ini berfungsi seperti yang diharapkan.

Saya telah menambahkan beberapa sulap cocoapods ke jawaban jjrscott jika Anda perlu menggunakan CommonCrypto di perpustakaan cocoapods Anda.

1) Tambahkan baris ini ke podspec Anda:

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

2) Simpan ini di folder perpustakaan Anda atau di mana pun Anda suka (namun jangan lupa untuk mengubah script_phase yang sesuai ...)

# 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"

Bekerja seperti pesona :)

Saya tidak yakin apakah ada yang berubah dengan Xcode 9.2 tetapi sekarang jauh lebih mudah untuk mencapai ini. Satu-satunya hal yang harus saya lakukan adalah membuat folder bernama "CommonCrypto" di direktori proyek kerangka kerja saya dan membuat dua file di dalamnya, satu disebut "cc.h" sebagai berikut:

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

Dan modul.modulemap lain yang disebut:

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

(Saya tidak tahu mengapa Anda tidak bisa mereferensikan file header dari area SDKROOT langsung dalam file modulemap tapi saya tidak bisa membuatnya berfungsi)

Yang ketiga adalah menemukan pengaturan "Import Paths" dan set ke $ (SRCROOT). Bahkan Anda dapat mengaturnya ke folder apa pun yang Anda inginkan folder CommonCrypto berada di bawah, jika Anda tidak menginginkannya di tingkat root.

Setelah ini, Anda harus dapat menggunakannya

import CommonCrypto

Dalam setiap file cepat dan semua jenis / fungsi / dll. tersedia.

Namun, kata peringatan - jika aplikasi Anda menggunakan libCommonCrypto (atau libcoreCrypto), sangat mudah bagi peretas yang tidak terlalu canggih untuk melampirkan debugger ke aplikasi Anda dan mencari tahu kunci apa yang sedang diteruskan ke fungsi-fungsi ini.

Jika Anda memiliki masalah di bawah ini:

ld: library tidak ditemukan untuk -lapple_crypto clang: error: perintah linker gagal dengan kode keluar 1 (gunakan -v untuk melihat doa)

Dalam Xcode 10, Swift 4.0. CommonCrypto adalah bagian dari framework.

Menambahkan

 import CommonCrypto

Menghapus

• File lib CommonCrpto dari tautan biner dengan pustaka dari fase Build
• import CommonCrypto dari Bridging header

Ini berhasil untuk saya!

Itu terjadi sama dengan saya setelah memperbarui Xcode. Saya mencoba semua yang bisa saya lakukan seperti menginstal ulang cocoapods dan membersihkan proyek, tetapi tidak berhasil. Sekarang sudah terpecahkan setelah restart sistem.

Ini sangat sederhana. Menambahkan

#import <CommonCrypto/CommonCrypto.h>

ke file .h (file header bridging proyek Anda). Sebagai sebuah konvensi, Anda dapat menyebutnya YourProjectName-Bridging-Header.h.

Lalu pergi ke Pengaturan Bangun proyek Anda dan cari Swift Compiler - Pembuatan Kode. Di bawahnya, tambahkan nama header bridging Anda ke entri "Objetive-C Bridging Header".

Kamu sudah selesai. Tidak diperlukan impor dalam kode Swift Anda. Setiap header Objective-C publik yang tercantum dalam file header bridging ini akan terlihat oleh Swift.