[Replicant] [vendor_replicant-scripts] [PATCH v4 1/3] Add script to generate the key-migration.sh script

Denis 'GNUtoo' Carikli GNUtoo at cyberdimension.org
Thu Oct 8 15:19:37 UTC 2020


The applications built from Replicant are signed with a key that is
generated during the build procedure The issue is that the data of an
application becomes inaccessible to it if the application signature change.
This affects all the applications built during and signed during the build
of Replicant images, which includes all system applications.

This is why, during the installation of a new Replicant version, the
otasigcheck.sh is run: it verifies if the application signatures expected
by the applications data match the signatures of the new applications
that are part of the new Replicant image being installed.

Without this check, users installing a new Replicant minor version (like
Replicant 6.0 0004) and keeping the data from the previous minor version
(like Replicant 6.0 0003) with a key that change will make at least some
system applications like the launcher crash as they will not be able to
access their data.

If the check detects an incompatibility, on a Galaxy SIII (GT-I9300), we
end up the installation aborting and the following message being displayed
on the screen:
  detected filesystem ext4 for /dev/block/mmcblk0p12
  Can't install this package on top of incompatible data. Ples
  se try another package or run a factory test
  E:Failed to install /sideload/package.zip
  E:Please take note of all the above lines for reports.

This design has several issues:
- You cannot upgrade between Replicant minor versions if the keys signing
  applications shipped in the new version changed. This is really
  problematic as to upgrade, users need to delete all their application
  data and restart creating them from scratch which is very time consuming.
  With frequent updates that would becomes too much time consuming to do.
- It is also very fragile: if the data partition is encrypted,
  otasigcheck.sh cannot do the check, and the check is skipped completely,
  with the consequences explained before (the system applications end up
  not being able to access their data).

To fix that:
- This patch adds a new python script for generating the key-migration.sh
  script that will be added to the vendor_replicant repository.
  Generating the key-migration.sh script with a python script enables users
  and developers to generate a key-migration.sh script with the keys they
  want. This should make downgrade easier as the key-migration.sh script
  could also be run manually in the recovery and also make the migration to
  self-built images much easier.
- The generated script (key-migration.sh) will be added to the
  vendor_replicant repository. It will take care of migrating the
  applications data to the new keys during the first boot (so after the
  data partition will have been mounted).
- The call to otasigcheck.sh during the installation of new Replicant
  versions will be removed in the build repository.
- otasigcheck.sh will be removed in the vendor_replicant repository.

Also, the otasigcheck.sh script has already been removed in LineageOS 17.1
by the following commit in vendor/lineage:
  commit 95621f3c73b94a87ca4528748535bb114ae1613f
  Author: Michael Bestas <mkbestas at lineageos.org>
  Date:   Sat Aug 4 17:46:35 2018 +0300

      Revert "ota: Validate any installed data's signature against our own"

      * otasigcheck doesn't work on encrypted devices and makes
        the zip installation fail since oreo.
      * The build part of this was never ported to oreo.

      This reverts commit aff5e54c4ef5fec7e67e830f83ee64424005d07c.

      Change-Id: I411f33c1db64844091c1692ef4706ae541925d4f

This key-migration.sh script has been generated by the following command in
the Replicant source code directory:
    $ ./vendor/replicant-scripts/images/gen_key_migration_script/gen_key_migration_script.py \
      gen-script \
      vendor/replicant/prebuilt/common/bin/key-migration.sh \
      vendor/replicant-data/distros/releases/certificates/ \
      vendor/replicant-security/

This work is based on the following commit from the android_vendor_cm
repository[1]:
    2f7c7decc Add startup script to update the package signatures
    commit 2f7c7decc4cd5b42f044a7841a74468e4cacd694 (refs/changes/27/156327/3)
    Author: Gabriele M <moto.falcon.git at gmail.com>
    Date:   Fri Jan 13 17:03:45 2017 +0100

        Add startup script to update the package signatures

        This allows to jump straight to LineageOS without wiping
        userdata first.

        Change-Id: I208bcada9380cbd69f3bec6c64e3c9e0eb1104c8

[1] https://github.com/LineageOS/android_vendor_cm.git

Signed-off-by: Denis 'GNUtoo' Carikli <GNUtoo at cyberdimension.org>
---
 images/gen_key_migration_script/COPYING       | 661 ++++++++++++++++++
 images/gen_key_migration_script/README        | 234 +++++++
 images/gen_key_migration_script/certs_data.py | 122 ++++
 .../gen_key_migration_script.py               | 176 +++++
 .../generate_shell_commands.py                | 101 +++
 .../templates/key-migration.sh                |  43 ++
 6 files changed, 1337 insertions(+)
 create mode 100644 images/gen_key_migration_script/COPYING
 create mode 100644 images/gen_key_migration_script/README
 create mode 100644 images/gen_key_migration_script/certs_data.py
 create mode 100755 images/gen_key_migration_script/gen_key_migration_script.py
 create mode 100644 images/gen_key_migration_script/generate_shell_commands.py
 create mode 100644 images/gen_key_migration_script/templates/key-migration.sh

diff --git a/images/gen_key_migration_script/COPYING b/images/gen_key_migration_script/COPYING
new file mode 100644
index 0000000..be3f7b2
--- /dev/null
+++ b/images/gen_key_migration_script/COPYING
@@ -0,0 +1,661 @@
+                    GNU AFFERO GENERAL PUBLIC LICENSE
+                       Version 3, 19 November 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The GNU Affero General Public License is a free, copyleft license for
+software and other kinds of works, specifically designed to ensure
+cooperation with the community in the case of network server software.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+our General Public Licenses are intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  Developers that use our General Public Licenses protect your rights
+with two steps: (1) assert copyright on the software, and (2) offer
+you this License which gives you legal permission to copy, distribute
+and/or modify the software.
+
+  A secondary benefit of defending all users' freedom is that
+improvements made in alternate versions of the program, if they
+receive widespread use, become available for other developers to
+incorporate.  Many developers of free software are heartened and
+encouraged by the resulting cooperation.  However, in the case of
+software used on network servers, this result may fail to come about.
+The GNU General Public License permits making a modified version and
+letting the public access it on a server without ever releasing its
+source code to the public.
+
+  The GNU Affero General Public License is designed specifically to
+ensure that, in such cases, the modified source code becomes available
+to the community.  It requires the operator of a network server to
+provide the source code of the modified version running there to the
+users of that server.  Therefore, public use of a modified version, on
+a publicly accessible server, gives the public access to the source
+code of the modified version.
+
+  An older license, called the Affero General Public License and
+published by Affero, was designed to accomplish similar goals.  This is
+a different license, not a version of the Affero GPL, but Affero has
+released a new version of the Affero GPL which permits relicensing under
+this license.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU Affero General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Remote Network Interaction; Use with the GNU General Public License.
+
+  Notwithstanding any other provision of this License, if you modify the
+Program, your modified version must prominently offer all users
+interacting with it remotely through a computer network (if your version
+supports such interaction) an opportunity to receive the Corresponding
+Source of your version by providing access to the Corresponding Source
+from a network server at no charge, through some standard or customary
+means of facilitating copying of software.  This Corresponding Source
+shall include the Corresponding Source for any work covered by version 3
+of the GNU General Public License that is incorporated pursuant to the
+following paragraph.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the work with which it is combined will remain governed by version
+3 of the GNU General Public License.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU Affero General Public License from time to time.  Such new versions
+will be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+  Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU Affero General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU Affero General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU Affero General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Affero General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  If your software can interact with users remotely through a computer
+network, you should also make sure that it provides a way for users to
+get its source.  For example, if your program is a web application, its
+interface could display a "Source" link that leads users to an archive
+of the code.  There are many ways you could offer source, and different
+solutions will be better for different programs; see section 13 for the
+specific requirements.
+
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU AGPL, see
+<https://www.gnu.org/licenses/>.
diff --git a/images/gen_key_migration_script/README b/images/gen_key_migration_script/README
new file mode 100644
index 0000000..8920016
--- /dev/null
+++ b/images/gen_key_migration_script/README
@@ -0,0 +1,234 @@
+== Context ==
+In Replicant we don't have any infrastructure nor procedure to handle long term
+secret key storage, and when building an image, some keys are generated.
+
+These keys are then used to sign various Android system applications that are
+built as part of the image, such as the dialer, the launcher, etc.
+
+So when a new release is built, new keys are generated. This creates an issue
+because the data of a given application is tied to the application signing key.
+
+So when the signing key changes, the applications cannot access its data
+anymore.
+
+== How to solve the issue ==
+In the android_vendor_cm repository[1] from LineageOS, there is the following
+commit:
+    2f7c7decc4cd5b42f044a7841a74468e4cacd694
+    2f7c7decc (refs/changes/27/156327/3) Add startup script to update the
+                                         package signatures
+
+It fixes that issue with a shell script (key-migration.sh) that runs at startup
+and removes the offending keys in /data/system/packages.xml, and makes sure not
+to run again when done. Removing the keys didn't work for us, however slightly
+modifying the script to replace them instead worked fine.
+
+As the keys were hardcoded in the key-migration.sh script, and that we keep
+changing keys at each new release, it makes sense to have a more automatic
+process that generates the key-migration.sh script from the packages.xml file.
+
+This is what the generate_key_migration_script.py does.
+
+References:
+-----------
+[1]https://github.com/LineageOS/android_vendor_cm/
+
+== Usage ==
+To use this script:
+- You need the public part of all the old certificates you want to migrate from.
+- You also need the public part of the new certificates you want to migrate to.
+
+Certificates to use with this tool can be found in several places:
+- The public part of all the certificates used for official releases are
+  published as part of the Replicant releases. Some older releases don't have
+  certificates as they didn't use them.
+  The releases certificates are also available in distros/releases/certificates
+  in the vendor_replicant-data  git repository[1] for convenience.
+  If you have the Replicant 6.0 source code, they are located in
+  vendor/replicant-data/distros/releases/certificates/.
+- The new certificates are generated as part of the build procedure and are
+  available in vendor/replicant-security/*x509.pem in the replicant source code
+  directory.
+- Certificates are also available in encoded form in data/system/packages.xml,
+  however they would need to be extracted from this file and put in a dedicated
+  directory to be able to be used by this script.
+
+The certificates need to be in a dedicated directory as the script expect that.
+
+For instance, if we have the following directory structure:
+$ ls vendor/replicant-security/*x509.pem
+  vendor/replicant-security/media.x509.pem
+  vendor/replicant-security/releasekey.x509.pem
+  vendor/replicant-security/platform.x509.pem
+  vendor/replicant-security/shared.x509.pem
+
+The tool will expect us to pass it the vendor/replicant-security/ argument.
+
+For the older release we can also have a directory that contains subdirectories
+that in turn contains the certificates. This way we can have one directory for
+each Replicant releases with the releases certificates inside. The tool will
+then use the directory names as releases names in the generated script.
+
+For instance if we have the following structure:
+$ cd vendor/replicant-data/distros/
+$ ls releases/certificates/*/*.x509.pem
+  releases/certificates/replicant-4.2-0001/media.x509.pem
+  releases/certificates/replicant-4.2-0001/platform.x509.pem
+  releases/certificates/replicant-4.2-0001/shared.x509.pem
+  releases/certificates/replicant-4.2-0001/system.x509.pem
+  releases/certificates/replicant-4.2-0002/media.x509.pem
+  releases/certificates/replicant-4.2-0002/platform.x509.pem
+  releases/certificates/replicant-4.2-0002/shared.x509.pem
+  releases/certificates/replicant-4.2-0002/system.x509.pem
+  releases/certificates/replicant-4.2-0003/media.x509.pem
+  releases/certificates/replicant-4.2-0003/platform.x509.pem
+  releases/certificates/replicant-4.2-0003/shared.x509.pem
+  releases/certificates/replicant-4.2-0003/system.x509.pem
+  releases/certificates/replicant-4.2-0004/media.x509.pem
+  releases/certificates/replicant-4.2-0004/platform.x509.pem
+  releases/certificates/replicant-4.2-0004/shared.x509.pem
+  releases/certificates/replicant-4.2-0004/system.x509.pem
+  releases/certificates/replicant-6.0-0001/media.x509.pem
+  releases/certificates/replicant-6.0-0001/platform.x509.pem
+  releases/certificates/replicant-6.0-0001/releasekey.x509.pem
+  releases/certificates/replicant-6.0-0001/shared.x509.pem
+  releases/certificates/replicant-6.0-0002/media.x509.pem
+  releases/certificates/replicant-6.0-0002/platform.x509.pem
+  releases/certificates/replicant-6.0-0002/releasekey.x509.pem
+  releases/certificates/replicant-6.0-0002/shared.x509.pem
+  releases/certificates/replicant-6.0-0003/media.x509.pem
+  releases/certificates/replicant-6.0-0003/platform.x509.pem
+  releases/certificates/replicant-6.0-0003/releasekey.x509.pem
+  releases/certificates/replicant-6.0-0003/shared.x509.pem
+  releases/certificates/replicant-6.0-0004-rc1/media.x509.pem
+  releases/certificates/replicant-6.0-0004-rc1/platform.x509.pem
+  releases/certificates/replicant-6.0-0004-rc1/releasekey.x509.pem
+  releases/certificates/replicant-6.0-0004-rc1/shared.x509.pem
+  releases/certificates/replicant-6.0-0004-rc2/media.x509.pem
+  releases/certificates/replicant-6.0-0004-rc2/platform.x509.pem
+  releases/certificates/replicant-6.0-0004-rc2/releasekey.x509.pem
+  releases/certificates/replicant-6.0-0004-rc2/shared.x509.pem
+
+we we will then need to pass the path of releases/certificates/
+to the tool.
+
+So in practice, with the directories structure above, we can use the
+generate_key_migration_script.py as follow to generate the key-migration.sh
+script:
+$ ./gen_key_migration_script.py gen-script \
+      vendor/replicant/prebuilt/common/bin/key-migration.sh \
+      vendor/replicant-data/distros/releases/certificates/ \
+      vendor/replicant-security/
+
+References:
+-----------
+[1]https://git.replicant.us/replicant/vendor_replicant-data/
+
+== Running the key-migration.sh script at boot ==
+Now that we have a key-migration.sh script, we need to make sure that the script
+is shipped to the device, and that it is run at boot.
+
+In Replicant 6.0, the modifications to do that should already be there.
+
+However if you want to use that tool with newer Replicant versions or other
+distributions, you will need to do several modifications.
+
+With Replicant 6.0, the following modifications were made in vendor/replicant
+to make the key-migration.sh script run at boot:
+- The key-migration.sh script was copied in prebuilt/common/etc/key-migration.sh
+  in the vendor_replicant repository.
+- The following patches from Gabriele M was applied:
+diff --git a/prebuilt/common/Android.mk b/prebuilt/common/Android.mk
+index f15b178c..f39105d0 100644
+--- a/prebuilt/common/Android.mk
++++ b/prebuilt/common/Android.mk
+@@ -8,3 +8,10 @@ LOCAL_MODULE_TAGS := optional
+ LOCAL_MODULE_CLASS := EXECUTABLES
+ LOCAL_MODULE_PATH := $(TARGET_OUT_OPTIONAL_EXECUTABLES)
+ include $(BUILD_PREBUILT)
++
++include $(CLEAR_VARS)
++LOCAL_MODULE := key-migration.sh
++LOCAL_SRC_FILES := etc/key-migration.sh
++LOCAL_MODULE_TAGS := optional
++LOCAL_MODULE_CLASS := ETC
++include $(BUILD_PREBUILT)
+
+diff --git a/prebuilt/common/etc/init.local.rc b/prebuilt/common/etc/init.local.rc
+index 53f972c9..bce1dc63 100644
+--- a/prebuilt/common/etc/init.local.rc
++++ b/prebuilt/common/etc/init.local.rc
+@@ -24,6 +24,8 @@ on post-fs-data
+     mkdir /data/ssh/empty 0600 root shell
+     mkdir /cache/recovery 0770 system cache
+ 
++    exec u:r:init:s0 root root -- /system/bin/sh /system/etc/key-migration.sh
++
+     # Run sysinit
+     start sysinit
+
+diff --git a/config/common.mk b/config/common.mk
+index 91d5e99b..132fd61a 100644
+--- a/config/common.mk
++++ b/config/common.mk
+@@ -230,6 +230,10 @@ PRODUCT_PACKAGES += \
+ endif
+ endif
+ 
++# test-keys migration script
++PRODUCT_PACKAGES += \
++    key-migration.sh
++
+ DEVICE_PACKAGE_OVERLAYS += vendor/replicant/overlay/common
+ 
+ ifeq ($(USE_OPENGL_RENDERER),true)
+
+== Running the key-migration.sh in the recovery ==
+In addition, it is also possible to use the key-migration.sh script in the
+recovery. This can be handy if you use custom images and that you don't want to
+build an entire Replicant image, or if you want to keep your data while
+downgrading to an older Replicant image.
+
+To do that you will first need to have adb configured so that you can get
+root in it. At the time of writing, the BackupTheEFS[1] wiki page has
+instructions on how to do that.
+
+Once this is done you can copy the key-migration.sh script inside the recovery.
+It can be done with the following command:
+$ adb push key-migration.sh /
+
+You then need to mount the data partition. Here's an example on how to do it on
+the Galaxy SIII (GT-I9300) with the Replicant 6.0 recovery:
+$ adb shell
+  root at m0:/ #
+  root at m0:/ # mount /dev/block/platform/dw_mmc/by-name/USERDATA /data/
+
+As the path of the data partition changes from device to device, you may need
+to adjust the path in the command above. The BackupTheEFS[1] wiki page has
+examples of that for mounting the EFS partition.
+
+You can then run the script. Note that you will need to use sh to run it
+as the interpreter path is hardcoded to /system/bin/sh which is absent in
+the recovery. You can do that like this:
+  root at m0:/ # sh key-migration.sh
+
+Note that once it executed, it will create the /data/system/.key-migration-done
+file which will tell the script not to do anything anymore the next times it
+runs. So if for some reason you need to force its execution or do two different
+upgrades, you can simply delete /data/system/.key-migration-done and retry to
+run the script. For example:
+  root at m0:/ # rm /data/system/.key-migration-done
+  root at m0:/ # sh key-migration.sh
+
+References:
+-----------
+[1]https://redmine.replicant.us/projects/replicant/wiki/BackupTheEFS
+
+== License ==
+- The key-migration.sh script is under the Apache License, Version 2.0 as its
+  header states.
+- All the other files are under the AGPLv3 or later.
+
+== Credits ==
+- Gabriele M for the 2f7c7decc4cd5b42f044a7841a74468e4cacd694 patch
+- Kurtis Hanna for finding that patch.
diff --git a/images/gen_key_migration_script/certs_data.py b/images/gen_key_migration_script/certs_data.py
new file mode 100644
index 0000000..c0f36b2
--- /dev/null
+++ b/images/gen_key_migration_script/certs_data.py
@@ -0,0 +1,122 @@
+#!/usr/bin/env python3
+# Copyright (C) 2020 Denis 'GNUtoo' Carikli <GNUtoo at cyberdimension.org>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+class ReplicantCertsData(object):
+    def __init__(self):
+        self.data = {
+            # '<filename>' : [
+            #     {
+            #         'release' : '<release|None>',
+            #         'key' : '<key>',
+            #         'key_format' : 'PEM|DER',
+            #         'generation' : 'old|new',
+            #     },
+            # ],
+        }
+
+    def fixup_name(self, name):
+        #  Replicant 4.2 and Replicant 6.0 both have media.x509.pem,
+        #  platform.x509.pem, and shared.x509.pem, however Replicant 4.2 has system.x509.pem
+        #  while Replicant 6.0 has releasekey.x509.pem instead.
+        if name == 'system.x509.pem':
+            return 'releasekey.x509.pem'
+        else:
+            return name
+
+    def add_key(self, name, generation, release, key_format, key):
+
+        assert (key_format in ['PEM', 'DER'])
+        assert (generation in ['old', 'new'])
+
+        name = self.fixup_name(name)
+
+        # Avoid duplicates
+        if len(self.get_keys(name, generation, release, key_format)) > 0:
+            assert(False)
+
+        # We have only one entry per key_format per 'new' certificate
+        if key_format == 'new' and len(self.get_new_keys(name, key_format)) > 0:
+            assert(False)
+
+        elm = {
+            'generation' : generation,
+            'release' : release,
+            'key' : key,
+            'key_format' : key_format,
+        }
+
+        if name not in self.data.keys():
+            self.data[name] = []
+
+        self.data[name].append(elm)
+
+    def get_keys(self, name, generation, release, key_format):
+        results = []
+        for elm in self.data.get(name, []):
+            if elm['release'] != release:
+                continue
+            elif ['key_format'] != key_format:
+                continue
+            elif elm['generation'] != generation:
+                continue
+            else:
+                results.append(elm)
+        return results
+
+    def get_new_keys(self, name, key_format):
+        results = []
+        for elm in self.data.get(name, []):
+            if elm['key_format'] != key_format:
+                continue
+            elif elm['generation'] != 'new':
+                continue
+            else:
+                results.append(elm)
+        return results
+        
+    def check_consistency(self):
+        for name, certs in self.data.items():
+            new_der = 0
+            new_pem = 0
+            old_certs = {
+                # '<release>' : {
+                #     'PEM' : '<nr>'
+                #     'DER' : '<nr>'
+                # }
+            }
+            for cert in certs:
+                # Only 1 PEM and 1 DER for new certificates
+                if cert['generation'] == 'new' and cert['key_format'] == 'DER':
+                    new_der += 1
+                if cert['generation'] == 'new' and cert['key_format'] == 'PEM':
+                    new_pem +=1
+                # Only 1 PEM and 1 DER per release for old certificates
+                if cert['generation'] == 'old':
+                    release = cert['release']
+                    key_format = cert['key_format']
+                    if release not in old_certs.keys():
+                        old_certs[release] = {}
+                    if key_format not in old_certs[release]:
+                        old_certs[release][key_format] = 1
+                    else:
+                        old_certs[release][key_format] += 1
+
+            assert(new_der == 1)
+            assert(new_pem == 1)
+
+            for release, release_data in old_certs.items():
+                assert(release_data['DER'] == 1)
+                assert(release_data['PEM'] == 1)                
diff --git a/images/gen_key_migration_script/gen_key_migration_script.py b/images/gen_key_migration_script/gen_key_migration_script.py
new file mode 100755
index 0000000..4f8b31e
--- /dev/null
+++ b/images/gen_key_migration_script/gen_key_migration_script.py
@@ -0,0 +1,176 @@
+#!/usr/bin/env python3
+# Copyright (C) 2020 Denis 'GNUtoo' Carikli <GNUtoo at cyberdimension.org>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+import glob
+import os
+import re
+import sh
+import sys
+
+import jinja2
+
+import generate_shell_commands
+import certs_data
+
+def usage(progname):
+    print ('Usage:')
+    print ('\t{} gen-script <key-migration.sh>'
+           ' <OLD>'
+           ' <NEW>'.format(progname))
+    print ('Possible arguments for OLD or NEW:')
+    print ('\t- the path to vendor/replicant-security')
+    print ('\t  or other directory with keys and certificates')
+    print ('\t- the path to'
+           ' vendor/replicant-data/distros/releases/certificates/')
+    print ('\t  or other directory that has directories with'
+           ' keys and certificates')
+    print ('''Example of use:
+	{} gen-script \\
+	\tvendor/replicant/prebuilt/common/bin/key-migration.sh \\
+	\tvendor/replicant-data/distros/releases/certificates/ \\
+	\tvendor/replicant-security/'''.format(progname))
+    print ('''What is this script for:
+	During the Replicant build, keys and certificates are generated by
+	vendor/replicant/sign-build.sh. These are used to sign system
+	applications. If the application signatures changes, the applications
+	loses access to their data. On Replicant 6 this results in the launcher
+	always crashing, making the device unusable.
+	To fix that we can replace the old set of keys and certificates with the
+	new ones in /data/system/packages.xml. This python script generates a
+	key-migration.sh shell script that does that. the
+	generated key-migration.sh can then be used in several ways:
+	- It can be copied in
+	  vendor/replicant/prebuilt/common/bin/key-migration.sh
+	  to be run at the first boot of the newly compiled Replicant image.
+	- Once the device is in the recovery, It can also be manually copied
+	  and run there.''')
+    sys.exit(1)
+
+def generate_key_migration_sh_file(data, path):
+    templates_dir = str(os.path.dirname(os.path.realpath(__file__)))
+    templates_dir += os.sep
+    templates_dir += 'templates'
+
+    env = jinja2.Environment(
+        loader=jinja2.FileSystemLoader(templates_dir),
+        trim_blocks=True,
+        lstrip_blocks=True,
+    )
+
+    template = env.get_template('key-migration.sh')
+    output = template.render(
+        certs_data=data,
+        generate_shell_commands=generate_shell_commands.generate_shell_commands)
+
+    key_migration_sh_file = open(path, 'w')
+    key_migration_sh_file.write(output)
+    key_migration_sh_file.close()
+
+def get_cert_pkey(cert, key_format):
+    openssl = sh.Command('openssl')
+
+    if key_format == 'PEM':
+        output = openssl('x509',
+                         '-in', cert,
+                         '-inform', 'PEM',
+                         '-outform', key_format,
+                         '-pubkey')
+        output = output.split(os.linesep)
+        in_pkey = False
+        pkey = ''
+        for line in output:
+            if re.search('^-----BEGIN PUBLIC KEY-----$', line):
+                in_pkey = True
+                continue
+            elif re.search('^-----END PUBLIC KEY-----$', line):
+                in_pkey = False
+                break
+            if in_pkey:
+                pkey += line
+    elif key_format == 'DER':
+        output = openssl('x509',
+                         '-in', cert,
+                         '-inform', 'PEM',
+                         '-outform', key_format)
+        output_bytes = output.stdout
+        pkey = output_bytes.hex()
+    else:
+        assert(False)
+
+    return pkey
+
+def parse_certificate(data, path, generation, release):
+    cert_name = os.path.basename(path)
+    data.add_key(cert_name, generation, release,
+                 'PEM', get_cert_pkey(path, 'PEM'))
+
+    data.add_key(cert_name, generation, release,
+                 'DER', get_cert_pkey(path, 'DER'))
+
+def parse_certificates_dirs(data, dir_path, generation):
+    # If we find certificate in the given directory, we then use
+    # all of them
+    certificates = glob.glob(dir_path + os.sep + '*.x509.pem')
+    if len(certificates) > 0:
+        for cert_path in certificates:
+            parse_certificate(data, cert_path, generation, None)
+    else:
+        # If not we assume that each subdirectory that contain certificates
+        # represents a Replicant version and that it holds its certificates.
+        # For instance in the Replicant source tree, the
+        # vendor/replicant-data/distros/releases/certificates/ directory has
+        # subdirectories with the name of a Replicant release, and inside,
+        # all the cerficicates of that release.
+        certificates = glob.glob(dir_path + os.sep + '*' + os.sep
+                                 + '*.x509.pem')
+        if len(certificates) > 0:
+            for cert_path in certificates:
+                release_name = os.path.basename(os.path.dirname(cert_path))
+                parse_certificate(data, cert_path, generation, release_name)
+        else:
+            print('Error: Unusable {} directory:'.format(dir_path))
+            print('No certificates found.')
+            print('Files with the .x509.pem extension were expected either'
+                  ' in this directory or in any of its subdirectories.')
+            sys.exit(1)
+
+def gen_key_migration_script(data):
+    key_migration_sh_path = os.path.realpath(sys.argv[2])
+    old_path = os.path.realpath(sys.argv[3])
+    new_path = os.path.realpath(sys.argv[4])
+    parse_certificates_dirs(data, old_path, 'old')
+    parse_certificates_dirs(data, new_path, 'new')
+    data.check_consistency()
+
+    generate_key_migration_sh_file(data, key_migration_sh_path)
+
+if __name__ == '__main__':
+    # The packages.xml file has the certificate keys encoded twice:
+    # - Once in PEM format in the value= in:
+    #   <keyset-settings version="1">
+    #       <keys>
+    #           <public-key identifier="1" value="..." />
+    # - Once in DER format in key= in:
+    #   <package name="..." [...]>
+    #       <sigs [...]>
+    #           <cert [...] key="..." />
+
+    data = certs_data.ReplicantCertsData()
+
+    if len(sys.argv) == 5 and sys.argv[1] == 'gen-script':
+        gen_key_migration_script(data)
+    else:
+        usage(sys.argv[0])
diff --git a/images/gen_key_migration_script/generate_shell_commands.py b/images/gen_key_migration_script/generate_shell_commands.py
new file mode 100644
index 0000000..95d6fe0
--- /dev/null
+++ b/images/gen_key_migration_script/generate_shell_commands.py
@@ -0,0 +1,101 @@
+#!/usr/bin/env python3
+# Copyright (C) 2020 Denis 'GNUtoo' Carikli <GNUtoo at cyberdimension.org>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+import os
+import re
+
+def shell_variable_escape(name):
+    name = name.replace('.', '_')
+    name = name.replace('-', '_')
+    return name
+
+def get_release_string(release):
+    if release:
+        return '_{}'.format(shell_variable_escape(release))
+    else:
+        return ''
+
+def assign_keys_to_variables(cert_name, certs_data_array, generation,
+                             key_format):
+    output_string = ''
+
+    for cert_data in certs_data_array:
+        if cert_data['generation'] != generation:
+            continue
+        if cert_data['key_format'] == key_format:
+            continue
+
+        variable_name = '{}{}_{}_{}_cert_key'.format(
+            cert_data['generation'],
+            get_release_string(cert_data['release']),
+            shell_variable_escape(cert_name),
+            cert_data['key_format'])
+
+        output_string += '{}=\'{}\'{}{}'.format(variable_name,
+                                            cert_data['key'],
+                                            os.linesep,
+                                            os.linesep)
+    return output_string
+
+def generate_sed_commands(cert_name, certs_data_array, key_format):
+    output_string = ''
+
+    for cert_data in certs_data_array:
+        if cert_data['key_format'] == key_format:
+            continue
+        if cert_data['generation'] != 'new':
+            continue
+
+        new_variable = '${'
+        new_variable += 'new{}_{}_{}_cert_key'.format(
+            get_release_string(cert_data['release']),
+            shell_variable_escape(cert_name),
+            cert_data['key_format'])
+        new_variable += '}'
+
+    for cert_data in certs_data_array:
+        if cert_data['key_format'] == key_format:
+            continue
+        if cert_data['generation'] != 'old':
+            continue
+        old_variable = '${'
+        old_variable += 'old{}_{}_{}_cert_key'.format(
+            get_release_string(cert_data['release']),
+            shell_variable_escape(cert_name),
+            cert_data['key_format'])
+        old_variable += '}'
+
+        output_string += 'sed \\{}'.format(os.linesep)
+        # The slash(/) is part of the list of symbols used by the
+        # base64 encoding, while the hash (#) is not.
+        output_string += '\t"s#{}#{}#g" \\{}'.format(old_variable,
+                                                       new_variable,
+                                                       os.linesep)
+        output_string += '\t-i ${PACKAGES}' + os.linesep + os.linesep
+    return output_string
+
+def generate_shell_commands(data):
+    output_string = ''
+    for key_type in ['PEM', 'DER']:
+        for cert_name, certs_data_array in sorted(data.data.items()):
+            output_string += assign_keys_to_variables(cert_name,
+                                                      certs_data_array,
+                                                      'old', key_type)
+            output_string += assign_keys_to_variables(cert_name,
+                                                      certs_data_array,
+                                                      'new', key_type)
+            output_string += generate_sed_commands(cert_name,
+                                                   certs_data_array, key_type)
+    return re.sub('{}$'.format(os.linesep), '', output_string)
diff --git a/images/gen_key_migration_script/templates/key-migration.sh b/images/gen_key_migration_script/templates/key-migration.sh
new file mode 100644
index 0000000..879022a
--- /dev/null
+++ b/images/gen_key_migration_script/templates/key-migration.sh
@@ -0,0 +1,43 @@
+#!/system/bin/sh
+# Copyright (C) 2017 Gabriele M <moto.falcon.git at gmail.com>
+# Copyright (C) 2020 Denis 'GNUtoo' Carikli <GNUtoo at cyberdimension.org>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+PACKAGES=/data/system/packages.xml
+PACKAGES_BACKUP=/data/system/packages-backup.xml
+MIGRATION_DONE=/data/system/.key-migration-done
+
+if [ -f ${MIGRATION_DONE} ]; then
+	exit 0
+fi
+
+if [ ! -f ${PACKAGES_BACKUP} ] && [ ! -f ${PACKAGES} ]; then
+	touch ${MIGRATION_DONE}
+	exit 0
+fi
+
+if [ -f ${PACKAGES_BACKUP} ]; then
+	mv ${PACKAGES_BACKUP} ${PACKAGES}
+fi
+
+#####################
+# Certificates keys #
+#####################
+
+{{ generate_shell_commands(certs_data) }}
+
+chmod 660 ${PACKAGES}
+chown system:system ${PACKAGES}
+
+touch ${MIGRATION_DONE}
-- 
2.28.0



More information about the Replicant mailing list