LCP support

.github/ISSUE_TEMPLATE/QUESTION.yml

@@ -10,16 +10,16 @@ body:
     id: calibre-version
     attributes:
       label: Which version of Calibre are you running?
-      description: "Example: 5.30"
-      placeholder: "5.30"
+      description: "Example: 5.32"
+      placeholder: "5.32"
     validations: 
       required: true
   - type: input
     id: plugin-version
     attributes:
       label: Which version of the DeDRM plugin are you running?
-      description: "Example: v7.2.1"
-      placeholder: "v7.2.1"
+      description: "Example: v10.0.0"
+      placeholder: "v10.0.0"
     validations: 
       required: true
   - type: input

CHANGELOG.md

@@ -0,0 +1,23 @@
+# Changelog
+
+List of changes since the fork of Apprentice Harper's repository: 
+
+- CI testing / linting removed as that always failed anyways. The CI now "just" packages the plugin.
+- Support for the Readium LCP DRM (also known as "CARE DRM" or "TEA DRM"). This supports EPUB and PDF files. It does not yet support Readium LCPDF/LPF/LCPA/LCPAU/LCPDI files, as I don't have access to any of these. If you have an LCP-protected file in one of these formats that this plugin does not work with, please open [an issue](https://github.com/noDRM/DeDRM_tools/issues) and attach the file to the report.
+- Add new Github issue report form which forces the user to include stuff like their Calibre version to hopefully increase the quality of bug reports.
+- Issues with PDF files in Calibre 5 should be fixed (merged [apprenticeharper/DeDRM_tools#1689](https://github.com/apprenticeharper/DeDRM_tools/pull/1689) ).
+- Fixed tons of issues with the B&N PDF DRM removal script ignoblepdf.py. It looks like that has never been tested since the move to Python3. I have integrated the B&N-specific code into ineptpdf.py, the original ignoblepdf.py is now unused. Fairly untested as I don't have any PDFs with B&N DRM.
+- Issues with Obok key retrieval fixed (merged [apprenticeharper/DeDRM_tools#1691](https://github.com/apprenticeharper/DeDRM_tools/pull/1691) ).
+- Issues with obfuscated Adobe fonts fixed (fixes [apprenticeharper/DeDRM_tools#1828](https://github.com/apprenticeharper/DeDRM_tools/issues/1828) ).
+- Deobfuscate font files in EPUBs by default (can be disabled in the plugin settings).
+- The standalone adobekey.py script now includes the account UUID in the key file name.
+- When extracting the default key from an ADE install, include the account UUID in the key name.
+- Adobe key management window size increased to account for longer key names due to the UUID.
+- Verify that the decrypted book key has the correct format. This makes it way less likely for issue [apprenticeharper/DeDRM_tools#1862](https://github.com/apprenticeharper/DeDRM_tools/issues/1862) to cause trouble.
+- If the Adobe owner UUID of a book being imported happens to be included in a particular key's name, try this key first before trying all the others. This completely fixes [apprenticeharper/DeDRM_tools#1862](https://github.com/apprenticeharper/DeDRM_tools/issues/1862), but only if the key name contains the correct UUID (not always the case, especially for keys imported with older versions of the plugin). It also makes DRM removal faster as the plugin no longer has to attempt all possible keys.
+- Remove some additional DRM remnants in Amazon MOBI files (merged [apprenticeharper/DeDRM_tools#23](https://github.com/apprenticeharper/DeDRM_tools/pull/23) ).
+- Just in case it's necessary, added a setting to the B&N key generation script to optionally allow the user to select the old key generation algorithm. Who knows, they might want to remove DRM from old books with the old key scheme.
+- Add a more verbose error message when trying to remove DRM from a book with the new, not-yet-cracked version of the Adobe ADEPT DRM.
+- Added back support for Python2 (Calibre 2.0+). Only tested with ADEPT (PDF & EPUB) and Readium LCP so far, please open an issue if there's errors with other book types.
+- Begin work on removing some kinds of watermarks from files after DRM removal. This isn't tested a lot, and is disabled by default. You can enable it in the plugin settings.
+- If you're using the [ACSM Input Plugin / DeACSM](https://www.mobileread.com/forums/showthread.php?t=341975), the encryption key will automatically be extracted from that plugin if necessary.

DeDRM_plugin/DeDRM_Help.htm

@@ -17,15 +17,19 @@
 
 <body>
 
-<h1>DeDRM Plugin <span class="version">(v6.7.0)</span></h1>
+<h1>DeDRM Plugin <span class="version">(v10.0.0)</span></h1>
 
 <p>This plugin removes DRM from ebooks when they are imported into calibre. If you already have DRMed ebooks in your calibre library, you will need to remove them and import them again.</p>
 
+<p>It is a forked version created by NoDRM, based on the original plugin by Apprentice Alf and Apprentice Harper.</p>
+
 <h3>Installation</h3>
 <p>You have obviously managed to install the plugin, as otherwise you wouldn’t be reading this help file. However, you should also delete any older DRM removal plugins, as this DeDRM plugin replaces the five older plugins: Kindle and Mobipocket DeDRM (K4MobiDeDRM), Ignoble Epub DeDRM (ignobleepub), Inept Epub DeDRM (ineptepub), Inept PDF DeDRM (ineptepub) and eReader PDB 2 PML (eReaderPDB2PML).</p>
 
 <h3>Configuration</h3>
-<p>On Windows and Mac, the keys for ebooks downloaded for Kindle for Mac/PC and Adobe Digital Editions are automatically generated. If all your DRMed ebooks can be opened and read in Kindle for Mac/PC and/or Adobe Digital Editions on the same computer on which you are running calibre, you do not need to do any configuration of this plugin. On Linux, keys for Kindle for PC and Adobe Digital Editions need to be generated separately (see the Linux section below)</p>
+<p>On Windows and Mac, the keys for ebooks downloaded for Kindle for Mac/PC and Adobe Digital Editions are automatically generated. If all your DRMed ebooks can be opened and read in Kindle for Mac/PC and/or Adobe Digital Editions on the same computer on which you are running calibre, you do not need to do any configuration of this plugin. On Linux, keys for Kindle for PC and Adobe Digital Editions need to be generated separately (see the Linux section below).</p>
+
+<p>If you are using the <a href="https://www.mobileread.com/forums/showthread.php?t=341975">DeACSM / ACSM Input Plugin</a> for Calibre, the keys will also automatically be dumped for you.</p>
 
 <p>If you have other DRMed ebooks, you will need to enter extra configuration information. The buttons in this dialog will open individual configuration dialogs that will allow you to enter the needed information, depending on the type and source of your DRMed eBooks. Additional help on the information required is available in each of the the dialogs.</p>
 
@@ -42,11 +46,12 @@ <h3>Troubleshooting:</h3>
 
 <h3>Credits:</h3>
 <ul>
+<li>NoDRM for a bunch of updates and the Readium LCP support</li>
 <li>The Dark Reverser for the Mobipocket and eReader scripts</li>
 <li>i♥cabbages for the Adobe Digital Editions scripts</li>
 <li>Skindle aka Bart Simpson for the Amazon Kindle for PC script</li>
 <li>CMBDTC for Amazon Topaz DRM removal script</li>
-<li>some_updates, clarknova and Bart Simpson for  Amazon Topaz conversion scripts</li>
+<li>some_updates, clarknova and Bart Simpson for Amazon Topaz conversion scripts</li>
 <li>DiapDealer for the first calibre plugin versions of the tools</li>
 <li>some_updates, DiapDealer, Apprentice Alf and mdlnx for Amazon Kindle/Mobipocket tools</li>
 <li>some_updates for the DeDRM all-in-one Python tool</li>
@@ -55,7 +60,8 @@ <h3>Credits:</h3>
 <li>And probably many more.</li>
 </ul>
 
-<h3> For additional help read the <a href="https://github.com/apprenticeharper/DeDRM_tools/blob/master/FAQs.md">FAQs</a> at <a href="https://github.com/apprenticeharper/DeDRM_tools/">Apprentice Harpers’s GitHub repository</a>. You can ask questions in the comments section of the <a href="http://apprenticealf.wordpress.com/2012/09/10/drm-removal-tools-for-ebooks/">first post</a> at <a href="http://wordpress.com/apprenticealf/">Apprentice Alf's blog</a> or <a href="https://github.com/apprenticeharper/DeDRM_tools/issues">raise an issue</a>. </h3>
+<h3>For additional help read the <a href="https://github.com/noDRM/DeDRM_tools/blob/master/FAQs.md">FAQs</a> at <a href="https://github.com/noDRM/DeDRM_tools">NoDRM's GitHub repository</a> (or the corresponding <a href="https://github.com/apprenticeharper/DeDRM_tools/blob/master/FAQs.md">FAQs</a> at <a href="https://github.com/apprenticeharper/DeDRM_tools/">Apprentice Harpers’s GitHub repository</a>). You can <a href="https://github.com/noDRM/DeDRM_tools/issues">open issue reports</a>related to this fork at NoDRM's GitHub repository.</h3>
+
 
 <h2>Linux Systems Only</h2>
 <h3>Generating decryption keys for Adobe Digital Editions and Kindle for PC</h3>

DeDRM_plugin/DeDRM_Mobipocket PID_Help.htm

@@ -35,7 +35,7 @@ <h3>Deleting Mobipocket PIDs:</h3>
 
 <p>On the right-hand side of the plugin’s customization dialog, you will see a button with an icon that looks like a red "X". Clicking this button will delete the highlighted Mobipocket PID from the list. You will be prompted once to be sure that’s what you truly mean to do. Once gone, it’s permanently gone.</p>
 
-<p>Once done creating/deleting PIDs, click Close to exit the customization dialogue. Your changes wil only be saved permanently when you click OK in the main configuration dialog.</p>
+<p>Once done creating/deleting PIDs, click Close to exit the customization dialogue. Your changes will only be saved permanently when you click OK in the main configuration dialog.</p>
 
 </body>
 

DeDRM_plugin/DeDRM_Readium LCP passphrase_Help.htm

@@ -0,0 +1,41 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
+	"http://www.w3.org/TR/html4/strict.dtd">
+
+<html>
+
+<head>
+<meta http-equiv="content-type" content="text/html; charset=utf-8">
+<title>Managing Readium LCP passphrases</title>
+<style type="text/css">
+span.version {font-size: 50%}
+span.bold {font-weight: bold}
+h3 {margin-bottom: 0}
+p {margin-top: 0}
+li {margin-top: 0.5em}
+</style>
+</head>
+
+<body>
+
+<h1>Managing Readium LCP passphrases</h1>
+
+<p>Readium LCP is a relatively new eBook DRM. It's also known under the names "CARE DRM" or "TEA DRM". It does not rely on any accounts or key data that's difficult to acquire. All you need to open (or decrypt) LCP eBooks is the account passphrase given to you by the eBook provider - the very same passphrase you'd have to enter into your eBook reader device (once) to read LCP-encrypted books.</p>
+
+
+<h3>Entering an LCP passphrase:</h3>
+
+<p>On the right-hand side of the plugin’s customization dialog, you will see a button with an icon that looks like a green plus sign (+). Clicking this button will open a new dialog for entering a new passphrase.</p>
+
+<p>Just enter your passphrase as provided with the book, then click the OK button to save the passphrase. </p>
+
+<p>Usually, passphrases are identical for all books bought with the same account. So if you buy multiple LCP-protected eBooks, they'll usually all have the same passphrase if they've all been bought at the same store with the same account. </p>
+
+<h3>Deleting an LCP passphrase:</h3>
+
+<p>On the right-hand side of the plugin’s customization dialog, you will see a button with an icon that looks like a red "X". Clicking this button will delete the highlighted passphrase from the list. You will be prompted once to be sure that’s what you truly mean to do. Once gone, it’s permanently gone.</p>
+
+<p>Once done entering/deleting passphrases, click Close to exit the customization dialogue. Your changes will only be saved permanently when you click OK in the main configuration dialog.</p>
+
+</body>
+
+</html>

DeDRM_plugin/__init__.py

@@ -6,7 +6,7 @@
 # Copyright © 2021 NoDRM
 
 __license__   = 'GPL v3'
-__version__ = '7.2.1'
+__version__ = '10.0.0'
 __docformat__ = 'restructuredtext en'
 
 
@@ -78,6 +78,7 @@
 #   7.1.0 - Full release for calibre 5.x
 #   7.2.0 - Update for latest KFX changes, and Python 3 Obok fixes.
 #   7.2.1 - Whitespace!
+#  10.0.0 - First forked version by NoDRM. See CHANGELOG.md for details.
 
 """
 Decrypt DRMed ebooks.
@@ -130,7 +131,7 @@ def __getattr__(self, attr):
 
 class DeDRM(FileTypePlugin):
     name                    = PLUGIN_NAME
-    description             = "Removes DRM from Amazon Kindle, Adobe Adept (including Kobo), Barnes & Noble, Mobipocket and eReader ebooks. Credit given to i♥cabbages and The Dark Reverser for the original stand-alone scripts."
+    description             = "Removes DRM from Amazon Kindle, Adobe Adept (including Kobo), Readium LCP, Barnes & Noble, Mobipocket and eReader ebooks. Credit given to i♥cabbages and The Dark Reverser for the original stand-alone scripts."
     supported_platforms     = ['linux', 'osx', 'windows']
     author                  = "Apprentice Alf, Apprentice Harper, NoDRM, The Dark Reverser and i♥cabbages"
     version                 = PLUGIN_VERSION_TUPLE
@@ -225,10 +226,10 @@ def postProcessEPUB(self, path_to_ebook):
 
                 # Remove watermarks (currently just Amazon) from the OPF file
                 path_to_ebook = watermark.removeOPFwatermarks(self, path_to_ebook) or path_to_ebook
-                    
+
                 # Remove watermarks (currently just Adobe's resource ID) from all HTML and XHTML files
                 path_to_ebook = watermark.removeHTMLwatermarks(self, path_to_ebook) or path_to_ebook
-            
+
                 return path_to_ebook
 
         except: 
@@ -240,18 +241,18 @@ def checkFonts(self, path_to_ebook):
         # It checks if there's fonts that need to be deobfuscated
 
         try: 
-                import calibre_plugins.dedrm.epubfontdecrypt as epubfontdecrypt
+            import calibre_plugins.dedrm.epubfontdecrypt as epubfontdecrypt
 
-                output = self.temporary_file(".epub").name
-                ret = epubfontdecrypt.decryptFontsBook(path_to_ebook, output)
+            output = self.temporary_file(".epub").name
+            ret = epubfontdecrypt.decryptFontsBook(path_to_ebook, output)
 
-                if (ret == 0):
-                    return output
-                elif (ret == 1):
-                    return path_to_ebook
-                else:
-                    print("{0} v{1}: Error during font deobfuscation".format(PLUGIN_NAME, PLUGIN_VERSION))
-                    raise DeDRMError("Font deobfuscation failed")
+            if (ret == 0):
+                return output
+            elif (ret == 1):
+                return path_to_ebook
+            else:
+                print("{0} v{1}: Error during font deobfuscation".format(PLUGIN_NAME, PLUGIN_VERSION))
+                raise DeDRMError("Font deobfuscation failed")
 
         except: 
             print("{0} v{1}: Error during font deobfuscation".format(PLUGIN_NAME, PLUGIN_VERSION))
@@ -276,6 +277,22 @@ def ePubDecrypt(self,path_to_ebook):
         import calibre_plugins.dedrm.prefs as prefs
         dedrmprefs = prefs.DeDRM_Prefs()
 
+
+        # import the LCP handler
+        import calibre_plugins.dedrm.lcpdedrm as lcpdedrm
+
+        if (lcpdedrm.isLCPbook(path_to_ebook)):
+            try: 
+                retval = lcpdedrm.decryptLCPbook(path_to_ebook, dedrmprefs['lcp_passphrases'], self)
+            except:
+                print("Looks like that didn't work:")
+                raise
+
+            return self.postProcessEPUB(retval)
+
+
+        # Not an LCP book, do the normal EPUB (Adobe) handling.
+
         # import the Barnes & Noble ePub handler
         import calibre_plugins.dedrm.ignobleepub as ignobleepub
 
@@ -545,8 +562,21 @@ def ePubDecrypt(self,path_to_ebook):
     def PDFDecrypt(self,path_to_ebook):
         import calibre_plugins.dedrm.prefs as prefs
         import calibre_plugins.dedrm.ineptpdf as ineptpdf
+        import calibre_plugins.dedrm.lcpdedrm as lcpdedrm
         dedrmprefs = prefs.DeDRM_Prefs()
 
+        if (lcpdedrm.isLCPbook(path_to_ebook)):
+            try: 
+                retval = lcpdedrm.decryptLCPbook(path_to_ebook, dedrmprefs['lcp_passphrases'], self)
+            except:
+                print("Looks like that didn't work:")
+                raise
+
+            return retval
+
+
+        # Not an LCP book, do the normal Adobe handling.
+
         book_uuid = None
         try: 
             # Try to figure out which Adobe account this book is licensed for.