tahoe-capabilities (empty) → 0.1.0.0

raw patch · 7 files changed

+343/−0 lines, 7 filesdep +basedep +tahoe-capabilitiesdep +text

Dependencies added: base, tahoe-capabilities, text

Files

• CHANGELOG.md +6/−0
• LICENSE +165/−0
• README.md +28/−0
• src/Tahoe/Capability.hs +5/−0
• src/Tahoe/Capability/Internal/Confidential.hs +12/−0
• tahoe-capabilities.cabal +123/−0
• test/Main.hs +4/−0

@@ -0,0 +1,6 @@+# Revision history for tahoe-capabilities++## 0.1.0.0 -- 2023-08-15++* First version. Released on an unsuspecting world.+* Add the `ConfidentialShowable` type class for stringifying secrets.

@@ -0,0 +1,165 @@+                  GNU LESSER GENERAL PUBLIC LICENSE+                       Version 3, 29 June 2007++ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>+ Everyone is permitted to copy and distribute verbatim copies+ of this license document, but changing it is not allowed.+++  This version of the GNU Lesser General Public License incorporates+the terms and conditions of version 3 of the GNU General Public+License, supplemented by the additional permissions listed below.++  0. Additional Definitions.++  As used herein, "this License" refers to version 3 of the GNU Lesser+General Public License, and the "GNU GPL" refers to version 3 of the GNU+General Public License.++  "The Library" refers to a covered work governed by this License,+other than an Application or a Combined Work as defined below.++  An "Application" is any work that makes use of an interface provided+by the Library, but which is not otherwise based on the Library.+Defining a subclass of a class defined by the Library is deemed a mode+of using an interface provided by the Library.++  A "Combined Work" is a work produced by combining or linking an+Application with the Library.  The particular version of the Library+with which the Combined Work was made is also called the "Linked+Version".++  The "Minimal Corresponding Source" for a Combined Work means the+Corresponding Source for the Combined Work, excluding any source code+for portions of the Combined Work that, considered in isolation, are+based on the Application, and not on the Linked Version.++  The "Corresponding Application Code" for a Combined Work means the+object code and/or source code for the Application, including any data+and utility programs needed for reproducing the Combined Work from the+Application, but excluding the System Libraries of the Combined Work.++  1. Exception to Section 3 of the GNU GPL.++  You may convey a covered work under sections 3 and 4 of this License+without being bound by section 3 of the GNU GPL.++  2. Conveying Modified Versions.++  If you modify a copy of the Library, and, in your modifications, a+facility refers to a function or data to be supplied by an Application+that uses the facility (other than as an argument passed when the+facility is invoked), then you may convey a copy of the modified+version:++   a) under this License, provided that you make a good faith effort to+   ensure that, in the event an Application does not supply the+   function or data, the facility still operates, and performs+   whatever part of its purpose remains meaningful, or++   b) under the GNU GPL, with none of the additional permissions of+   this License applicable to that copy.++  3. Object Code Incorporating Material from Library Header Files.++  The object code form of an Application may incorporate material from+a header file that is part of the Library.  You may convey such object+code under terms of your choice, provided that, if the incorporated+material is not limited to numerical parameters, data structure+layouts and accessors, or small macros, inline functions and templates+(ten or fewer lines in length), you do both of the following:++   a) Give prominent notice with each copy of the object code that the+   Library is used in it and that the Library and its use are+   covered by this License.++   b) Accompany the object code with a copy of the GNU GPL and this license+   document.++  4. Combined Works.++  You may convey a Combined Work under terms of your choice that,+taken together, effectively do not restrict modification of the+portions of the Library contained in the Combined Work and reverse+engineering for debugging such modifications, if you also do each of+the following:++   a) Give prominent notice with each copy of the Combined Work that+   the Library is used in it and that the Library and its use are+   covered by this License.++   b) Accompany the Combined Work with a copy of the GNU GPL and this license+   document.++   c) For a Combined Work that displays copyright notices during+   execution, include the copyright notice for the Library among+   these notices, as well as a reference directing the user to the+   copies of the GNU GPL and this license document.++   d) Do one of the following:++       0) Convey the Minimal Corresponding Source under the terms of this+       License, and the Corresponding Application Code in a form+       suitable for, and under terms that permit, the user to+       recombine or relink the Application with a modified version of+       the Linked Version to produce a modified Combined Work, in the+       manner specified by section 6 of the GNU GPL for conveying+       Corresponding Source.++       1) Use a suitable shared library mechanism for linking with the+       Library.  A suitable mechanism is one that (a) uses at run time+       a copy of the Library already present on the user's computer+       system, and (b) will operate properly with a modified version+       of the Library that is interface-compatible with the Linked+       Version.++   e) Provide Installation Information, but only if you would otherwise+   be required to provide such information under section 6 of the+   GNU GPL, and only to the extent that such information is+   necessary to install and execute a modified version of the+   Combined Work produced by recombining or relinking the+   Application with a modified version of the Linked Version. (If+   you use option 4d0, the Installation Information must accompany+   the Minimal Corresponding Source and Corresponding Application+   Code. If you use option 4d1, you must provide the Installation+   Information in the manner specified by section 6 of the GNU GPL+   for conveying Corresponding Source.)++  5. Combined Libraries.++  You may place library facilities that are a work based on the+Library side by side in a single library together with other library+facilities that are not Applications and are not covered by this+License, and convey such a combined library under terms of your+choice, if you do both of the following:++   a) Accompany the combined library with a copy of the same work based+   on the Library, uncombined with any other library facilities,+   conveyed under the terms of this License.++   b) Give prominent notice with the combined library that part of it+   is a work based on the Library, and explaining where to find the+   accompanying uncombined form of the same work.++  6. Revised Versions of the GNU Lesser General Public License.++  The Free Software Foundation may publish revised and/or new versions+of the GNU Lesser 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+Library as you received it specifies that a certain numbered version+of the GNU Lesser General Public License "or any later version"+applies to it, you have the option of following the terms and+conditions either of that published version or of any later version+published by the Free Software Foundation. If the Library as you+received it does not specify a version number of the GNU Lesser+General Public License, you may choose any version of the GNU Lesser+General Public License ever published by the Free Software Foundation.++  If the Library as you received it specifies that a proxy can decide+whether future versions of the GNU Lesser General Public License shall+apply, that proxy's public statement of acceptance of any version is+permanent authorization for you to choose that version for the+Library.

@@ -0,0 +1,28 @@+# Tahoe-Capabilities++## What is it?++Tahoe-LAFS LIT, CHK, SDMF, and MDMF capabilities offer varying functionality for interacting with encrypted data.+This library provides abstractions for functionality common to all of these capability types.++All responsibility for implementing these abstractions is left to the capability-specific libraries.++### What is the current state?++* The `ConfidentialShowable` type class provides a uniform way for losslessly converting a capability to a string.++### What is planned?++Sufficient abstraction so that general encoding, decoding, upload, and download functions could be implemented independent of the specific capability type in use.++## Why does it exist?++Each specific Tahoe-LAFS capability type supports certain operations and offers certain security properties.+At a high level,+an application will often want to select among the available capability types to satisfy its particular security and/or privacy requirements.+A lower level exists encompassing such details of a capability type as which hash function is used or the size or alignment of certain fields.+Applications should typically not be required to make choices at this lower level.+By using a set of operations that abstract over these details,+application code can be kept simpler and more general-purpose.+By allowing some centralization of the choice of which concrete capability type to use,+applications can also be made more secure over time at a lower maintenance cost.

@@ -0,0 +1,5 @@+module Tahoe.Capability (+    module Tahoe.Capability.Internal.Confidential,+) where++import Tahoe.Capability.Internal.Confidential (ConfidentialShowable (..))

@@ -0,0 +1,12 @@+module Tahoe.Capability.Internal.Confidential where++import qualified Data.Text as T++{- | Something which contains confidential information and can be rendered as+ text such that the text also includes confidential information.  It is+ expected (but not required) that such types will also have a Show instance+ which obscures the confidential information.+-}+class ConfidentialShowable s where+    -- | Show the value, including any confidential information.+    confidentiallyShow :: s -> T.Text

@@ -0,0 +1,123 @@+cabal-version:   3.0++-- The cabal-version field refers to the version of the .cabal specification,+-- and can be different from the cabal-install (the tool) version and the+-- Cabal (the library) version you are using. As such, the Cabal (the library)+-- version used must be equal or greater than the version stated in this field.+-- Starting from the specification version 2.2, the cabal-version field must be+-- the first thing in the cabal file.++-- Initial package description 'tahoe-capabilities' generated by+-- 'cabal init'. For further documentation, see:+--   http://haskell.org/cabal/users-guide/+--+-- The name of the package.+name:            tahoe-capabilities++-- The package version.+-- See the Haskell package versioning policy (PVP) for standards+-- guiding when and how versions should be incremented.+-- https://pvp.haskell.org+-- PVP summary:  +-+------- breaking API changes+--               | | +----- non-breaking API additions+--               | | | +--- code changes with no API change+version:         0.1.0.0++-- A short (one-line) description of the package.+synopsis:        Abstractions related to Tahoe-LAFS "capabilities".++-- A longer description of the package.+description:+  Tahoe-LAFS LIT, CHK, SDMF, and MDMF capabilities offer varying functionality+  for interacting with encrypted data.  This library provides abstractions for+  functionality common to all of these capability types.++-- URL for the project homepage or repository.+homepage:+  https://whetstone.private.storage/PrivateStorage/tahoe-capabilities++-- The license under which the package is released.+license:         LGPL-3.0-or-later++-- The file containing the license text.+license-file:    LICENSE++-- The package author(s).+author:          Jean-Paul Calderone++-- An email address to which users can send suggestions, bug reports, and patches.+maintainer:      exarkun@twistedmatrix.com++-- A copyright notice.+-- copyright:+category:        Codec+build-type:      Simple++-- Extra doc files to be distributed with the package, such as a CHANGELOG or a README.+extra-doc-files:+  CHANGELOG.md+  README.md++-- Extra source files to be distributed with the package, such as examples, or a tutorial module.+-- extra-source-files:++source-repository head+  type:     git+  location:+    gitlab@whetstone.private.storage:privatestorage/tahoe-capabilities.git++common warnings+  ghc-options: -Wall++library+  -- Import common warning flags.+  import:           warnings++  -- Modules exported by the library.+  exposed-modules:+    Tahoe.Capability+    Tahoe.Capability.Internal.Confidential++  -- Modules included in this library but not exported.+  -- other-modules:++  -- LANGUAGE extensions used by modules in this package.+  -- other-extensions:++  -- Other library packages from which modules are imported.+  build-depends:+    , base  >=4.7     && <5+    , text  >=1.2.3.1 && <1.3++  -- Directories containing source files.+  hs-source-dirs:   src++  -- Base language which the package is written in.+  default-language: Haskell2010++test-suite tahoe-capabilities-test+  -- Import common warning flags.+  import:           warnings++  -- Base language which the package is written in.+  default-language: Haskell2010++  -- Modules included in this executable, other than Main.+  -- other-modules:++  -- LANGUAGE extensions used by modules in this package.+  -- other-extensions:++  -- The interface type and version of the test suite.+  type:             exitcode-stdio-1.0++  -- Directories containing source files.+  hs-source-dirs:   test++  -- The entrypoint to the test suite.+  main-is:          Main.hs++  -- Test dependencies.+  build-depends:+    , base                >=4.7 && <5+    , tahoe-capabilities

@@ -0,0 +1,4 @@+module Main (main) where++main :: IO ()+main = putStrLn "Test suite not yet implemented."