From 5df747d6588da75f92b28fdbe545b337a603d50e Mon Sep 17 00:00:00 2001 From: Kevin Froman Date: Wed, 30 Dec 2020 06:48:59 +0000 Subject: [PATCH] added work on faster and safer database for blocks and general KV --- src/filepaths/__init__.py | 2 + src/rinseoff/.gitignore | 435 +++++++++++++ src/rinseoff/.vscode/launch.json | 27 + src/rinseoff/.vscode/tasks.json | 42 ++ src/rinseoff/LICENSE.txt | 661 ++++++++++++++++++++ src/rinseoff/README.md | 58 ++ src/rinseoff/rinseoff/RinseOff.cs | 53 ++ src/rinseoff/rinseoff/rinseoff.csproj | 11 + src/rinseoff/rinseoffcli/RinseOffCLI.cs | 215 +++++++ src/rinseoff/rinseoffcli/rinseoffcli.csproj | 12 + src/rinseoff/tests/TestDecrypt.cs | 49 ++ src/rinseoff/tests/TestEncrypt.cs | 49 ++ src/rinseoff/tests/TestKeyGen.cs | 41 ++ src/rinseoff/tests/tests.csproj | 19 + src/safedb/__init__.py | 22 + src/safedb/securestring/__init__.py | 62 ++ tests/test_blocklist_class.py | 1 - tests/test_secure_string.py | 33 + 18 files changed, 1791 insertions(+), 1 deletion(-) create mode 100644 src/rinseoff/.gitignore create mode 100644 src/rinseoff/.vscode/launch.json create mode 100644 src/rinseoff/.vscode/tasks.json create mode 100644 src/rinseoff/LICENSE.txt create mode 100644 src/rinseoff/README.md create mode 100644 src/rinseoff/rinseoff/RinseOff.cs create mode 100644 src/rinseoff/rinseoff/rinseoff.csproj create mode 100644 src/rinseoff/rinseoffcli/RinseOffCLI.cs create mode 100644 src/rinseoff/rinseoffcli/rinseoffcli.csproj create mode 100644 src/rinseoff/tests/TestDecrypt.cs create mode 100644 src/rinseoff/tests/TestEncrypt.cs create mode 100644 src/rinseoff/tests/TestKeyGen.cs create mode 100644 src/rinseoff/tests/tests.csproj create mode 100644 src/safedb/__init__.py create mode 100644 src/safedb/securestring/__init__.py create mode 100644 tests/test_secure_string.py diff --git a/src/filepaths/__init__.py b/src/filepaths/__init__.py index ba205383..32330f6d 100644 --- a/src/filepaths/__init__.py +++ b/src/filepaths/__init__.py @@ -36,3 +36,5 @@ log_file = home + 'onionr.log' ephemeral_services_file = home + 'ephemeral-services.list' restarting_indicator = home + "is-restarting" + +secure_erase_key_file = home + "erase-key" diff --git a/src/rinseoff/.gitignore b/src/rinseoff/.gitignore new file mode 100644 index 00000000..6315c08e --- /dev/null +++ b/src/rinseoff/.gitignore @@ -0,0 +1,435 @@ +## Ignore Visual Studio temporary files, build results, and +## files generated by popular Visual Studio add-ons. +## +## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore + +# User-specific files +*.rsuser +*.suo +*.user +*.userosscache +*.sln.docstates + +tests/tests/* + +# User-specific files (MonoDevelop/Xamarin Studio) +*.userprefs + +# Mono auto generated files +mono_crash.* + +# Build results +[Dd]ebug/ +[Dd]ebugPublic/ +[Rr]elease/ +[Rr]eleases/ +x64/ +x86/ +[Aa][Rr][Mm]/ +[Aa][Rr][Mm]64/ +bld/ +[Bb]in/ +[Oo]bj/ +[Ll]og/ + +# Visual Studio 2015/2017 cache/options directory +.vs/ +# Uncomment if you have tasks that create the project's static files in wwwroot +#wwwroot/ + +# Visual Studio 2017 auto generated files +Generated\ Files/ + +# MSTest test Results +[Tt]est[Rr]esult*/ +[Bb]uild[Ll]og.* + +# NUNIT +*.VisualState.xml +TestResult.xml + +# Build Results of an ATL Project +[Dd]ebugPS/ +[Rr]eleasePS/ +dlldata.c + +# Benchmark Results +BenchmarkDotNet.Artifacts/ + +# .NET Core +project.lock.json +project.fragment.lock.json +artifacts/ + +# StyleCop +StyleCopReport.xml + +# Files built by Visual Studio +*_i.c +*_p.c +*_h.h +*.ilk +*.meta +*.obj +*.iobj +*.pch +*.pdb +*.ipdb +*.pgc +*.pgd +*.rsp +*.sbr +*.tlb +*.tli +*.tlh +*.tmp +*.tmp_proj +*_wpftmp.csproj +*.log +*.vspscc +*.vssscc +.builds +*.pidb +*.svclog +*.scc + +# Chutzpah Test files +_Chutzpah* + +# Visual C++ cache files +ipch/ +*.aps +*.ncb +*.opendb +*.opensdf +*.sdf +*.cachefile +*.VC.db +*.VC.VC.opendb + +# Visual Studio profiler +*.psess +*.vsp +*.vspx +*.sap + +# Visual Studio Trace Files +*.e2e + +# TFS 2012 Local Workspace +$tf/ + +# Guidance Automation Toolkit +*.gpState + +# ReSharper is a .NET coding add-in +_ReSharper*/ +*.[Rr]e[Ss]harper +*.DotSettings.user + +# JustCode is a .NET coding add-in +.JustCode + +# TeamCity is a build add-in +_TeamCity* + +# DotCover is a Code Coverage Tool +*.dotCover + +# AxoCover is a Code Coverage Tool +.axoCover/* +!.axoCover/settings.json + +# Visual Studio code coverage results +*.coverage +*.coveragexml + +# NCrunch +_NCrunch_* +.*crunch*.local.xml +nCrunchTemp_* + +# MightyMoose +*.mm.* +AutoTest.Net/ + +# Web workbench (sass) +.sass-cache/ + +# Installshield output folder +[Ee]xpress/ + +# DocProject is a documentation generator add-in +DocProject/buildhelp/ +DocProject/Help/*.HxT +DocProject/Help/*.HxC +DocProject/Help/*.hhc +DocProject/Help/*.hhk +DocProject/Help/*.hhp +DocProject/Help/Html2 +DocProject/Help/html + +# Click-Once directory +publish/ + +# Publish Web Output +*.[Pp]ublish.xml +*.azurePubxml +# Note: Comment the next line if you want to checkin your web deploy settings, +# but database connection strings (with potential passwords) will be unencrypted +*.pubxml +*.publishproj + +# Microsoft Azure Web App publish settings. Comment the next line if you want to +# checkin your Azure Web App publish settings, but sensitive information contained +# in these scripts will be unencrypted +PublishScripts/ + +# NuGet Packages +*.nupkg +# The packages folder can be ignored because of Package Restore +**/[Pp]ackages/* +# except build/, which is used as an MSBuild target. +!**/[Pp]ackages/build/ +# Uncomment if necessary however generally it will be regenerated when needed +#!**/[Pp]ackages/repositories.config +# NuGet v3's project.json files produces more ignorable files +*.nuget.props +*.nuget.targets + +# Microsoft Azure Build Output +csx/ +*.build.csdef + +# Microsoft Azure Emulator +ecf/ +rcf/ + +# Windows Store app package directories and files +AppPackages/ +BundleArtifacts/ +Package.StoreAssociation.xml +_pkginfo.txt +*.appx +*.appxbundle +*.appxupload + +# Visual Studio cache files +# files ending in .cache can be ignored +*.[Cc]ache +# but keep track of directories ending in .cache +!?*.[Cc]ache/ + +# Others +ClientBin/ +~$* +*~ +*.dbmdl +*.dbproj.schemaview +*.jfm +*.pfx +*.publishsettings +orleans.codegen.cs + +# Including strong name files can present a security risk +# (https://github.com/github/gitignore/pull/2483#issue-259490424) +#*.snk + +# Since there are multiple workflows, uncomment next line to ignore bower_components +# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) +#bower_components/ + +# RIA/Silverlight projects +Generated_Code/ + +# Backup & report files from converting an old project file +# to a newer Visual Studio version. Backup files are not needed, +# because we have git ;-) +_UpgradeReport_Files/ +Backup*/ +UpgradeLog*.XML +UpgradeLog*.htm +ServiceFabricBackup/ +*.rptproj.bak + +# SQL Server files +*.mdf +*.ldf +*.ndf + +# Business Intelligence projects +*.rdl.data +*.bim.layout +*.bim_*.settings +*.rptproj.rsuser +*- Backup*.rdl + +# Microsoft Fakes +FakesAssemblies/ + +# GhostDoc plugin setting file +*.GhostDoc.xml + +# Node.js Tools for Visual Studio +.ntvs_analysis.dat +node_modules/ + +# Visual Studio 6 build log +*.plg + +# Visual Studio 6 workspace options file +*.opt + +# Visual Studio 6 auto-generated workspace file (contains which files were open etc.) +*.vbw + +# Visual Studio LightSwitch build output +**/*.HTMLClient/GeneratedArtifacts +**/*.DesktopClient/GeneratedArtifacts +**/*.DesktopClient/ModelManifest.xml +**/*.Server/GeneratedArtifacts +**/*.Server/ModelManifest.xml +_Pvt_Extensions + +# Paket dependency manager +.paket/paket.exe +paket-files/ + +# FAKE - F# Make +.fake/ + +# CodeRush personal settings +.cr/personal + +# Python Tools for Visual Studio (PTVS) +__pycache__/ +*.pyc + +# Cake - Uncomment if you are using it +# tools/** +# !tools/packages.config + +# Tabs Studio +*.tss + +# Telerik's JustMock configuration file +*.jmconfig + +# BizTalk build output +*.btp.cs +*.btm.cs +*.odx.cs +*.xsd.cs + +# OpenCover UI analysis results +OpenCover/ + +# Azure Stream Analytics local run output +ASALocalRun/ + +# MSBuild Binary and Structured Log +*.binlog + +# NVidia Nsight GPU debugger configuration file +*.nvuser + +# MFractors (Xamarin productivity tool) working folder +.mfractor/ + +# Local History for Visual Studio +.localhistory/ + +# BeatPulse healthcheck temp database +healthchecksdb + +# Backup folder for Package Reference Convert tool in Visual Studio 2017 +MigrationBackup/ + +## +## Visual studio for Mac +## + + +# globs +Makefile.in +*.userprefs +*.usertasks +config.make +config.status +aclocal.m4 +install-sh +autom4te.cache/ +*.tar.gz +tarballs/ +test-results/ + +# Mac bundle stuff +*.dmg +*.app + +# content below from: https://github.com/github/gitignore/blob/master/Global/macOS.gitignore +# General +.DS_Store +.AppleDouble +.LSOverride + +# Icon must end with two \r +Icon + + +# Thumbnails +._* + +# Files that might appear in the root of a volume +.DocumentRevisions-V100 +.fseventsd +.Spotlight-V100 +.TemporaryItems +.Trashes +.VolumeIcon.icns +.com.apple.timemachine.donotpresent + +# Directories potentially created on remote AFP share +.AppleDB +.AppleDesktop +Network Trash Folder +Temporary Items +.apdisk + +# content below from: https://github.com/github/gitignore/blob/master/Global/Windows.gitignore +# Windows thumbnail cache files +Thumbs.db +ehthumbs.db +ehthumbs_vista.db + +# Dump file +*.stackdump + +# Folder config file +[Dd]esktop.ini + +# Recycle Bin used on file shares +$RECYCLE.BIN/ + +# Windows Installer files +*.cab +*.msi +*.msix +*.msm +*.msp + +# Windows shortcuts +*.lnk + +# JetBrains Rider +.idea/ +*.sln.iml + +## +## Visual Studio Code +## +.vscode/* +!.vscode/settings.json +!.vscode/tasks.json +!.vscode/launch.json +!.vscode/extensions.json diff --git a/src/rinseoff/.vscode/launch.json b/src/rinseoff/.vscode/launch.json new file mode 100644 index 00000000..2d29806c --- /dev/null +++ b/src/rinseoff/.vscode/launch.json @@ -0,0 +1,27 @@ +{ + // Use IntelliSense to find out which attributes exist for C# debugging + // Use hover for the description of the existing attributes + // For further information visit https://github.com/OmniSharp/omnisharp-vscode/blob/master/debugger-launchjson.md + "version": "0.2.0", + "configurations": [ + { + "name": ".NET Core Launch (console)", + "type": "coreclr", + "request": "launch", + "preLaunchTask": "build", + // If you have changed target frameworks, make sure to update the program path. + "program": "${workspaceFolder}/tests/bin/Debug/netcoreapp3.1/tests.dll", + "args": [], + "cwd": "${workspaceFolder}/tests", + // For more information about the 'console' field, see https://aka.ms/VSCode-CS-LaunchJson-Console + "console": "internalConsole", + "stopAtEntry": false + }, + { + "name": ".NET Core Attach", + "type": "coreclr", + "request": "attach", + "processId": "${command:pickProcess}" + } + ] +} \ No newline at end of file diff --git a/src/rinseoff/.vscode/tasks.json b/src/rinseoff/.vscode/tasks.json new file mode 100644 index 00000000..ab3984f9 --- /dev/null +++ b/src/rinseoff/.vscode/tasks.json @@ -0,0 +1,42 @@ +{ + "version": "2.0.0", + "tasks": [ + { + "label": "build", + "command": "dotnet", + "type": "process", + "args": [ + "build", + "${workspaceFolder}/tests/tests.csproj", + "/property:GenerateFullPaths=true", + "/consoleloggerparameters:NoSummary" + ], + "problemMatcher": "$msCompile" + }, + { + "label": "publish", + "command": "dotnet", + "type": "process", + "args": [ + "publish", + "${workspaceFolder}/tests/tests.csproj", + "/property:GenerateFullPaths=true", + "/consoleloggerparameters:NoSummary" + ], + "problemMatcher": "$msCompile" + }, + { + "label": "watch", + "command": "dotnet", + "type": "process", + "args": [ + "watch", + "run", + "${workspaceFolder}/tests/tests.csproj", + "/property:GenerateFullPaths=true", + "/consoleloggerparameters:NoSummary" + ], + "problemMatcher": "$msCompile" + } + ] +} \ No newline at end of file diff --git a/src/rinseoff/LICENSE.txt b/src/rinseoff/LICENSE.txt new file mode 100644 index 00000000..be3f7b28 --- /dev/null +++ b/src/rinseoff/LICENSE.txt @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. diff --git a/src/rinseoff/README.md b/src/rinseoff/README.md new file mode 100644 index 00000000..e501cae8 --- /dev/null +++ b/src/rinseoff/README.md @@ -0,0 +1,58 @@ +

RinseOff

+ +RinseOff is a simple CLI utility written in C# to store data to a file and encrypt it using a keyfile. + +The name doesn't make a lot of sense, but it means you can "rinse" your data off by just overwriting a 32 byte key file instead of the normal "scrub" process of 1 or more passes over many files. + +It is mainly intended for scripts/apps to use. In the future I may make a FUSE wrapper so users can drop files into it. + +Internally it uses libsodium's secretbox and stores a unique nonce alongside the 32 byte key. + +# Build + +Build a standalone binary (change [runtime based on system](https://docs.microsoft.com/en-us/dotnet/core/rid-catalog)): + +`$ dotnet publish -p:PublishSingleFile=true --self-contained --runtime linux-x64` + +The binary will be somewhere like bin/Debug/[dotnet version]/[runtime version]/publish/rinseoffcli + +You can make a smaller binary by not bundling the runtime. + +Or you can just "run" the project file: `$ dotnet run --project rinseoffcli` + +# Usage + +## Generate your key file + +`$ rinseoffcli keygen /path/to/key` + +Store your key somewhere it can be securely erased (not flash storage if you can help it) [security.stackexchange.com/a/62591](https://security.stackexchange.com/a/62591) + +Be sure to make it accessible only to your user. + +## Encrypt your data + +`$ rinseoffcli store /path/to/output /path/to/key` + +Then input the data to store through stdin. + +## Load your data + +`$ rinseoffcli load /path/to/stored/data /path/to/key` + +If the key is valid, the plaintext will be outputted through stdout. + +## Securely erase data + +`$ shred /path/to/key` +`$ rm /path/to/datafile` + + +# Warnings: + +The point of this utility is to help with defense in depth and to be better than nothing. + +**This does not hold up to serious data recovery experts who could quite possibly recover your key file** + +If the OS pages or swaps your plaintext or duplicates your key, you are probably doomed. + diff --git a/src/rinseoff/rinseoff/RinseOff.cs b/src/rinseoff/rinseoff/RinseOff.cs new file mode 100644 index 00000000..6e51b901 --- /dev/null +++ b/src/rinseoff/rinseoff/RinseOff.cs @@ -0,0 +1,53 @@ +using System; +using Sodium; +using System.IO; +using System.Collections.Generic; + +/* + RinseOff - Encrypt or load data with a key file to help with secure erasure + Copyright (C) <2020> Kevin Froman + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . +*/ + +namespace rinseoff +{ + public class RinseOff + { + public static void generateKeyFile(string path){ + var key = Sodium.SodiumCore.GetRandomBytes(32); + File.WriteAllBytes(path, key); + } + + public static byte[] encrypt_secret_bytes(byte[] secret, byte[] key){ + byte[] nonce = Sodium.SecretBox.GenerateNonce(); + var ciphertext = SecretBox.Create(secret, nonce, key); + var combined = new List(); + combined.AddRange(nonce); + combined.AddRange(ciphertext); + return combined.ToArray(); + } + + public static byte[] decrypt_secret_bytes(byte[] ciphertext, byte[] key){ + var ciphertextList = new List(); + ciphertextList.AddRange(ciphertext); + return Sodium.SecretBox.Open( + ciphertextList.GetRange(24, ciphertextList.Count - 24).ToArray(), + ciphertextList.GetRange(0, 24).ToArray(), + key); + } + + + } +} diff --git a/src/rinseoff/rinseoff/rinseoff.csproj b/src/rinseoff/rinseoff/rinseoff.csproj new file mode 100644 index 00000000..14aac8b8 --- /dev/null +++ b/src/rinseoff/rinseoff/rinseoff.csproj @@ -0,0 +1,11 @@ + + + + net5.0 + + + + + + + diff --git a/src/rinseoff/rinseoffcli/RinseOffCLI.cs b/src/rinseoff/rinseoffcli/RinseOffCLI.cs new file mode 100644 index 00000000..91e62fc6 --- /dev/null +++ b/src/rinseoff/rinseoffcli/RinseOffCLI.cs @@ -0,0 +1,215 @@ +using System; +using System.IO; +using System.Collections.Generic; +using rinseoff; +/* + RinseOff - Encrypt or load data with a key file to help with secure erasure + Copyright (C) <2020> Kevin Froman + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . +*/ + +namespace rinseoffcli +{ + class Program + { + public static string version = "1.0.0"; + enum ErrorCode : byte + { + // Exit error codes indexed from 1 + InvaildArgs = 1, + NoDataFileFound, + NoPermissionToReadDataFile, + FailedToReadDataFile, + FailedToWriteDataFile, + InvalidKeyFileSize, + InvalidKeyFile, + KeyFileNotFound, + NoPermissionToWriteKeyFile, + FailedToReadKeyFile, + FailedToWriteKeyFile + } + + + static void showHelp(ErrorCode exitCode = ErrorCode.InvaildArgs){ + Console.WriteLine("RinseOff " + version + " High level secure-erasure utility"); + Console.WriteLine("For stdout output, specify 'stdout' as the data file for the store command"); + Console.WriteLine("Must specify keygen or store/load, then a file name followed by a key file.\nFormat: "); + Environment.Exit((int) exitCode); + } + static void validateArgCount(string[] args, int count){ + if (args.Length != count){ + stderrWrite("Invalid number of arguments"); + showHelp(ErrorCode.InvaildArgs); + } + } + static void stderrWrite(string msg){ + var stderrStream = Console.Error; + stderrStream.WriteLine(msg); + stderrStream.Flush(); + } + static void loadData(string filepath, string keypath){ + // Load in an encrypted file and use a key file to decrypt it, then log bytes back to stdout + byte[] plaintext = {}; + byte[] readBytes(string file){ + // Read bytes in from a file, exit with error message if not possible + byte[] bytesToRead = {}; + try{ + bytesToRead = File.ReadAllBytes(file); + } + catch(FileNotFoundException){ + stderrWrite(file + " is not found"); + Environment.Exit((int)ErrorCode.NoDataFileFound); + } + catch(UnauthorizedAccessException){ + stderrWrite("No permssion to read " + file); + Environment.Exit((int)ErrorCode.NoPermissionToReadDataFile); + } + catch(IOException){ + stderrWrite("Failed to read " + file); + Environment.Exit((int)ErrorCode.FailedToReadDataFile); + } + return bytesToRead; + } + var stdout = Console.OpenStandardOutput(); + try{ + // Decrypt a file using a key file + plaintext = RinseOff.decrypt_secret_bytes( + readBytes(filepath), + readBytes(keypath) + ); + } + catch(Sodium.Exceptions.KeyOutOfRangeException){ + stderrWrite("Keyfile is not appropriate size for key"); + Environment.Exit((int)ErrorCode.InvalidKeyFileSize); + } + catch(System.Security.Cryptography.CryptographicException){ + stderrWrite("Could not decrypt " + filepath + " with " + keypath); + Environment.Exit((int)ErrorCode.InvalidKeyFile); + } + // print the plaintext and exit + foreach(byte b in plaintext){ + stdout.WriteByte(b); + } + stdout.Flush(); + } + + static void storeData(string filepath, string keypath){ + byte[] encryptedInput = new byte[0]; + + void writeStdoutBytes(byte[] data){ + var stdout = Console.OpenStandardOutput(); + foreach (byte b in data){ + stdout.WriteByte(b); + } + stdout.Flush(); + } + + byte[] readUntilClose(){ + // Read binary from STDIN until close + var readData = new List(); + Stream inputStream = Console.OpenStandardInput(); + int inp; + while(true){ + inp = inputStream.ReadByte(); + if (inp != -1){ + readData.Add((byte) inp); + } + else{ + return readData.ToArray(); + } + } + } + // Encrypt stdin with keyfile data then write out to output file + try{ + encryptedInput = RinseOff.encrypt_secret_bytes(readUntilClose(), File.ReadAllBytes(keypath)); + } + catch(FileNotFoundException){ + stderrWrite("Key file " + keypath + " does not exist"); + Environment.Exit((int)ErrorCode.KeyFileNotFound); + } + catch(Sodium.Exceptions.KeyOutOfRangeException){ + stderrWrite("Keyfile is not appropriate size for key"); + Environment.Exit((int)ErrorCode.InvalidKeyFileSize); + } + catch(IOException){ + stderrWrite("Failed to read key file " + keypath); + Environment.Exit((int)ErrorCode.FailedToReadKeyFile); + } + if (filepath == "stdout"){ + writeStdoutBytes(encryptedInput); + return; + } + try{ + File.WriteAllBytes(filepath, encryptedInput); + } + catch(ArgumentNullException) + { + Environment.Exit(0); + } + catch(DirectoryNotFoundException){ + stderrWrite("Output path " + filepath + " not found"); + Environment.Exit((int)ErrorCode.NoDataFileFound); + } + catch(IOException){ + stderrWrite("Could not write to " + filepath); + Environment.Exit((int)ErrorCode.FailedToWriteDataFile); + } + } + static void Main(string[] args) + { + if (args.Length == 0){ + showHelp(); + } + var cmd = args[0].ToLower(); + switch(cmd){ + case "keygen": + validateArgCount(args, 2); + try{ + RinseOff.generateKeyFile(args[1]); + } + catch(UnauthorizedAccessException){ + stderrWrite("Cannot write to key file due to lack of perms " + args[1]); + Environment.Exit((int)ErrorCode.NoPermissionToWriteKeyFile); + } + catch(DirectoryNotFoundException){ + stderrWrite("Path not found " + args[1]); + Environment.Exit((int)ErrorCode.KeyFileNotFound); + } + catch(IOException){ + stderrWrite("Error writing keyfile " + args[1]); + Environment.Exit((int)ErrorCode.FailedToWriteKeyFile); + } + break; + case "store": + validateArgCount(args, 3); + storeData(args[1], args[2]); + break; + case "load": + validateArgCount(args, 3); + loadData(args[1], args[2]); + break; + default: + stderrWrite("Invalid command"); + showHelp(); + break; + case "help": + case "--help": + case "-h": + showHelp(); + break; + } + } + } +} diff --git a/src/rinseoff/rinseoffcli/rinseoffcli.csproj b/src/rinseoff/rinseoffcli/rinseoffcli.csproj new file mode 100644 index 00000000..99e84eb8 --- /dev/null +++ b/src/rinseoff/rinseoffcli/rinseoffcli.csproj @@ -0,0 +1,12 @@ + + + + + + + + Exe + net5.0 + + + diff --git a/src/rinseoff/tests/TestDecrypt.cs b/src/rinseoff/tests/TestDecrypt.cs new file mode 100644 index 00000000..520acf45 --- /dev/null +++ b/src/rinseoff/tests/TestDecrypt.cs @@ -0,0 +1,49 @@ +using NUnit.Framework; +using System.Text; +using System.Collections.Generic; +using Sodium; +using rinseoff; +/* + RinseOff - Encrypt or load data with a key file to help with secure erasure + Copyright (C) <2020> Kevin Froman + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . +*/ +namespace testDecrypted +{ + public class Tests + { + [SetUp] + public void Setup() + { + } + + [Test] + public void testDecrypted() + { + var key = Sodium.SecretBox.GenerateKey(); + var nonce = Sodium.SecretBox.GenerateNonce(); + var msg = Encoding.Default.GetBytes("hey"); + var encrypted = Sodium.SecretBox.Create(msg, nonce, key); + var combined = new List(); + combined.AddRange(nonce); + combined.AddRange(encrypted); + + Assert.AreEqual( + RinseOff.decrypt_secret_bytes(combined.ToArray(), key), + msg + ); + } + } +} \ No newline at end of file diff --git a/src/rinseoff/tests/TestEncrypt.cs b/src/rinseoff/tests/TestEncrypt.cs new file mode 100644 index 00000000..31244437 --- /dev/null +++ b/src/rinseoff/tests/TestEncrypt.cs @@ -0,0 +1,49 @@ +using NUnit.Framework; +using System.Text; +using System.Collections.Generic; +using rinseoff; +/* + RinseOff - Encrypt or load data with a key file to help with secure erasure + Copyright (C) <2020> Kevin Froman + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . +*/ +namespace testEncrypted +{ + public class Tests + { + [SetUp] + public void Setup() + { + } + + [Test] + public void TestEncrypt() + { + var key = Sodium.SecretBox.GenerateKey(); + var secret = Encoding.UTF8.GetBytes("Hello world"); + var encrypted = RinseOff.encrypt_secret_bytes(secret, key); + var encryptedList = new List(); + encryptedList.AddRange(encrypted); + + Assert.AreNotEqual(secret, encrypted); + var nonce = encryptedList.GetRange(0, 24).ToArray(); + var cipher = encryptedList.GetRange(24, encryptedList.Count - 24).ToArray(); + + var decrypted = Sodium.SecretBox.Open(cipher, nonce, key); + Assert.AreEqual(decrypted, secret); + + } + } +} \ No newline at end of file diff --git a/src/rinseoff/tests/TestKeyGen.cs b/src/rinseoff/tests/TestKeyGen.cs new file mode 100644 index 00000000..3940ff66 --- /dev/null +++ b/src/rinseoff/tests/TestKeyGen.cs @@ -0,0 +1,41 @@ +using NUnit.Framework; +using System.IO; +using rinseoff; +/* + RinseOff - Encrypt or load data with a key file to help with secure erasure + Copyright (C) <2020> Kevin Froman + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . +*/ +namespace tests +{ + public class Tests + { + [SetUp] + public void Setup() + { + } + + [Test] + public void TestKeyGenBasic() + { + var f = Path.GetTempFileName(); + RinseOff.generateKeyFile(f); + var k = File.ReadAllBytes(f); + Assert.IsTrue(k.Length == 32); + Assert.IsFalse(k[0] == k[1]); + File.Delete(f); + } + } +} \ No newline at end of file diff --git a/src/rinseoff/tests/tests.csproj b/src/rinseoff/tests/tests.csproj new file mode 100644 index 00000000..03bb7036 --- /dev/null +++ b/src/rinseoff/tests/tests.csproj @@ -0,0 +1,19 @@ + + + + net5.0 + + false + + + + + + + + + + + + + diff --git a/src/safedb/__init__.py b/src/safedb/__init__.py new file mode 100644 index 00000000..dd1f02f1 --- /dev/null +++ b/src/safedb/__init__.py @@ -0,0 +1,22 @@ +from typing import Union +from enum import Enum, auto + +import dbm + + + +class SafeDB: + def safe_get(key: Union[str, bytes]) -> bytes: + return + + def __enter__(self): + self.db = dbm.open(self.db_path, "c") + return self.db + + def __exit__(self): + self.db.close() + + def __init__(self, db_path: str, use_): + self.db_path = db_path + + diff --git a/src/safedb/securestring/__init__.py b/src/safedb/securestring/__init__.py new file mode 100644 index 00000000..55cd753b --- /dev/null +++ b/src/safedb/securestring/__init__.py @@ -0,0 +1,62 @@ +import os +from typing import Union + +import subprocess + +from filepaths import secure_erase_key_file, app_root +import logger + +_rinseoff = f"{app_root}/src/rinseoff/rinseoffcli" + + + + +def generate_secure_string_key_file(): + if os.path.exists(secure_erase_key_file): + raise FileExistsError + + process = subprocess.Popen( + ["dotnet", "run", + "--project", _rinseoff, + "keygen", f"{secure_erase_key_file}"], + stdout=subprocess.PIPE, + stderr=subprocess.PIPE) + res = process.communicate() + + if res[0]: + for line in res[0].decode('utf-8').split('\n'): + logger.info(line, terminal=True) + if res[1]: + logger.warn("Error when generating database encryption keyfile") + for line in res[1].decode('utf-8').split('\n'): + logger.error(line, terminal=True) + raise subprocess.CalledProcessError + + + +def secure_string_create(plaintext: Union[bytes, bytearray, str]) -> bytes: + """Create a "secure" string. Dont really rely on this, and dont use for comms + + This is just to make forensics a little harder""" + try: + plaintext = plaintext.encode('utf-8') + except AttributeError: + pass + + + process = subprocess.Popen( + ["dotnet", "run", + "--project", _rinseoff, + "store", "stdout", f"{secure_erase_key_file}"], + stdout=subprocess.PIPE, + stderr=subprocess.PIPE, + stdin=subprocess.PIPE) + res = process.communicate(plaintext) + + if res[0] and not res[1]: + return res[0] + else: + logger.warn("Error when encrypting plaintext", terminal=True) + for line in res[1].decode('utf-8').split('\n'): + logger.error(line, terminal=True) + raise subprocess.CalledProcessError \ No newline at end of file diff --git a/tests/test_blocklist_class.py b/tests/test_blocklist_class.py index ce46905a..5f591b77 100644 --- a/tests/test_blocklist_class.py +++ b/tests/test_blocklist_class.py @@ -13,7 +13,6 @@ from onionrsetup import setup_config, setup_default_plugins createdirs.create_dirs() setup_config() -setup_config() setup_default_plugins() import config diff --git a/tests/test_secure_string.py b/tests/test_secure_string.py new file mode 100644 index 00000000..2bd2b61d --- /dev/null +++ b/tests/test_secure_string.py @@ -0,0 +1,33 @@ +#!/usr/bin/env python3 +import sys, os +sys.path.append(".") +sys.path.append("src/") +import uuid +TEST_DIR = 'testdata/%s-%s' % (uuid.uuid4(), os.path.basename(__file__)) + '/' +print("Test directory:", TEST_DIR) +os.environ["ONIONR_HOME"] = TEST_DIR +import unittest, json + +from utils import identifyhome, createdirs +from onionrsetup import setup_config +from safedb import securestring + +import filepaths +createdirs.create_dirs() +setup_config() + +class TestSecureString(unittest.TestCase): + def test_keyfile_gen(self): + assert not os.path.exists(filepaths.secure_erase_key_file) + securestring.generate_secure_string_key_file() + assert os.path.exists(filepaths.secure_erase_key_file) + + def test_secure_string_encrypt(self): + with open(filepaths.secure_erase_key_file, 'wb') as ef: + ef.write(os.urandom(32)) + pt = "hello world" + enc = securestring.secure_string_create(pt) + self.assertTrue(len(enc) > len(pt)) + + +unittest.main()