diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..be3fd97 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,63 @@ +############################################################################### +# Set default behavior to automatically normalize line endings. +############################################################################### +* text=auto + +############################################################################### +# Set default behavior for command prompt diff. +# +# This is need for earlier builds of msysgit that does not have it on by +# default for csharp files. +# Note: This is only used by command line +############################################################################### +*.cs diff=csharp + +############################################################################### +# Set the merge driver for project and solution files +# +# Merging from the command prompt will add diff markers to the files if there +# are conflicts (Merging from VS is not affected by the settings below, in VS +# the diff markers are never inserted). Diff markers may cause the following +# file extensions to fail to load in VS. An alternative would be to treat +# these files as binary and thus will always conflict and require user +# intervention with every merge. To do so, just uncomment the entries below +############################################################################### +#*.sln merge=binary +#*.csproj merge=binary +#*.vbproj merge=binary +#*.vcxproj merge=binary +#*.vcproj merge=binary +#*.dbproj merge=binary +#*.fsproj merge=binary +#*.lsproj merge=binary +#*.wixproj merge=binary +#*.modelproj merge=binary +#*.sqlproj merge=binary +#*.wwaproj merge=binary + +############################################################################### +# behavior for image files +# +# image files are treated as binary by default. +############################################################################### +#*.jpg binary +#*.png binary +#*.gif binary + +############################################################################### +# diff behavior for common document formats +# +# Convert binary document formats to text before diffing them. This feature +# is only available from the command line. Turn it on by uncommenting the +# entries below. +############################################################################### +#*.doc diff=astextplain +#*.DOC diff=astextplain +#*.docx diff=astextplain +#*.DOCX diff=astextplain +#*.dot diff=astextplain +#*.DOT diff=astextplain +#*.pdf diff=astextplain +#*.PDF diff=astextplain +#*.rtf diff=astextplain +#*.RTF diff=astextplain diff --git a/.github/workflows/CIBuildTest-Linux.yml b/.github/workflows/CIBuildTest-Linux.yml new file mode 100644 index 0000000..4311994 --- /dev/null +++ b/.github/workflows/CIBuildTest-Linux.yml @@ -0,0 +1,29 @@ +name: BuildAndTest-Linux + +on: + push: + branches: [master] + pull_request: + branches: [master] + +jobs: + BuildAndTest: + runs-on: ubuntu-latest + env: + DOTNET_NOLOGO: true + + steps: + - uses: actions/checkout@v2 + + - name: Setup .NET + uses: actions/setup-dotnet@v1 + with: + dotnet-version: 5.0.x + + - name: Build + working-directory: src + run: dotnet build + + - name: Test + working-directory: src + run: 'dotnet test --no-build --verbosity normal --test-adapter-path:. --logger:"junit;LogFilePath=../artifacts/{assembly}-test-result.xml;MethodFormat=Class;FailureBodyFormat=Verbose"' diff --git a/.github/workflows/CIBuildTest-Win.yml b/.github/workflows/CIBuildTest-Win.yml new file mode 100644 index 0000000..0ff0ef5 --- /dev/null +++ b/.github/workflows/CIBuildTest-Win.yml @@ -0,0 +1,40 @@ +name: BuildAndTest-Windows + +on: + push: + branches: [master] + pull_request: + branches: [master] + +jobs: + BuildAndTest: + runs-on: windows-latest + env: + DOTNET_NOLOGO: true + + steps: + - uses: actions/checkout@v2 + + - name: Setup .NET + uses: actions/setup-dotnet@v1 + with: + dotnet-version: 5.0.x + + - name: Build + working-directory: src + run: dotnet build + + - name: Test + working-directory: src + run: 'dotnet test --no-build --verbosity normal --test-adapter-path:. --logger:"junit;LogFilePath=../artifacts/{assembly}-test-result.xml;MethodFormat=Class;FailureBodyFormat=Verbose"' + + - name: Publish Unit Test Results + uses: zyborg/dotnet-tests-report@v1.3.0 + with: + project_path: ./src/QnapBackupDecryptor.Core.Tests + report_name: QnapBackupDecryptor.Core.Tests + report_title: QnapBackupDecryptor.Core.Tests + github_token: ${{ secrets.GITHUB_TOKEN }} + gist_name: QnapBackupDecryptor.Core.Tests.md + gist_badge_label: "QnapBackupDecryptor.Core: %Counters_passed%/%Counters_total%" + gist_token: ${{ secrets.GIST_TOKEN }} diff --git a/.github/workflows/ReleaseAll.yml b/.github/workflows/ReleaseAll.yml new file mode 100644 index 0000000..1b7fdb4 --- /dev/null +++ b/.github/workflows/ReleaseAll.yml @@ -0,0 +1,95 @@ +name: ReleaseAll + +on: + release: + types: [published] + +jobs: + release: + name: Release + strategy: + matrix: + kind: ["linux", "windows", "macOS"] + include: + - kind: linux + os: ubuntu-latest + target: linux-x64 + - kind: windows + os: windows-latest + target: win-x64 + - kind: macOS + os: macos-latest + target: osx-x64 + runs-on: ${{ matrix.os }} + env: + DOTNET_NOLOGO: true + steps: + - name: Checkout + uses: actions/checkout@v1 + + - name: Setup .NET + uses: actions/setup-dotnet@v1 + with: + dotnet-version: 5.0.x + + - name: BuildFrameworkDep + shell: bash + working-directory: src + run: | + tag=$(git describe --tags --abbrev=0) + release_name="QnapBackupDecryptor-FD-$tag-${{ matrix.target }}" + + # Build everything + dotnet publish ./QnapBackupDecryptor.Console/QnapBackupDecryptor.Console.csproj -c Release -f net5.0 -r ${{ matrix.target }} --self-contained false -p:PublishSingleFile=true -o "./releases/$release_name" + + # bin the pdb files + rm ./releases/$release_name/*.pdb + + # Pack files + if [ "${{ matrix.target }}" == "win-x64" ]; then + # Pack to zip for Windows + mv ./releases/$release_name/QnapBackupDecryptor.Console.exe ./releases/$release_name/QnapBackupDecryptor.exe + 7z a -tzip "../${release_name}.zip" "./releases/${release_name}/*" + else + mv ./releases/$release_name/QnapBackupDecryptor.Console ./releases/$release_name/QnapBackupDecryptor + tar czvf "../${release_name}.tar.gz" "./releases/$release_name" + fi + + # Delete output directory + rm -r "./releases/$release_name" + - name: Publish + uses: softprops/action-gh-release@v1 + with: + files: "QnapBackupDecryptor-*" + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + + - name: BuildSelfContained + shell: bash + working-directory: src + run: | + tag=$(git describe --tags --abbrev=0) + release_name="QnapBackupDecryptor-SC-$tag-${{ matrix.target }}" + + # Build everything + dotnet publish QnapBackupDecryptor.sln -c Release -f net5.0 -r ${{ matrix.target }} --self-contained true -o "./releases/$release_name" + + # bin the pdb files + rm ./releases/$release_name/*.pdb + + # Pack files + if [ "${{ matrix.target }}" == "win-x64" ]; then + # Pack to zip for Windows + 7z a -tzip "../${release_name}.zip" "./releases/${release_name}/*" + else + tar czvf "../${release_name}.tar.gz" "./releases/$release_name" + fi + + # Delete output directory + rm -r "./releases/$release_name" + - name: Publish + uses: softprops/action-gh-release@v1 + with: + files: "QnapBackupDecryptor-*" + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml new file mode 100644 index 0000000..d4ab145 --- /dev/null +++ b/.github/workflows/codeql-analysis.yml @@ -0,0 +1,67 @@ +# For most projects, this workflow file will not need changing; you simply need +# to commit it to your repository. +# +# You may wish to alter this file to override the set of languages analyzed, +# or to provide custom queries or build logic. +# +# ******** NOTE ******** +# We have attempted to detect the languages in your repository. Please check +# the `language` matrix defined below to confirm you have the correct set of +# supported CodeQL languages. +# +name: "CodeQL" + +on: + push: + branches: [ master ] + pull_request: + # The branches below must be a subset of the branches above + branches: [ master ] + schedule: + - cron: '43 9 * * 3' + +jobs: + analyze: + name: Analyze + runs-on: ubuntu-latest + + strategy: + fail-fast: false + matrix: + language: [ 'csharp' ] + # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ] + # Learn more: + # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed + + steps: + - name: Checkout repository + uses: actions/checkout@v2 + + # Initializes the CodeQL tools for scanning. + - name: Initialize CodeQL + uses: github/codeql-action/init@v1 + with: + languages: ${{ matrix.language }} + # If you wish to specify custom queries, you can do so here or in a config file. + # By default, queries listed here will override any specified in a config file. + # Prefix the list here with "+" to use these queries and those in the config file. + # queries: ./path/to/local/query, your-org/your-repo/queries@main + + # Autobuild attempts to build any compiled languages (C/C++, C#, or Java). + # If this step fails, then you should remove it and run the build manually (see below) + - name: Autobuild + uses: github/codeql-action/autobuild@v1 + + # ℹ️ Command-line programs to run using the OS shell. + # 📚 https://git.io/JvXDl + + # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines + # and modify them (or add more) to build your code if your project + # uses a compiled language + + #- run: | + # make bootstrap + # make release + + - name: Perform CodeQL Analysis + uses: github/codeql-action/analyze@v1 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..a9f4c68 --- /dev/null +++ b/.gitignore @@ -0,0 +1,341 @@ +## 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 + +# User-specific files (MonoDevelop/Xamarin Studio) +*.userprefs + +# 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 + +# 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/ + +# JetBrains Rider +.idea/ +*.sln.iml + +# 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 +/src/QnapBackupDecryptor.Console/Properties/launchSettings.json diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 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 General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is 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. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + 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. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + 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 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. Use with the GNU Affero General Public License. + + 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 Affero 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 special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU 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 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 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 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 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 General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + 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 GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/src/QnapBackupDecryptor.Console/Options.cs b/src/QnapBackupDecryptor.Console/Options.cs new file mode 100644 index 0000000..9369bc4 --- /dev/null +++ b/src/QnapBackupDecryptor.Console/Options.cs @@ -0,0 +1,42 @@ +using CommandLine; +using CommandLine.Text; +using System.Collections.Generic; + +namespace QnapBackupDecryptor.Console +{ + public class Options + { + [Option('p', "password", Required = false, HelpText = "Password")] + public string Password { get; set; } + + [Option('e', "encrypted", Required = true, HelpText = "Encrypted file or folder")] + public string EncryptedSource { get; set; } + + [Option('d', "decrypted", Required = true, HelpText = "Where to place the decrypted file(s)")] + public string OutputDestination { get; set; } + + [Option('s', "subfolders", Required = false, HelpText = "Include Subfolders (default: false)")] + public bool IncludeSubfolders { get; set; } + + [Option('v', "verbose", Required = false, HelpText = "Set output to verbose")] + public bool Verbose { get; set; } + + [Option('o', "overwrite", Required = false, HelpText = "Overwrite file(s) in output (default: false)")] + public bool Overwrite { get; set; } + + [Usage(ApplicationAlias = "QnapBackupDecryptor.exe")] + // ReSharper disable once UnusedMember.Global + public static IEnumerable Examples + { + get + { + yield return new Example("Decrypt a single file", new Options { EncryptedSource = "file.bin", OutputDestination = "out.bin", Password = "Pa$$word" }); + yield return new Example("Decrypt a folder", new Options { EncryptedSource = "./encryptedfolder", OutputDestination = "./decryptedfolder", Password = "Pa$$word" }); + yield return new Example("Decrypt a folder, overwriting files in the destination", new Options { EncryptedSource = "./encryptedfolder", OutputDestination = "./decryptedfolder", Password = "Pa$$word", Overwrite = true }); + yield return new Example("Decrypt a folder and all subfolders, and prompt for password", new Options { EncryptedSource = "./encryptedfolder", OutputDestination = "./decryptedfolder", IncludeSubfolders = true }); + } + } + + } + +} diff --git a/src/QnapBackupDecryptor.Console/Output.cs b/src/QnapBackupDecryptor.Console/Output.cs new file mode 100644 index 0000000..a6ac587 --- /dev/null +++ b/src/QnapBackupDecryptor.Console/Output.cs @@ -0,0 +1,86 @@ +using Spectre.Console; +using System; +using System.Collections.Concurrent; +using System.Collections.Generic; +using System.Linq; + +namespace QnapBackupDecryptor.Console +{ + internal class Output + { + public static void ShowResults(ConcurrentBag results, bool verbose, TimeSpan swElapsed) + { + if (verbose) + ShowFileListResults(results); + else + ShowSimpleResults(results); + + ShowTiming(swElapsed); + } + + private static void ShowSimpleResults(ConcurrentBag results) + { + AnsiConsole.MarkupLine($"[bold]Total encrypted files: {results.Count}[/]"); + AnsiConsole.MarkupLine($"[green]Decrypted\t{results.Count(r => r.Success)}[/]"); + AnsiConsole.MarkupLine($"[red]Failed\t\t{ results.Count(r => !r.Success)}[/]"); + } + + private static void ShowFileListResults(ConcurrentBag results) + { + var table = new Table(); + table.AddColumn("Status"); + table.AddColumn(new TableColumn("Encrypted").Centered()); + table.AddColumn(new TableColumn("Decrypted").Centered()); + if (results.Any(r => r.Success == false)) + { + table.AddColumn("Error Message"); + Environment.ExitCode = 1; + } + + foreach (var result in results) + table.AddRow(ResultToText(result).ToArray()); + + AnsiConsole.Render(table); + + AnsiConsole.MarkupLine($"[bold]Total {results.Count} - Decrypted {results.Count(r => r.Success)}[/]"); + } + + private static IEnumerable ResultToText(DecryptResult result) + { + var colour = result.Success ? "green" : "red"; + + if (result.Success) + return new List + { + $"[{colour}]Ok[/]", + $"[{colour}]{result.Source.FullName}[/]", + $"[{colour}]{result.Dest.FullName}[/]" + }; + else + return new List + { + $"[{colour}]Ok[/]", + $"[{colour}]{result.Source.FullName}[/]", + $"[{colour}]{result.Dest.FullName}[/]", + $"[{colour}]{result.ErrorMessage}[/]" + }; + + } + + + + private static void ShowTiming(TimeSpan swElapsed) + { + switch (swElapsed.TotalMinutes) + { + case < 1: + AnsiConsole.MarkupLine($"[bold]Took {swElapsed.TotalSeconds:0.000} seconds[/]"); + break; + default: + AnsiConsole.MarkupLine($"[bold]Took {swElapsed.TotalMinutes} minutes[/]"); + break; + } + } + + } +} diff --git a/src/QnapBackupDecryptor.Console/Program.cs b/src/QnapBackupDecryptor.Console/Program.cs new file mode 100644 index 0000000..d5c9f57 --- /dev/null +++ b/src/QnapBackupDecryptor.Console/Program.cs @@ -0,0 +1,49 @@ +using CommandLine; +using QnapBackupDecryptor.Core; +using System.Collections.Concurrent; +using System.Diagnostics; +using System.IO; +using System.Threading.Tasks; + +namespace QnapBackupDecryptor.Console +{ + class Program + { + static void Main(string[] args) + { + Parser.Default + .ParseArguments(args) + .WithParsed(Run); + } + + private static void Run(Options opts) + { + var password = Prompts.GetPassword(opts); + + var sw = Stopwatch.StartNew(); + + var decryptJobs = JobMaker.GetDecryptJob(opts.EncryptedSource, opts.OutputDestination, opts.Overwrite, opts.IncludeSubfolders); + + ConcurrentBag results = new ConcurrentBag(); + Parallel.ForEach(decryptJobs, + job => + { + if (job.Success == false) + results.Add(new DecryptResult(job.EncryptedFile, job.OutputFile, job.Success, job.ErrorMessage)); + else + { + var result = OpenSsl.Decrypt(new FileInfo(job.EncryptedFile.FullName), password, new FileInfo(job.OutputFile.FullName)); + results.Add(new DecryptResult(job.EncryptedFile, job.OutputFile, result.IsSuccess, job.ErrorMessage)); + } + }); + + sw.Stop(); + Output.ShowResults(results, opts.Verbose, sw.Elapsed); + } + + } + + public record DecryptResult(FileSystemInfo Source, FileSystemInfo Dest, bool Success, string ErrorMessage); + + +} diff --git a/src/QnapBackupDecryptor.Console/Prompts.cs b/src/QnapBackupDecryptor.Console/Prompts.cs new file mode 100644 index 0000000..1b8e01b --- /dev/null +++ b/src/QnapBackupDecryptor.Console/Prompts.cs @@ -0,0 +1,22 @@ +using Spectre.Console; +using System.Text; + +namespace QnapBackupDecryptor.Console +{ + internal class Prompts + { + public static byte[] GetPassword(Options opts) + { + if (string.IsNullOrEmpty(opts.Password) == false) + return Encoding.UTF8.GetBytes(opts.Password); + else + { + var password = AnsiConsole.Prompt( + new TextPrompt("[bold]>> Enter password[/]") + .PromptStyle("yellow") + .Secret()); + return Encoding.UTF8.GetBytes(password); + } + } + } +} diff --git a/src/QnapBackupDecryptor.Console/QnapBackupDecryptor.Console.csproj b/src/QnapBackupDecryptor.Console/QnapBackupDecryptor.Console.csproj new file mode 100644 index 0000000..494f5eb --- /dev/null +++ b/src/QnapBackupDecryptor.Console/QnapBackupDecryptor.Console.csproj @@ -0,0 +1,17 @@ + + + + Exe + net5.0 + + + + + + + + + + + + diff --git a/src/QnapBackupDecryptor.Core.Tests/DecryptorTests.cs b/src/QnapBackupDecryptor.Core.Tests/DecryptorTests.cs new file mode 100644 index 0000000..bd5a19c --- /dev/null +++ b/src/QnapBackupDecryptor.Core.Tests/DecryptorTests.cs @@ -0,0 +1,51 @@ +using NUnit.Framework; +using Shouldly; +using System; +using System.IO; +using System.Text; + +namespace QnapBackupDecryptor.Core.Tests +{ + + [TestFixture] + public class DecryptorTests + { + private const string PASSWORD = "wisLUBIMyBNcnvo3eDMS"; + + + [Test] + public void OpenSSLDecrypt_Text() + { + // Arrange + var encryptedFile = new FileInfo(@"TestFiles/encrypted.txt"); + var decryptedFile = new FileInfo(@"TestFiles/plaintext.txt"); + + // Act + var passwordBytes = Encoding.UTF8.GetBytes(PASSWORD); + var sslDecrypt = OpenSsl.Decrypt(encryptedFile, passwordBytes, decryptedFile); + + // Assert + var decryptedText = File.ReadAllText(sslDecrypt.Data.FullName); + decryptedText.ShouldBe($"line1: this is a plaintext file{Environment.NewLine}line2: End!{Environment.NewLine}"); + } + + [Test] + public void OpenSSLDecrypt_Binary() + { + // Arrange + var encryptedFile = new FileInfo(@"TestFiles/encrypted.jpg"); + var decryptedFile = new FileInfo(@"TestFiles/decrypted.jpg"); + + + // Act + var passwordBytes = Encoding.UTF8.GetBytes(PASSWORD); + var decrpyted = OpenSsl.Decrypt(encryptedFile, passwordBytes, decryptedFile); + + + // Assert + //var decryptedText = File.ReadAllText(decrpyted.FullName); + //decryptedText.ShouldBe("line1: this is a plaintext file\r\nline2: End!\r\n"); + } + + } +} diff --git a/src/QnapBackupDecryptor.Core.Tests/FileHelpersTests.cs b/src/QnapBackupDecryptor.Core.Tests/FileHelpersTests.cs new file mode 100644 index 0000000..3ea700a --- /dev/null +++ b/src/QnapBackupDecryptor.Core.Tests/FileHelpersTests.cs @@ -0,0 +1,48 @@ +using NUnit.Framework; +using Shouldly; +using System.IO; + +namespace QnapBackupDecryptor.Core.Tests +{ + + [TestFixture] + public class FileHelpersTests + { + [Test] + public void IsOpenSslEncrypted_OpenSslFile_Binary_True() + { + // Arrange + var oseFile = new FileInfo(@"TestFiles/encrypted.jpg"); + // Act + var result = OpenSsl.IsOpenSslEncrypted(oseFile); + + // Assert + result.Data.ShouldBeTrue(); + } + + [Test] + public void IsOpenSslEncrypted_OpenSslFile_Text_True() + { + // Arrange + var oseFile = new FileInfo(@"TestFiles/encrypted.txt"); + // Act + var result = OpenSsl.IsOpenSslEncrypted(oseFile); + + // Assert + result.Data.ShouldBeTrue(); + } + + [Test] + public void IsOpenSslEncrypted_NotOpenSslFile_False() + { + // Arrange + var oseFile = new FileInfo(@"TestFiles/plaintext.txt"); + // Act + var result = OpenSsl.IsOpenSslEncrypted(oseFile); + + // Assert + result.Data.ShouldBeFalse(); + } + + } +} diff --git a/src/QnapBackupDecryptor.Core.Tests/QnapBackupDecryptor.Core.Tests.csproj b/src/QnapBackupDecryptor.Core.Tests/QnapBackupDecryptor.Core.Tests.csproj new file mode 100644 index 0000000..928c13a --- /dev/null +++ b/src/QnapBackupDecryptor.Core.Tests/QnapBackupDecryptor.Core.Tests.csproj @@ -0,0 +1,39 @@ + + + + net5.0 + false + false + + + + + + + + + + + PreserveNewest + + + PreserveNewest + + + PreserveNewest + + + + + + + + + + + + + + + + diff --git a/src/QnapBackupDecryptor.Core.Tests/TestFiles/encrypted.jpg b/src/QnapBackupDecryptor.Core.Tests/TestFiles/encrypted.jpg new file mode 100644 index 0000000..d4c2710 Binary files /dev/null and b/src/QnapBackupDecryptor.Core.Tests/TestFiles/encrypted.jpg differ diff --git a/src/QnapBackupDecryptor.Core.Tests/TestFiles/encrypted.txt b/src/QnapBackupDecryptor.Core.Tests/TestFiles/encrypted.txt new file mode 100644 index 0000000..2076600 --- /dev/null +++ b/src/QnapBackupDecryptor.Core.Tests/TestFiles/encrypted.txt @@ -0,0 +1,2 @@ +Salted__ .vyI śP +caد#c#RCSt\OEn  \ No newline at end of file diff --git a/src/QnapBackupDecryptor.Core.Tests/TestFiles/plaintext.txt b/src/QnapBackupDecryptor.Core.Tests/TestFiles/plaintext.txt new file mode 100644 index 0000000..fb18fcb --- /dev/null +++ b/src/QnapBackupDecryptor.Core.Tests/TestFiles/plaintext.txt @@ -0,0 +1,2 @@ +line1: this is a plaintext file +line2: End! diff --git a/src/QnapBackupDecryptor.Core/JobMaker.cs b/src/QnapBackupDecryptor.Core/JobMaker.cs new file mode 100644 index 0000000..3e93a7e --- /dev/null +++ b/src/QnapBackupDecryptor.Core/JobMaker.cs @@ -0,0 +1,72 @@ +using System.Collections.Generic; +using System.IO; +using System.Linq; + +namespace QnapBackupDecryptor.Core +{ + public record FileJob(FileSystemInfo EncryptedFile, FileSystemInfo OutputFile, bool Success, string ErrorMessage); + + public static class JobMaker + { + + public static List GetDecryptJob(string encryptedSource, string decryptedTarget, bool overwrite, bool includeSubFolders) + { + var sourceIsFolder = File.GetAttributes(encryptedSource).HasFlag(FileAttributes.Directory); + var destIsFolder = File.GetAttributes(decryptedTarget).HasFlag(FileAttributes.Directory); + + if (sourceIsFolder & destIsFolder == false) + return new List { new FileJob(new DirectoryInfo(encryptedSource), new FileInfo(decryptedTarget), false, "Cannot write an encrypted folder to a single file") }; + + if (sourceIsFolder & destIsFolder) + return GetJobs(new DirectoryInfo(encryptedSource), new DirectoryInfo(decryptedTarget), overwrite, includeSubFolders); + + if (destIsFolder) + return new List { GetJob(new FileInfo(encryptedSource), new DirectoryInfo(decryptedTarget), overwrite) }; + else + return new List { GetJob(new FileInfo(encryptedSource), new FileInfo(decryptedTarget), overwrite) }; + } + + + private static FileJob GetJob(FileInfo encrytedFile, FileInfo outputFile, bool overwrite) + { + if (encrytedFile.Exists == false) + return new FileJob(encrytedFile, outputFile, false, "Encrypted file doesn't exist"); + + if (outputFile.Exists & overwrite == false) + return new FileJob(encrytedFile, outputFile, false, "Output file already exists, use --overwrite to overwrite files."); + + if (outputFile.Exists & outputFile.Attributes == FileAttributes.ReadOnly) + return new FileJob(encrytedFile, outputFile, false, "Cannot write to output file - it's ReadOnly in the file system."); + + if (OpenSsl.IsOpenSslEncrypted(encrytedFile) == false) + return new FileJob(encrytedFile, outputFile, false, "File is not encrypted with the OpenSSL method."); + + return new FileJob(encrytedFile, outputFile, true, string.Empty); + } + + private static FileJob GetJob(FileInfo encrytedFile, DirectoryInfo outputFolder, bool overwrite) + { + var outputFile = new FileInfo(Path.Combine(outputFolder.FullName, encrytedFile.Name)); + return GetJob(encrytedFile, outputFile, overwrite); + } + + private static List GetJobs(DirectoryInfo encrytedFolder, DirectoryInfo outputFolder, bool overwrite, bool includeSubfolders) + { + if (encrytedFolder.Exists == false) + return new List { new FileJob(encrytedFolder, outputFolder, false, "Encrypted folder doesn't exist") }; + + if (outputFolder.Exists & outputFolder.Attributes == FileAttributes.ReadOnly) + return new List { new FileJob(encrytedFolder, outputFolder, false, "Cannot write to output folder - it's ReadOnly in the file system.") }; + + var fileInfos = encrytedFolder.EnumerateFiles("*.*", includeSubfolders ? SearchOption.AllDirectories : SearchOption.TopDirectoryOnly); + + return fileInfos + .AsParallel() + .Select(encrytedFile => GetJob(encrytedFile, outputFolder, overwrite)) + .ToList(); + } + + + + } +} diff --git a/src/QnapBackupDecryptor.Core/OpenSsl.cs b/src/QnapBackupDecryptor.Core/OpenSsl.cs new file mode 100644 index 0000000..be17489 --- /dev/null +++ b/src/QnapBackupDecryptor.Core/OpenSsl.cs @@ -0,0 +1,143 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Security.Cryptography; +using System.Text; + +namespace QnapBackupDecryptor.Core +{ + public static class OpenSsl + { + public const string SALT_HEADER_TEXT = "Salted__"; + public const int SALT_HEADER_SIZE = 8; + public const int SALT_SIZE = 8; + + public static Result IsOpenSslEncrypted(FileInfo file) + { + var salt = new byte[SALT_SIZE]; + try + { + using var fileStream = file.OpenRead(); + fileStream.Read(salt); + var startsWithHeaderText = System.Text.Encoding.UTF8.GetString(salt) == SALT_HEADER_TEXT; + return Result.OkResult(startsWithHeaderText); + } + catch (Exception ex) + { + return Result.ErrorResult(ex.Message, false); + } + } + + public static Result Decrypt(FileInfo encryptedFile, byte[] password, FileInfo outputFile) + { + var salt = GetSalt(encryptedFile); + + var (key, iv) = DeriveKeyAndIV(password, salt); + + if (key == null || iv == null || salt == null) + return Result.ErrorResult("Key / IV / Salt is invalid", outputFile); + + return DecryptFile(encryptedFile, key, iv, outputFile); + } + + private static byte[] GetSalt(FileInfo encryptedFile) + { + using var inputStream = encryptedFile.OpenRead(); + + // read the salt header + var salt = new byte[SALT_HEADER_SIZE]; + inputStream.Read(salt); + + // sanity check + var saltHeader = Encoding.UTF8.GetString(salt); + if (saltHeader != SALT_HEADER_TEXT) + return null; + + inputStream.Read(salt, 0, SALT_SIZE); + + return salt; + } + + private static (byte[] key, byte[] iv) DeriveKeyAndIV(byte[] password, byte[] salt) + { + var keyAndIvBytes = new List(48); + + var currentHash = Array.Empty(); + + using var md5Hash = MD5.Create(); + var gotKeyBytes = false; + + while (gotKeyBytes == false) + { + var preHashLength = currentHash.Length + password.Length + salt.Length; + var preHash = new byte[preHashLength]; + + Buffer.BlockCopy(currentHash, 0, preHash, 0, currentHash.Length); + Buffer.BlockCopy(password, 0, preHash, currentHash.Length, password.Length); + Buffer.BlockCopy(salt, 0, preHash, currentHash.Length + password.Length, salt.Length); + + currentHash = md5Hash.ComputeHash(preHash); + keyAndIvBytes.AddRange(currentHash); + + if (keyAndIvBytes.Count >= 48) + gotKeyBytes = true; + } + + var key = new byte[32]; + var iv = new byte[16]; + + // pull out the key + keyAndIvBytes.CopyTo(0, key, 0, 32); + + // pull out the IV + keyAndIvBytes.CopyTo(32, iv, 0, 16); + + md5Hash.Clear(); + + return (key, iv); + } + + private static Result DecryptFile(FileInfo encryptedFile, byte[] key, byte[] iv, FileInfo outputFile) + { + var rijndaelManaged = new RijndaelManaged + { + Mode = CipherMode.CBC, + KeySize = 256, + BlockSize = 128, + Key = key, + IV = iv, + Padding = PaddingMode.PKCS7 + }; + + try + { + var decryptor = rijndaelManaged.CreateDecryptor(); + + using var encryptedFileStream = encryptedFile.OpenRead(); + encryptedFileStream.Position = SALT_HEADER_SIZE + SALT_SIZE; + + using var destination = outputFile.OpenWrite(); + using var cryptoStream = new CryptoStream(encryptedFileStream, decryptor, CryptoStreamMode.Read); + + cryptoStream.CopyTo(destination); + + destination.Flush(); + + return Result.OkResult(outputFile); + } + catch (Exception ex) + { + outputFile.Delete(); + return Result.ErrorResult("could not decrypt", outputFile, ex); + } + finally + { + rijndaelManaged.Clear(); + rijndaelManaged.Dispose(); + } + + } + + } + +} diff --git a/src/QnapBackupDecryptor.Core/QnapBackupDecryptor.Core.csproj b/src/QnapBackupDecryptor.Core/QnapBackupDecryptor.Core.csproj new file mode 100644 index 0000000..f208d30 --- /dev/null +++ b/src/QnapBackupDecryptor.Core/QnapBackupDecryptor.Core.csproj @@ -0,0 +1,7 @@ + + + + net5.0 + + + diff --git a/src/QnapBackupDecryptor.Core/Result.cs b/src/QnapBackupDecryptor.Core/Result.cs new file mode 100644 index 0000000..d3eb480 --- /dev/null +++ b/src/QnapBackupDecryptor.Core/Result.cs @@ -0,0 +1,40 @@ +using System; + +namespace QnapBackupDecryptor.Core +{ + public class Result + { + public Exception Exception { get; } + public bool IsSuccess { get; } + public bool IsError => !IsSuccess; + public string ErrorMessage { get; } + public string SuccessMessage { get; } + + public T Data { get; } + + internal Result(bool isSuccess, string errorMessage, T data, string successMessage, Exception exception) + { + IsSuccess = isSuccess; + ErrorMessage = errorMessage; + Data = data; + SuccessMessage = successMessage; + Exception = exception; + } + + public static Result OkResult(T data, string message) + => new Result(true, string.Empty, data, message, null); + + public static Result OkResult(T data) + => new Result(true, string.Empty, data, string.Empty, null); + + public static Result ErrorResult(string errorMessage, T data) + => new Result(false, errorMessage, data, string.Empty, null); + + public static Result ErrorResult(string errorMessage, T data, TE exception) where TE : Exception + => new Result(false, errorMessage, data, string.Empty, exception); + + public static implicit operator T(Result a) + => a.Data; + } + +} diff --git a/src/QnapBackupDecryptor.sln b/src/QnapBackupDecryptor.sln new file mode 100644 index 0000000..ac1caf2 --- /dev/null +++ b/src/QnapBackupDecryptor.sln @@ -0,0 +1,37 @@ + +Microsoft Visual Studio Solution File, Format Version 12.00 +# Visual Studio Version 16 +VisualStudioVersion = 16.0.31005.135 +MinimumVisualStudioVersion = 10.0.40219.1 +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "QnapBackupDecryptor.Console", "QnapBackupDecryptor.Console\QnapBackupDecryptor.Console.csproj", "{5F2A6DEE-4B0A-42A2-9583-5C5BFC40A704}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "QnapBackupDecryptor.Core", "QnapBackupDecryptor.Core\QnapBackupDecryptor.Core.csproj", "{95F53606-3B59-45CA-AA6A-D72BBA134149}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "QnapBackupDecryptor.Core.Tests", "QnapBackupDecryptor.Core.Tests\QnapBackupDecryptor.Core.Tests.csproj", "{E8CBC8A0-1B18-4430-B313-68CAC469514F}" +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Any CPU = Debug|Any CPU + Release|Any CPU = Release|Any CPU + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {5F2A6DEE-4B0A-42A2-9583-5C5BFC40A704}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {5F2A6DEE-4B0A-42A2-9583-5C5BFC40A704}.Debug|Any CPU.Build.0 = Debug|Any CPU + {5F2A6DEE-4B0A-42A2-9583-5C5BFC40A704}.Release|Any CPU.ActiveCfg = Release|Any CPU + {5F2A6DEE-4B0A-42A2-9583-5C5BFC40A704}.Release|Any CPU.Build.0 = Release|Any CPU + {95F53606-3B59-45CA-AA6A-D72BBA134149}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {95F53606-3B59-45CA-AA6A-D72BBA134149}.Debug|Any CPU.Build.0 = Debug|Any CPU + {95F53606-3B59-45CA-AA6A-D72BBA134149}.Release|Any CPU.ActiveCfg = Release|Any CPU + {95F53606-3B59-45CA-AA6A-D72BBA134149}.Release|Any CPU.Build.0 = Release|Any CPU + {E8CBC8A0-1B18-4430-B313-68CAC469514F}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {E8CBC8A0-1B18-4430-B313-68CAC469514F}.Debug|Any CPU.Build.0 = Debug|Any CPU + {E8CBC8A0-1B18-4430-B313-68CAC469514F}.Release|Any CPU.ActiveCfg = Release|Any CPU + {E8CBC8A0-1B18-4430-B313-68CAC469514F}.Release|Any CPU.Build.0 = Release|Any CPU + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE + EndGlobalSection + GlobalSection(ExtensibilityGlobals) = postSolution + SolutionGuid = {7D068B49-E8DC-4B97-9361-081F7AF0C85F} + EndGlobalSection +EndGlobal diff --git a/src/nuget.config b/src/nuget.config new file mode 100644 index 0000000..2c70539 --- /dev/null +++ b/src/nuget.config @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file