diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000000000000000000000000000000000000..403c8ef104b8bf3476b7a5155be3158eae28734e --- /dev/null +++ b/.gitattributes @@ -0,0 +1,3 @@ +* text=auto +*.zig text eol=lf +zigmod.* text eol=lf diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000000000000000000000000000000000000..755aa68f03a30361a954cb1bfbf823ba9fa604ae --- /dev/null +++ b/.gitignore @@ -0,0 +1,6 @@ +.zig-cache +zig-out +.zigmod +deps.zig +files.zig +zigmod.lock diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000000000000000000000000000000000000..c3c054f8a15f0007a70eab1ddf01bf95c0858bed --- /dev/null +++ b/LICENSE @@ -0,0 +1,307 @@ +Mozilla Public License Version 2.0 + +1. Definitions + + 1.1. "Contributor" means each individual or legal entity that creates, +contributes to the creation of, or owns Covered Software. + + 1.2. "Contributor Version" means the combination of the Contributions of +others (if any) used by a Contributor and that particular Contributor's +Contribution. + + 1.3. "Contribution" means Covered Software of a particular Contributor. + + 1.4. "Covered Software" means Source Code Form to which the initial +Contributor has attached the notice in Exhibit A, the Executable Form of such +Source Code Form, and Modifications of such Source Code Form, in each case +including portions thereof. + + 1.5. "Incompatible With Secondary Licenses" means + + (a) that the initial Contributor has attached the notice described +in Exhibit B to the Covered Software; or + + (b) that the Covered Software was made available under the terms of +version 1.1 or earlier of the License, but not also under the terms of a +Secondary License. + + 1.6. "Executable Form" means any form of the work other than Source Code +Form. + + 1.7. "Larger Work" means a work that combines Covered Software with other +material, in a separate file or files, that is not Covered Software. + + 1.8. "License" means this document. + + 1.9. "Licensable" means having the right to grant, to the maximum extent +possible, whether at the time of the initial grant or subsequently, any and +all of the rights conveyed by this License. + + 1.10. "Modifications" means any of the following: + + (a) any file in Source Code Form that results from an addition to, +deletion from, or modification of the contents of Covered Software; or + + (b) any new file in Source Code Form that contains any Covered +Software. + + 1.11. "Patent Claims" of a Contributor means any patent claim(s), +including without limitation, method, process, and apparatus claims, in any +patent Licensable by such Contributor that would be infringed, but for the +grant of the License, by the making, using, selling, offering for sale, having +made, import, or transfer of either its Contributions or its Contributor +Version. + + 1.12. "Secondary License" means either the GNU General Public License, +Version 2.0, the GNU Lesser General Public License, Version 2.1, the GNU +Affero General Public License, Version 3.0, or any later versions of those +licenses. + + 1.13. "Source Code Form" means the form of the work preferred for making +modifications. + + 1.14. "You" (or "Your") means an individual or a legal entity exercising +rights under this License. For legal entities, "You" includes any entity that +controls, is controlled by, or is under common control with You. For purposes +of this definition, "control" means (a) the power, direct or indirect, to +cause the direction or management of such entity, whether by contract or +otherwise, or (b) ownership of more than fifty percent (50%) of the +outstanding shares or beneficial ownership of such entity. + +2. License Grants and Conditions + + 2.1. Grants + Each Contributor hereby grants You a world-wide, royalty-free, +non-exclusive license: + + (a) under intellectual property rights (other than patent or +trademark) Licensable by such Contributor to use, reproduce, make available, +modify, display, perform, distribute, and otherwise exploit its Contributions, +either on an unmodified basis, with Modifications, or as part of a Larger +Work; and + + (b) under Patent Claims of such Contributor to make, use, sell, +offer for sale, have made, import, and otherwise transfer either its +Contributions or its Contributor Version. + + 2.2. Effective Date + The licenses granted in Section 2.1 with respect to any Contribution +become effective for each Contribution on the date the Contributor first +distributes such Contribution. + + 2.3. Limitations on Grant Scope + The licenses granted in this Section 2 are the only rights granted under +this License. No additional rights or licenses will be implied from the +distribution or licensing of Covered Software under this License. +Notwithstanding Section 2.1(b) above, no patent license is granted by a +Contributor: + + (a) for any code that a Contributor has removed from Covered +Software; or + + (b) for infringements caused by: (i) Your and any other third +party's modifications of Covered Software, or (ii) the combination of its +Contributions with other software (except as part of its Contributor Version); +or + + (c) under Patent Claims infringed by Covered Software in the absence +of its Contributions. + + This License does not grant any rights in the trademarks, service marks, +or logos of any Contributor (except as may be necessary to comply with the +notice requirements in Section 3.4). + + 2.4. Subsequent Licenses + No Contributor makes additional grants as a result of Your choice to +distribute the Covered Software under a subsequent version of this License +(see Section 10.2) or under the terms of a Secondary License (if permitted +under the terms of Section 3.3). + + 2.5. Representation + Each Contributor represents that the Contributor believes its +Contributions are its original creation(s) or it has sufficient rights to +grant the rights to its Contributions conveyed by this License. + + 2.6. Fair Use + This License is not intended to limit any rights You have under +applicable copyright doctrines of fair use, fair dealing, or other +equivalents. + + 2.7. Conditions + Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted in +Section 2.1. + +3. Responsibilities + + 3.1. Distribution of Source Form + All distribution of Covered Software in Source Code Form, including any +Modifications that You create or to which You contribute, must be under the +terms of this License. You must inform recipients that the Source Code Form of +the Covered Software is governed by the terms of this License, and how they +can obtain a copy of this License. You may not attempt to alter or restrict +the recipients' rights in the Source Code Form. + + 3.2. Distribution of Executable Form + If You distribute Covered Software in Executable Form then: + + (a) such Covered Software must also be made available in Source Code +Form, as described in Section 3.1, and You must inform recipients of the +Executable Form how they can obtain a copy of such Source Code Form by +reasonable means in a timely manner, at a charge no more than the cost of +distribution to the recipient; and + + (b) You may distribute such Executable Form under the terms of this +License, or sublicense it under different terms, provided that the license for +the Executable Form does not attempt to limit or alter the recipients' rights +in the Source Code Form under this License. + + 3.3. Distribution of a Larger Work + You may create and distribute a Larger Work under terms of Your choice, +provided that You also comply with the requirements of this License for the +Covered Software. If the Larger Work is a combination of Covered Software with +a work governed by one or more Secondary Licenses, and the Covered Software is +not Incompatible With Secondary Licenses, this License permits You to +additionally distribute such Covered Software under the terms of such +Secondary License(s), so that the recipient of the Larger Work may, at their +option, further distribute the Covered Software under the terms of either this +License or such Secondary License(s). + + 3.4. Notices + You may not remove or alter the substance of any license notices +(including copyright notices, patent notices, disclaimers of warranty, or +limitations of liability) contained within the Source Code Form of the Covered +Software, except that You may alter any license notices to the extent required +to remedy known factual inaccuracies. + + 3.5. Application of Additional Terms + You may choose to offer, and to charge a fee for, warranty, support, +indemnity or liability obligations to one or more recipients of Covered +Software. However, You may do so only on Your own behalf, and not on behalf of +any Contributor. You must make it absolutely clear that any such warranty, +support, indemnity, or liability obligation is offered by You alone, and You +hereby agree to indemnify every Contributor for any liability incurred by such +Contributor as a result of warranty, support, indemnity or liability terms You +offer. You may include additional disclaimers of warranty and limitations of +liability specific to any jurisdiction. + +4. Inability to Comply Due to Statute or Regulation +If it is impossible for You to comply with any of the terms of this License +with respect to some or all of the Covered Software due to statute, judicial +order, or regulation then You must: (a) comply with the terms of this License +to the maximum extent possible; and (b) describe the limitations and the code +they affect. Such description must be placed in a text file included with all +distributions of the Covered Software under this License. Except to the extent +prohibited by statute or regulation, such description must be sufficiently +detailed for a recipient of ordinary skill to be able to understand it. + +5. Termination + + 5.1. The rights granted under this License will terminate automatically +if You fail to comply with any of its terms. However, if You become compliant, +then the rights granted under this License from a particular Contributor are +reinstated (a) provisionally, unless and until such Contributor explicitly and +finally terminates Your grants, and (b) on an ongoing basis, if such +Contributor fails to notify You of the non-compliance by some reasonable means +prior to 60 days after You have come back into compliance. Moreover, Your +grants from a particular Contributor are reinstated on an ongoing basis if +such Contributor notifies You of the non-compliance by some reasonable means, +this is the first time You have received notice of non-compliance with this +License from such Contributor, and You become compliant prior to 30 days after +Your receipt of the notice. + + 5.2. If You initiate litigation against any entity by asserting a patent +infringement claim (excluding declaratory judgment actions, counter-claims, +and cross-claims) alleging that a Contributor Version directly or indirectly +infringes any patent, then the rights granted to You by any and all +Contributors for the Covered Software under Section 2.1 of this License shall +terminate. + + 5.3. In the event of termination under Sections 5.1 or 5.2 above, all end +user license agreements (excluding distributors and resellers) which have been +validly granted by You or Your distributors under this License prior to +termination shall survive termination. + +6. Disclaimer of Warranty +Covered Software is provided under this License on an "as is" basis, without +warranty of any kind, either expressed, implied, or statutory, including, +without limitation, warranties that the Covered Software is free of defects, +merchantable, fit for a particular purpose or non-infringing. The entire risk +as to the quality and performance of the Covered Software is with You. Should +any Covered Software prove defective in any respect, You (not any Contributor) +assume the cost of any necessary servicing, repair, or correction. This +disclaimer of warranty constitutes an essential part of this License. No use +of any Covered Software is authorized under this License except under this +disclaimer. + +7. Limitation of Liability +Under no circumstances and under no legal theory, whether tort (including +negligence), contract, or otherwise, shall any Contributor, or anyone who +distributes Covered Software as permitted above, be liable to You for any +direct, indirect, special, incidental, or consequential damages of any +character including, without limitation, damages for lost profits, loss of +goodwill, work stoppage, computer failure or malfunction, or any and all other +commercial damages or losses, even if such party shall have been informed of +the possibility of such damages. This limitation of liability shall not apply +to liability for death or personal injury resulting from such party's +negligence to the extent applicable law prohibits such limitation. Some +jurisdictions do not allow the exclusion or limitation of incidental or +consequential damages, so this exclusion and limitation may not apply to You. + +8. Litigation +Any litigation relating to this License may be brought only in the courts of a +jurisdiction where the defendant maintains its principal place of business and +such litigation shall be governed by laws of that jurisdiction, without +reference to its conflict-of-law provisions. Nothing in this Section shall +prevent a party's ability to bring cross-claims or counter-claims. + +9. Miscellaneous +This License represents the complete agreement concerning the subject matter +hereof. If any provision of this License is held to be unenforceable, such +provision shall be reformed only to the extent necessary to make it +enforceable. Any law or regulation which provides that the language of a +contract shall be construed against the drafter shall not be used to construe +this License against a Contributor. + +10. Versions of the License + + 10.1. New Versions + Mozilla Foundation is the license steward. Except as provided in Section +10.3, no one other than the license steward has the right to modify or publish +new versions of this License. Each version will be given a distinguishing +version number. + + 10.2. Effect of New Versions + You may distribute the Covered Software under the terms of the version of +the License under which You originally received the Covered Software, or under +the terms of any subsequent version published by the license steward. + + 10.3. Modified Versions + If you create software not governed by this License, and you want to +create a new license for such software, you may create and use a modified +version of this License if you rename the license and remove any references to +the name of the license steward (except to note that such modified license +differs from this License). + + 10.4. Distributing Source Code Form that is Incompatible With Secondary +Licenses + If You choose to distribute Source Code Form that is Incompatible With +Secondary Licenses under the terms of this version of the License, the notice +described in Exhibit B of this License must be attached. + +Exhibit A - Source Code Form License Notice + + This Source Code Form is subject to the terms of the Mozilla Public +License, v. 2.0. If a copy of the MPL was not distributed with this file, You +can obtain one at http://mozilla.org/MPL/2.0/. + +If it is not possible or desirable to put the notice in a particular file, +then You may include the notice in a location (such as a LICENSE file in a +relevant directory) where a recipient would be likely to look for such a +notice. + +You may add additional accurate notices of copyright ownership. + +Exhibit B - "Incompatible With Secondary Licenses" Notice + + This Source Code Form is "Incompatible With Secondary Licenses", as +defined by the Mozilla Public License, v. 2.0. diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..6e70e08ee2cbedd62dd8a438662739e3ffcc0a17 --- /dev/null +++ b/README.md @@ -0,0 +1,13 @@ +# zig-totp + +![loc](https://sloc.xyz/github/nektro/zig-totp) +[![license](https://img.shields.io/github/license/nektro/zig-totp.svg)](https://github.com/nektro/zig-totp/blob/master/LICENSE) +[![nektro @ github sponsors](https://img.shields.io/badge/sponsors-nektro-purple?logo=github)](https://github.com/sponsors/nektro) +[![Zig](https://img.shields.io/badge/Zig-0.14-f7a41d)](https://ziglang.org/) +[![Zigmod](https://img.shields.io/badge/Zigmod-latest-f7a41d)](https://github.com/nektro/zigmod) + +RFC 6238: TOTP: Time-Based One-Time Password Algorithm + +https://www.rfc-editor.org/rfc/rfc6238 TOTP: Time-Based One-Time Password Algorithm + +https://www.rfc-editor.org/rfc/rfc4226 HOTP: An HMAC-Based One-Time Password Algorithm diff --git a/build.zig b/build.zig new file mode 100644 index 0000000000000000000000000000000000000000..f9ffeeac66f66074b0a7bbaee04d2452b06067c5 --- /dev/null +++ b/build.zig @@ -0,0 +1,20 @@ +const std = @import("std"); +const deps = @import("./deps.zig"); + +pub fn build(b: *std.Build) void { + const target = b.standardTargetOptions(.{}); + const mode = b.option(std.builtin.Mode, "mode", "") orelse .Debug; + + const tests = b.addTest(.{ + .root_source_file = b.path("test.zig"), + .target = target, + .optimize = mode, + }); + deps.addAllTo(tests); + + const test_step = b.step("test", "Run all library tests"); + const tests_run = b.addRunArtifact(tests); + tests_run.setCwd(b.path(".")); + tests_run.has_side_effects = true; + test_step.dependOn(&tests_run.step); +} diff --git a/licenses.txt b/licenses.txt new file mode 100644 index 0000000000000000000000000000000000000000..ef71fa5b846f5a5276733f06dda722f7ac948889 --- /dev/null +++ b/licenses.txt @@ -0,0 +1,8 @@ +MPL-2.0: += https://spdx.org/licenses/MPL-2.0 +- This + +MIT: += https://spdx.org/licenses/MIT +- git https://github.com/nektro/zig-expect +- git https://github.com/nektro/zig-extras diff --git a/test.zig b/test.zig new file mode 100644 index 0000000000000000000000000000000000000000..80a9a09d9404c96acb953fd3d5313a27a064f29a --- /dev/null +++ b/test.zig @@ -0,0 +1,42 @@ +const std = @import("std"); +const totp = @import("totp"); +const expect = @import("expect").expect; +const extras = @import("extras"); +const from_hex = extras.from_hex; + +test { + try expect(&totp.hotp(6, &.{ 0x1f, 0x86, 0x98, 0x69, 0x0e, 0x02, 0xca, 0x16, 0x61, 0x85, 0x50, 0xef, 0x7f, 0x19, 0xda, 0x8e, 0x94, 0x5b, 0x55, 0x5a })).toEqualString("872921"); +} + +const seed = "3132333435363738393031323334353637383930"; +const Sha1 = std.crypto.hash.Sha1; +// zig fmt: off +test { try expect(&totp.totp(8, Sha1, 0, 30, &from_hex(seed), 59)).toEqualString("94287082"); } +test { try expect(&totp.totp(8, Sha1, 0, 30, &from_hex(seed), 1111111109)).toEqualString("07081804"); } +test { try expect(&totp.totp(8, Sha1, 0, 30, &from_hex(seed), 1111111111)).toEqualString("14050471"); } +test { try expect(&totp.totp(8, Sha1, 0, 30, &from_hex(seed), 1234567890)).toEqualString("89005924"); } +test { try expect(&totp.totp(8, Sha1, 0, 30, &from_hex(seed), 2000000000)).toEqualString("69279037"); } +test { try expect(&totp.totp(8, Sha1, 0, 30, &from_hex(seed), 20000000000)).toEqualString("65353130"); } +// zig fmt: on + +const seed32 = "3132333435363738393031323334353637383930313233343536373839303132"; +const Sha256 = std.crypto.hash.sha2.Sha256; +// zig fmt: off +test { try expect(&totp.totp(8, Sha256, 0, 30, &from_hex(seed32), 59)).toEqualString("46119246"); } +test { try expect(&totp.totp(8, Sha256, 0, 30, &from_hex(seed32), 1111111109)).toEqualString("68084774"); } +test { try expect(&totp.totp(8, Sha256, 0, 30, &from_hex(seed32), 1111111111)).toEqualString("67062674"); } +test { try expect(&totp.totp(8, Sha256, 0, 30, &from_hex(seed32), 1234567890)).toEqualString("91819424"); } +test { try expect(&totp.totp(8, Sha256, 0, 30, &from_hex(seed32), 2000000000)).toEqualString("90698825"); } +test { try expect(&totp.totp(8, Sha256, 0, 30, &from_hex(seed32), 20000000000)).toEqualString("77737706"); } +// zig fmt: on + +const seed64 = "31323334353637383930313233343536373839303132333435363738393031323334353637383930313233343536373839303132333435363738393031323334"; +const Sha512 = std.crypto.hash.sha2.Sha512; +// zig fmt: off +test { try expect(&totp.totp(8, Sha512, 0, 30, &from_hex(seed64), 59)).toEqualString("90693936"); } +test { try expect(&totp.totp(8, Sha512, 0, 30, &from_hex(seed64), 1111111109)).toEqualString("25091201"); } +test { try expect(&totp.totp(8, Sha512, 0, 30, &from_hex(seed64), 1111111111)).toEqualString("99943326"); } +test { try expect(&totp.totp(8, Sha512, 0, 30, &from_hex(seed64), 1234567890)).toEqualString("93441116"); } +test { try expect(&totp.totp(8, Sha512, 0, 30, &from_hex(seed64), 2000000000)).toEqualString("38618901"); } +test { try expect(&totp.totp(8, Sha512, 0, 30, &from_hex(seed64), 20000000000)).toEqualString("47863826"); } +// zig fmt: on diff --git a/totp.zig b/totp.zig new file mode 100644 index 0000000000000000000000000000000000000000..df5e47fad30cbbec6956a3b30d1c776ece2982bd --- /dev/null +++ b/totp.zig @@ -0,0 +1,31 @@ +const std = @import("std"); +const extras = @import("extras"); +const url = @import("url"); + +pub fn totp(digits: comptime_int, Hash: type, epoch: u64, X: u64, K: *const [Hash.digest_length]u8, time_now_s: u64) [digits]u8 { + const T = (time_now_s - epoch) / X; + var Thex: [16]u8 = undefined; + _ = std.fmt.bufPrint(&Thex, "{X:0>16}", .{T}) catch unreachable; + const Hmac = std.crypto.auth.hmac.Hmac(Hash); + var HS: [Hmac.mac_length]u8 = undefined; + Hmac.create(&HS, &extras.from_hex(&Thex), K); + return hotp(digits, &HS); +} + +pub fn hotp(digits: comptime_int, hmac_sha: []const u8) [digits]u8 { + const last = hmac_sha[hmac_sha.len - 1]; + const offset = last & 0xf; + const value: u31 = @truncate(std.mem.readInt(u32, hmac_sha[offset..][0..4], .big)); + const dbc = value % powci(10, digits); + + var out: [digits]u8 = undefined; + for (0..digits) |i| out[digits - 1 - i] = @intCast(dbc / (std.math.powi(u32, 10, @intCast(i)) catch unreachable) % 10); + for (0..digits) |i| out[i] += '0'; + return out; +} + +fn powci(x: comptime_int, y: comptime_int) comptime_int { + if (y < 0) @compileError("use sqrt etc"); + if (y == 0) return 1; + return x * powci(x, y - 1); +} diff --git a/zigmod.yml b/zigmod.yml new file mode 100644 index 0000000000000000000000000000000000000000..ba63667d59b41127ccfba2305f13d47548c11ef3 --- /dev/null +++ b/zigmod.yml @@ -0,0 +1,10 @@ +id: oqussg29ersyth4kpsr7ru60rdo23qlshzsduhjwqrdnsrej +name: totp +main: totp.zig +license: MPL-2.0 +description: "RFC 6238: TOTP: Time-Based One-Time Password Algorithm" +dependencies: + - src: git https://github.com/nektro/zig-extras +root_dependencies: + - src: git https://github.com/nektro/zig-extras + - src: git https://github.com/nektro/zig-expect