How To Create Ios App Certificate Signing Request (Csr) Without Mac

CertificateSigningRequest

Codecov SPM Version License

Generate a certificate signing request (CSR) in iOS/macOS using Swift.

iOS

Supports RSA (key size: 512, 1024, 2048) and EC inside/outside of secure enclave (iOS only supports 256 bit keys for now), SHA1, SHA256, and SHA512.

macOS

Supports RSA (key size: 1024, 2048) and EC inside/outside of secure enclave, SHA1, SHA256, and SHA512.

Usage

To use, follow the following steps:

Generate your publicKey/privateKey pair. This can be done using Keychain in iOS. An example can be found in the generateKeysAndStoreInKeychain function in the testfile.
Get your publicKey in bits by querying it from the iOS keychain using String(kSecReturnData): true in your query. For example:

                              //Set block size                            let              keyBlockSize              =              SecKeyGetBlockSize(publicKey)                              //Ask keychain to provide the publicKey in bits                            let              query:              [String              :              Any]              =              [              String(kSecClass):              kSecClassKey,              String(kSecAttrKeyType):              algorithm.secKeyAttrType,              String(kSecAttrApplicationTag):              tagPublic.data(using: .utf8)!,              String(kSecReturnData):              true              ]              var              tempPublicKeyBits:CFTypeRef?              var              _              =              SecItemCopyMatching(query              as              CFDictionary,              &tempPublicKeyBits)              guard              let              keyBits              =              tempPublicKeyBits              as?              Data              else              {              return              (nil,nil) }

Initiatlize the CertificateSigningRequest using KeyAlgorithm.ec or KeyAlgorithm.rsa (an example of how to do can be found in the test file. Below are 3 possible ways to initialize:

              let              csr              =              CertificateSigningRequest()                              //CSR with no fields, will use defaults of an RSA key with sha512                            let              algorithm              =              KeyAlgorithm.ec(signatureType: .sha256)              let              csr              =              CertificateSigningRequest(keyAlgorithm: algorithm)                              //CSR with a specific key                                          let              csr              =              CertificateSigningRequest(commonName:              String              ?,              organizationName:              String              ?,              organizationUnitName:              String              ?,              countryName:              String              ?,              stateOrProvinceName:              String              ?,              localityName:              String              ?,              emailAddress:              String              ?,              description:              String              ?,              keyAlgorithm: algorithm)                              //Define any field you want in your CSR along with the key algorithm

Then simply build your CSR using your publicKey(bits) and privateKey using:

              let              builtCSR              =              csr.buildCSRAndReturnString(publicKeyBits,              privateKey: privateKey)                              //Or if you want `CertificateSigningRequest` to verify the signature after building, pass in your publicKey to the same method:                            let              builtCSR              =              csr.buildCSRAndReturnString(publicKeyBits,              privateKey: privateKey,              publicKey: publicKey)

Two other methods are available depending on your needs.
To get CSR without header and footer info use: let builtCSR = csr.buildAndEncodeDataAsString(publicKeyBits, privateKey: privateKey).
To get CSR as Data use: let builtCSR = csr.build(publicKeyBits, privateKey: privateKey).

Note:

You can test if your CSRs are correct by running and setting a break point the test file. You can also let all test run and test the different CSR's. The output of the CSR will print in the console window. You can output the CSR's and your own app by printing to the console and check if they are created correctly by pasting them here: https://redkestrel.co.uk/products/decoder/ or by using openssl.

Example

To run the example project, clone the repo, and run pod install from the Example directory first. An example certificate from this framework is below:

You can test if the CSR was created correctly here: https://redkestrel.co.uk/products/decoder/

Requirements

iOS 10+
mac OS 10.13+

Installation

Swift Package Manager (SPM) - Option 1

CertificateSigningRequest can be installed via SPM. Open an existing project or create a new Xcode project and navigate to File > Swift Packages > Add Package Dependency. Enter the url https://github.com/cbaker6/CertificateSigningRequest.git and tap Next. Choose the main branch, and on the next screen, check off the package.

Cocoapods - Option 2

CertificateSigningRequest is available through CocoaPods. To install it, simply add the following line to your Podfile:

              pod              'CertificateSigningRequest'

Embedded Framework - Option 3

If you would like to use as a framework, clone and build the project, look under frameworks, and drag "CertificateSigningRequest.framework" into "Frameworks" section of your project, "check copy if needed".

In your project Targets, click on "General", make sure "CertificateSigningRequest.framework" shows up under "Embedded Binaries" and it should automatically appear in "Linked Frameworks and Libraries"
Then, simply place import CertificateSigningRequest at the top of any file that needs the framework.

Author

cbaker6, [email protected]

License

Components of CertificateSigningRequest was originally in ios-csr by Ales Teska written in Objective-C and ported by the author of CertificateSigningRequest to Swift. Therefore CertificateSigningRequest has the same GPLv2 license. See the LICENSE file for more info.