Skip to content

Commit 7749dc3

Browse files
fabianfettfabianfett
committed
Initial commit
0 parents  commit 7749dc3

File tree

8 files changed

+427
-0
lines changed

8 files changed

+427
-0
lines changed

‎.github/workflows/ci.yaml

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
name: CI
2+
on:
3+
push:
4+
branches:
5+
- master
6+
pull_request:
7+
branches:
8+
- master
9+
10+
jobs:
11+
"tuxOS-Tests":
12+
runs-on: ubuntu-latest
13+
strategy:
14+
matrix:
15+
tag: ['5.1']
16+
container:
17+
image: swift:${{ matrix.tag }}
18+
volumes:
19+
- $GITHUB_WORKSPACE:/src
20+
options: --workdir /src
21+
steps:
22+
- name: Checkout
23+
uses: actions/checkout@v1
24+
with:
25+
fetch-depth: 1
26+
- name: Install dependencies
27+
run: apt-get update && apt-get install -y zlib1g-dev zip openssl libssl-dev
28+
- name: Test
29+
run: swift test --enable-code-coverage --enable-test-discovery
30+
- name: Convert coverage files
31+
run: llvm-cov export -format="lcov" .build/debug/swift-base64PackageTests.xctest -instr-profile .build/debug/codecov/default.profdata > info.lcov
32+
- name: Upload to codecov.io
33+
uses: codecov/codecov-action@v1.0.3
34+
with:
35+
token: ${{secrets.CODECOV_TOKEN}}
36+
37+
"macOS-Tests":
38+
runs-on: macOS-latest
39+
steps:
40+
- name: Checkout
41+
uses: actions/checkout@v1
42+
with:
43+
fetch-depth: 1
44+
- name: Show all Xcode versions
45+
run: ls -an /Applications/ | grep Xcode*
46+
- name: Change Xcode command line tools
47+
run: sudo xcode-select -s /Applications/Xcode_11.2.app/Contents/Developer
48+
- name: SPM Build
49+
run: swift build
50+
- name: SPM Tests
51+
run: swift test --parallel -Xswiftc -DDEBUG
52+
- name: Xcode Tests
53+
run: |
54+
swift package generate-xcodeproj
55+
xcodebuild -quiet -parallel-testing-enabled YES -scheme swift-base64-Package -enableCodeCoverage YES build test
56+
- name: Codecov
57+
run: bash <(curl -s https://codecov.io/bash) -J 'Base64' -t ${{secrets.CODECOV_TOKEN}}
58+

‎.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
.DS_Store
2+
.build
3+
/*.xcodeproj
4+
xcuserdata

‎LICENSE

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎Package.swift

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
// swift-tools-version:5.1
2+
// The swift-tools-version declares the minimum version of Swift required to build this package.
3+
4+
import PackageDescription
5+
6+
let package = Package(
7+
name: "swift-base64",
8+
products: [
9+
.library(
10+
name: "Base64",
11+
targets: ["Base64"]),
12+
],
13+
dependencies: [],
14+
targets: [
15+
.target(
16+
name: "Base64",
17+
dependencies: []),
18+
.testTarget(
19+
name: "Base64Tests",
20+
dependencies: ["Base64"]),
21+
]
22+
)

‎README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# swift-base64
2+
3+
[![Swift 5.1](https://img.shields.io/badge/Swift-5.1-blue.svg)](https://swift.org/download/)
4+
[![github-actions](https://github.com/fabianfett/swift-base64/workflows/CI/badge.svg)](https://github.com/fabianfett/swift-base64/actions)
5+
[![codecov](https://codecov.io/gh/fabianfett/swift-base64/branch/master/graph/badge.svg)](https://codecov.io/gh/fabianfett/swift-base64)
6+
![macOS](https://img.shields.io/badge/os-macOS-green.svg?style=flat)
7+
![tuxOS](https://img.shields.io/badge/os-tuxOS-green.svg?style=flat)
8+
9+
The goal of this project is to provide an easy to use base64 encode and decode algorithm
10+
without the use of the Foundation framework.
11+
12+
Everything began with [an issue](https://github.com/apple/swift-nio/issues/1265) on [`swift-nio`](https://github.com/apple/swift-nio).
13+
14+
15+
### Maybe one day, we can make this really swift.
16+
17+
Some literature:
18+
19+
- [Ridiculously fast base64 encoding and decoding - Daniel Lemire's blog](https://lemire.me/blog/2018/01/17/ridiculously-fast-base64-encoding-and-decoding/)

‎Sources/Base64/Base64.swift

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
//===----------------------------------------------------------------------===//
2+
//
3+
// This source file is part of the SwiftNIO open source project
4+
//
5+
// Copyright (c) 2017-2018 Apple Inc. and the SwiftNIO project authors
6+
// Licensed under Apache License v2.0
7+
//
8+
// See LICENSE.txt for license information
9+
// See CONTRIBUTORS.txt for the list of SwiftNIO project authors
10+
//
11+
// SPDX-License-Identifier: Apache-2.0
12+
//
13+
//===----------------------------------------------------------------------===//
14+
15+
// The base64 unicode table.
16+
private let base64Table: [Unicode.Scalar] = [
17+
"A", "B", "C", "D", "E", "F", "G", "H",
18+
"I", "J", "K", "L", "M", "N", "O", "P",
19+
"Q", "R", "S", "T", "U", "V", "W", "X",
20+
"Y", "Z", "a", "b", "c", "d", "e", "f",
21+
"g", "h", "i", "j", "k", "l", "m", "n",
22+
"o", "p", "q", "r", "s", "t", "u", "v",
23+
"w", "x", "y", "z", "0", "1", "2", "3",
24+
"4", "5", "6", "7", "8", "9", "+", "/",
25+
]
26+
27+
extension String {
28+
/// Base64 encode an array of UInt8 to a string, without the use of Foundation.
29+
///
30+
/// This function performs the world's most naive Base64 encoding: no attempts to use a larger
31+
/// lookup table or anything intelligent like that, just shifts and masks. This works fine, for
32+
/// now: the purpose of this encoding is to avoid round-tripping through Data, and the perf gain
33+
/// from avoiding that is more than enough to outweigh the silliness of this code.
34+
public init(base64Encoding array: Array<UInt8>) {
35+
// In Base64, 3 bytes become 4 output characters, and we pad to the nearest multiple
36+
// of four.
37+
var outputString = String()
38+
outputString.reserveCapacity(((array.count + 2) / 3) * 4)
39+
40+
var bytes = array.makeIterator()
41+
while let firstByte = bytes.next() {
42+
let secondByte = bytes.next()
43+
let thirdByte = bytes.next()
44+
outputString.unicodeScalars.append(String.encode(firstByte: firstByte))
45+
outputString.unicodeScalars.append(String.encode(firstByte: firstByte, secondByte: secondByte))
46+
outputString.unicodeScalars.append(String.encode(secondByte: secondByte, thirdByte: thirdByte))
47+
outputString.unicodeScalars.append(String.encode(thirdByte: thirdByte))
48+
}
49+
50+
self = outputString
51+
}
52+
53+
private static func encode(firstByte: UInt8) -> Unicode.Scalar {
54+
let index = firstByte >> 2
55+
return base64Table[Int(index)]
56+
}
57+
58+
private static func encode(firstByte: UInt8, secondByte: UInt8?) -> Unicode.Scalar {
59+
var index = (firstByte & 0b00000011) << 4
60+
if let secondByte = secondByte {
61+
index += (secondByte & 0b11110000) >> 4
62+
}
63+
return base64Table[Int(index)]
64+
}
65+
66+
private static func encode(secondByte: UInt8?, thirdByte: UInt8?) -> Unicode.Scalar {
67+
guard let secondByte = secondByte else {
68+
// No second byte means we are just emitting padding.
69+
return "="
70+
}
71+
var index = (secondByte & 0b00001111) << 2
72+
if let thirdByte = thirdByte {
73+
index += (thirdByte & 0b11000000) >> 6
74+
}
75+
return base64Table[Int(index)]
76+
}
77+
78+
private static func encode(thirdByte: UInt8?) -> Unicode.Scalar {
79+
guard let thirdByte = thirdByte else {
80+
// No third byte means just padding.
81+
return "="
82+
}
83+
let index = thirdByte & 0b00111111
84+
return base64Table[Int(index)]
85+
}
86+
}

0 commit comments

Comments
 (0)