diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml new file mode 100644 index 0000000..24664ff --- /dev/null +++ b/.github/workflows/ci.yaml @@ -0,0 +1,58 @@ +name: CI +on: + push: + branches: + - master + pull_request: + branches: + - master + +jobs: + "tuxOS-Tests": + runs-on: ubuntu-latest + strategy: + matrix: + tag: ['5.1'] + container: + image: swift:${{ matrix.tag }} + volumes: + - $GITHUB_WORKSPACE:/src + options: --workdir /src + steps: + - name: Checkout + uses: actions/checkout@v1 + with: + fetch-depth: 1 + - name: Install dependencies + run: apt-get update && apt-get install -y zlib1g-dev zip openssl libssl-dev + - name: Test + run: swift test --enable-code-coverage --enable-test-discovery + - name: Convert coverage files + run: llvm-cov export -format="lcov" .build/debug/swift-base64PackageTests.xctest -instr-profile .build/debug/codecov/default.profdata > info.lcov + - name: Upload to codecov.io + uses: codecov/codecov-action@v1.0.3 + with: + token: ${{secrets.CODECOV_TOKEN}} + + "macOS-Tests": + runs-on: macOS-latest + steps: + - name: Checkout + uses: actions/checkout@v1 + with: + fetch-depth: 1 + - name: Show all Xcode versions + run: ls -an /Applications/ | grep Xcode* + - name: Change Xcode command line tools + run: sudo xcode-select -s /Applications/Xcode_11.2.app/Contents/Developer + - name: SPM Build + run: swift build + - name: SPM Tests + run: swift test --parallel -Xswiftc -DDEBUG + - name: Xcode Tests + run: | + swift package generate-xcodeproj + xcodebuild -quiet -parallel-testing-enabled YES -scheme swift-base64-Package -enableCodeCoverage YES build test + - name: Codecov + run: bash <(curl -s https://codecov.io/bash) -J 'Base64' -t ${{secrets.CODECOV_TOKEN}} + diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..659665b --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +.DS_Store +.build +/*.xcodeproj +xcuserdata diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/Package.swift b/Package.swift new file mode 100644 index 0000000..d3c0a80 --- /dev/null +++ b/Package.swift @@ -0,0 +1,22 @@ +// swift-tools-version:5.1 +// The swift-tools-version declares the minimum version of Swift required to build this package. + +import PackageDescription + +let package = Package( + name: "swift-base64", + products: [ + .library( + name: "Base64", + targets: ["Base64"]), + ], + dependencies: [], + targets: [ + .target( + name: "Base64", + dependencies: []), + .testTarget( + name: "Base64Tests", + dependencies: ["Base64"]), + ] +) diff --git a/README.md b/README.md new file mode 100644 index 0000000..1ef7f24 --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +# swift-base64 + +[![Swift 5.1](https://img.shields.io/badge/Swift-5.1-blue.svg)](https://swift.org/download/) +[![github-actions](https://github.com/fabianfett/swift-base64/workflows/CI/badge.svg)](https://github.com/fabianfett/swift-base64/actions) +[![codecov](https://codecov.io/gh/fabianfett/swift-base64/branch/master/graph/badge.svg)](https://codecov.io/gh/fabianfett/swift-base64) +![macOS](https://img.shields.io/badge/os-macOS-green.svg?style=flat) +![tuxOS](https://img.shields.io/badge/os-tuxOS-green.svg?style=flat) + +The goal of this project is to provide an easy to use base64 encode and decode algorithm +without the use of the Foundation framework. + +Everything began with [an issue](https://github.com/apple/swift-nio/issues/1265) on [`swift-nio`](https://github.com/apple/swift-nio). + + +### Maybe one day, we can make this really swift. + +Some literature: + +- [Ridiculously fast base64 encoding and decoding - Daniel Lemire's blog](https://lemire.me/blog/2018/01/17/ridiculously-fast-base64-encoding-and-decoding/) diff --git a/Sources/Base64/Base64.swift b/Sources/Base64/Base64.swift new file mode 100644 index 0000000..2266da3 --- /dev/null +++ b/Sources/Base64/Base64.swift @@ -0,0 +1,86 @@ +//===----------------------------------------------------------------------===// +// +// This source file is part of the SwiftNIO open source project +// +// Copyright (c) 2017-2018 Apple Inc. and the SwiftNIO project authors +// Licensed under Apache License v2.0 +// +// See LICENSE.txt for license information +// See CONTRIBUTORS.txt for the list of SwiftNIO project authors +// +// SPDX-License-Identifier: Apache-2.0 +// +//===----------------------------------------------------------------------===// + +// The base64 unicode table. +private let base64Table: [Unicode.Scalar] = [ + "A", "B", "C", "D", "E", "F", "G", "H", + "I", "J", "K", "L", "M", "N", "O", "P", + "Q", "R", "S", "T", "U", "V", "W", "X", + "Y", "Z", "a", "b", "c", "d", "e", "f", + "g", "h", "i", "j", "k", "l", "m", "n", + "o", "p", "q", "r", "s", "t", "u", "v", + "w", "x", "y", "z", "0", "1", "2", "3", + "4", "5", "6", "7", "8", "9", "+", "/", +] + +extension String { + /// Base64 encode an array of UInt8 to a string, without the use of Foundation. + /// + /// This function performs the world's most naive Base64 encoding: no attempts to use a larger + /// lookup table or anything intelligent like that, just shifts and masks. This works fine, for + /// now: the purpose of this encoding is to avoid round-tripping through Data, and the perf gain + /// from avoiding that is more than enough to outweigh the silliness of this code. + public init(base64Encoding array: Array) { + // In Base64, 3 bytes become 4 output characters, and we pad to the nearest multiple + // of four. + var outputString = String() + outputString.reserveCapacity(((array.count + 2) / 3) * 4) + + var bytes = array.makeIterator() + while let firstByte = bytes.next() { + let secondByte = bytes.next() + let thirdByte = bytes.next() + outputString.unicodeScalars.append(String.encode(firstByte: firstByte)) + outputString.unicodeScalars.append(String.encode(firstByte: firstByte, secondByte: secondByte)) + outputString.unicodeScalars.append(String.encode(secondByte: secondByte, thirdByte: thirdByte)) + outputString.unicodeScalars.append(String.encode(thirdByte: thirdByte)) + } + + self = outputString + } + + private static func encode(firstByte: UInt8) -> Unicode.Scalar { + let index = firstByte >> 2 + return base64Table[Int(index)] + } + + private static func encode(firstByte: UInt8, secondByte: UInt8?) -> Unicode.Scalar { + var index = (firstByte & 0b00000011) << 4 + if let secondByte = secondByte { + index += (secondByte & 0b11110000) >> 4 + } + return base64Table[Int(index)] + } + + private static func encode(secondByte: UInt8?, thirdByte: UInt8?) -> Unicode.Scalar { + guard let secondByte = secondByte else { + // No second byte means we are just emitting padding. + return "=" + } + var index = (secondByte & 0b00001111) << 2 + if let thirdByte = thirdByte { + index += (thirdByte & 0b11000000) >> 6 + } + return base64Table[Int(index)] + } + + private static func encode(thirdByte: UInt8?) -> Unicode.Scalar { + guard let thirdByte = thirdByte else { + // No third byte means just padding. + return "=" + } + let index = thirdByte & 0b00111111 + return base64Table[Int(index)] + } +} diff --git a/Tests/Base64Tests/Base64Tests.swift b/Tests/Base64Tests/Base64Tests.swift new file mode 100644 index 0000000..737125f --- /dev/null +++ b/Tests/Base64Tests/Base64Tests.swift @@ -0,0 +1,36 @@ +//===----------------------------------------------------------------------===// +// +// This source file is part of the SwiftNIO open source project +// +// Copyright (c) 2017-2018 Apple Inc. and the SwiftNIO project authors +// Licensed under Apache License v2.0 +// +// See LICENSE.txt for license information +// See CONTRIBUTORS.txt for the list of SwiftNIO project authors +// +// SPDX-License-Identifier: Apache-2.0 +// +//===----------------------------------------------------------------------===// + +import XCTest +@testable import Base64 + +class Base64Test: XCTestCase { + func testEncodeEmptyData() throws { + let data = [UInt8]() + let encodedData = String(base64Encoding: data) + XCTAssertEqual(encodedData.count, 0) + } + + func testBase64EncodingArrayOfNulls() throws { + let data = Array(repeating: UInt8(0), count: 10) + let encodedData = String(base64Encoding: data) + XCTAssertEqual(encodedData, "AAAAAAAAAAAAAA==") + } + + func testBase64EncodingAllTheBytesSequentially() throws { + let data = Array(UInt8(0)...UInt8(255)) + let encodedData = String(base64Encoding: data) + XCTAssertEqual(encodedData, "AAECAwQFBgcICQoLDA0ODxAREhMUFRYXGBkaGxwdHh8gISIjJCUmJygpKissLS4vMDEyMzQ1Njc4OTo7PD0+P0BBQkNERUZHSElKS0xNTk9QUVJTVFVWV1hZWltcXV5fYGFiY2RlZmdoaWprbG1ub3BxcnN0dXZ3eHl6e3x9fn+AgYKDhIWGh4iJiouMjY6PkJGSk5SVlpeYmZqbnJ2en6ChoqOkpaanqKmqq6ytrq+wsbKztLW2t7i5uru8vb6/wMHCw8TFxsfIycrLzM3Oz9DR0tPU1dbX2Nna29zd3t/g4eLj5OXm5+jp6uvs7e7v8PHy8/T19vf4+fr7/P3+/w==") + } +} diff --git a/Tests/LinuxMain.swift b/Tests/LinuxMain.swift new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/Tests/LinuxMain.swift @@ -0,0 +1 @@ +