security/hakurei.app
security/hakurei.app
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 4 Wiki Activity

Add highlighting style for placeholders

Browse Source 
This is in accordance with Google's developer documentation style guide.
This commit is contained in:
smdyv 2022-08-25 15:05:41 +02:00 committed by Daniel Micay
parent f8f393e138
commit 37253ffa17
4 changed files with 41 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
static/build.html
View File

@ -354,9 +354,9 @@ repo sync -j16</pre>
tag for a device. For devices without official support, use the latest tag marked as
being appropriate for generic / other devices in the release notes.</p>
<pre>mkdir grapheneos-TAG_NAME
cd grapheneos-TAG_NAME
repo init -u https://github.com/GrapheneOS/platform_manifest.git -b refs/tags/TAG_NAME</pre>
<pre>mkdir grapheneos-<var>TAG_NAME</var>
cd grapheneos-<var>TAG_NAME</var>
repo init -u https://github.com/GrapheneOS/platform_manifest.git -b refs/tags/<var>TAG_NAME</var></pre>
<p>Verify the manifest:</p>
@ -489,13 +489,13 @@ source script/envsetup.sh
m aapt2</pre>
<p>Extract the vendor files corresponding to the matching release with
<code>DEVICE</code> and <code>BUILD_ID</code> replaced with the
<code><var>DEVICE</var></code> and <code><var>BUILD_ID</var></code> replaced with the
appropriate values:</p>
<pre>vendor/adevtool/bin/run download vendor/adevtool/dl/ -d DEVICE -b BUILD_ID -t factory ota
sudo vendor/adevtool/bin/run generate-all vendor/adevtool/config/DEVICE.yml -c vendor/state/DEVICE.json -s vendor/adevtool/dl/DEVICE-BUILD_ID-*.zip
<pre>vendor/adevtool/bin/run download vendor/adevtool/dl/ -d <var>DEVICE</var> -b <var>BUILD_ID</var> -t factory ota
sudo vendor/adevtool/bin/run generate-all vendor/adevtool/config/<var>DEVICE</var>.yml -c vendor/state/<var>DEVICE</var>.json -s vendor/adevtool/dl/<var>DEVICE</var>-<var>BUILD_ID</var>-*.zip
sudo chown -R $(logname):$(logname) vendor/google_devices
vendor/adevtool/bin/run ota-firmware vendor/adevtool/config/DEVICE.yml -f vendor/adevtool/dl/DEVICE-ota-BUILD_ID-*.zip</pre>
vendor/adevtool/bin/run ota-firmware vendor/adevtool/config/<var>DEVICE</var>.yml -f vendor/adevtool/dl/<var>DEVICE</var>-ota-<var>BUILD_ID</var>-*.zip</pre>
</section>
<section id="setting-up-the-os-build-environment">
@ -716,7 +716,7 @@ cd ../..</pre>
<pre>script/release.sh raven</pre>
<p>The factory images and update package will be in
<code>out/release-raven-$BUILD_NUMBER</code>. The update zip performs a full OS
<code>out/release-raven-<var>BUILD_NUMBER</var></code>. The update zip performs a full OS
installation so it can be used to update from any previous version. More efficient
incremental updates are used for official over-the-air GrapheneOS updates and can be
generated by keeping around past signed <code>target_files</code> zips and generating
@ -732,9 +732,9 @@ cd ../..</pre>
it (see the information on <code>OFFICIAL_BUILD</code> above), you can push signed
over-the-air updates via the update system. Simply upload the update package to the
update server along with the channel metadata for the release channel, and it will be
pushed out to the update client. The <code>$DEVICE-beta</code> and
<code>$DEVICE-stable</code> metadata provide the Beta and Stable release channels used
by the update client. The <code>$DEVICE-testing</code> metadata provides
pushed out to the update client. The <code><var>DEVICE</var>-beta</code> and
<code><var>DEVICE</var>-stable</code> metadata provide the Beta and Stable release channels used
by the update client. The <code><var>DEVICE</var>-testing</code> metadata provides
an internal testing channel for the OS developers, which can be temporarily
enabled using <code>adb shell setprop sys.update.channel testing</code>. The name is
arbitrary and you can also use any other name for internal testing channels.</p>
@ -804,7 +804,7 @@ cd ../..</pre>
<pre>git clone https://github.com/GrapheneOS/Vanadium.git
cd Vanadium
git checkout $CORRECT_BRANCH_OR_TAG</pre>
git checkout <var>CORRECT_BRANCH_OR_TAG</var></pre>
<p>Generate a signing key for Vanadium if this is the initial build:</p>
@ -818,12 +818,12 @@ git checkout $CORRECT_BRANCH_OR_TAG</pre>
<pre>fetch --nohooks android</pre>
<p>Sync to the latest stable release for Android (replace <code>$VERSION</code> with
<p>Sync to the latest stable release for Android (replace <code><var>VERSION</var></code> with
the correct value):</p>
<pre>cd src
git fetch --tags
git checkout $VERSION</pre>
git checkout <var>VERSION</var></pre>
<p>Apply the GrapheneOS patches on top of the tagged release:</p>
@ -889,12 +889,12 @@ git checkout $VERSION</pre>
<code>packages/apps/Updater/res/values/config.xml</code>. See above for details on
including the Updater app in a release. These are the relevant files:</p>
<pre>$DEVICE-ota_update-$BUILD_NUMBER.zip
$DEVICE-factory-BUILD_NUMBER.zip
$DEVICE-factory-BUILD_NUMBER.zip.sig
$DEVICE-testing
$DEVICE-beta
$DEVICE-stable</pre>
<pre><var>DEVICE</var>-ota_update-<var>BUILD_NUMBER</var>.zip
<var>DEVICE</var>-factory-<var>BUILD_NUMBER</var>.zip
<var>DEVICE</var>-factory-<var>BUILD_NUMBER</var>.zip.sig
<var>DEVICE</var>-testing
<var>DEVICE</var>-beta
<var>DEVICE</var>-stable</pre>
<p>Generally, you should start by uploading the ota_update, factory images and testing
channel metadata.</p>
@ -904,9 +904,9 @@ $DEVICE-stable</pre>
arbitrary names. You can override the release channel configured in the update client
via ADB with the following command:</p>
<pre>adb shell setprop sys.update.channel channel_name</pre>
<pre>adb shell setprop sys.update.channel <var>CHANNEL_NAME</var></pre>
<p>Replace <code>channel_name</code> with the name of the release channel, such as
<p>Replace <code><var>CHANNEL_NAME</var></code> with the name of the release channel, such as
<code>testing</code>.</p>
<p>After pushing out and testing the new release via the internal release channel,
@ -1136,9 +1136,9 @@ rm android-cts-media-1.5.zip</pre>
<p>To obtain a list of CTS modules:</p>
<pre>list modules</pre>
<p>To run a specific module and avoid wasting time capturing device information:</p>
<pre>run cts --skip-device-info --module CtsModuleName</pre>
<pre>run cts --skip-device-info --module <var>CTS_MODULE_NAME</var></pre>
<p>To speed up initialization after running some initial tests:</p>
<pre>run cts --skip-device-info --skip-preconditions --module CtsModuleName</pre>
<pre>run cts --skip-device-info --skip-preconditions --module <var>CTS_MODULE_NAME</var></pre>
<p>It's possible to run the whole standard CTS plan with a single command, but running
specific modules is recommended, especially if you don't have everything set up for
the entire test suite.</p>
@ -1165,7 +1165,7 @@ rm android-cts-media-1.5.zip</pre>
the build number, which is generally incorporated into the build. For example, even
without a platform-tools tag, you can obtain the build number from <code>adb
version</code> or <code>fastboot version</code>. Their version output uses the format
<code>$VERSION-$BUILD_NUMBER</code> such as <code>30.0.3-6597393</code> for the
<code><var>VERSION</var>-<var>BUILD_NUMBER</var></code> such as <code>30.0.3-6597393</code> for the
version <code>30.0.3</code> where the official release had the build number
<code>6597393</code>. You can obtain the manifest properties with the appropriate
repository revisions from ci.android.com with a URL like this:

10
static/faq.html
View File

@ -643,7 +643,7 @@
enabled, and it has the option to automatically restore app data when an app is
reinstalled, so it wouldn't lose track of it being the same profile.</p>
<p>The <code>ANDROID_ID</code> string is a 64-bit random number, unique to each
<p>The <var>ANDROID_ID</var> string is a 64-bit random number, unique to each
combination of profile and app signing key. The 64-bit limitation means it isn't
particularly useful due to the possibility of collisions. It's tied to the lifetime of
profiles and does not persist through profile deletion or a factory reset. This is
@ -655,13 +655,13 @@
<p>The advertising ID is a Google Play services feature not included in the baseline
Android API, so it isn't an API included in GrapheneOS. The advertising ID is unique
to each profile. It isn't unique to each app signing key like <code>ANDROID_ID</code>,
to each profile. It isn't unique to each app signing key like <var>ANDROID_ID</var>,
but that makes little difference since apps within the same profile can communicate
with each other with mutual consent. It's comparable to <code>ANDROID_ID</code> but
with each other with mutual consent. It's comparable to <var>ANDROID_ID</var> but
provides an 128-bit value so it provides a strong cryptographic guarantee against
collisions, although a device messing with apps could set it to the same value used in
another profile. The advertising ID is exposed via the Settings app and can be reset
to a new random value, unlike <code>ANDROID_ID</code> which remains the same for the
to a new random value, unlike <var>ANDROID_ID</var> which remains the same for the
lifetime of the profile, but apps can tie it to the previous ID since they can detect
that it changed via their own ID in their app data. The advertising ID can
also now be disabled (zeroed).</p>
@ -673,7 +673,7 @@
track of the profile. Apps previously had little reason to do things like this because
they were able to persist data through an uninstall and reinstallation by default. The
modern storage model means they need to request access to user data to do this. The
existence of <code>ANDROID_ID</code> means they don't yet need to bother with that but
existence of <var>ANDROID_ID</var> means they don't yet need to bother with that but
that will change on GrapheneOS and will likely change for baseline Android too.
However, profiles are the only way to provide a strong assurance of separate
identities since the application model of the OS is designed to support communication

14
static/install/cli.html
View File

@ -410,16 +410,16 @@ RWQZW9NItOuQYJ86EooQBxScfclrWiieJtAO9GpnfEjKbCO/3FriLGX3</pre>
<p>Download the factory images for the device from <a href="/releases">the releases
page</a>. For example, to download the 2021110122 release for a device with the
codename <code>DEVICE_NAME</code>:</p>
codename <code><var>DEVICE_NAME</var></code>:</p>
<pre>curl -O https://releases.grapheneos.org/DEVICE_NAME-factory-2021110122.zip
curl -O https://releases.grapheneos.org/DEVICE_NAME-factory-2021110122.zip.sig</pre>
<pre>curl -O https://releases.grapheneos.org/<var>DEVICE_NAME</var>-factory-2021110122.zip
curl -O https://releases.grapheneos.org/<var>DEVICE_NAME</var>-factory-2021110122.zip.sig</pre>
<p>Verify the factory images using the signature if you were able to obtain
<code>signify</code> from trusted package repositories (see above), otherwise
continue on to the next section without this:</p>
<pre>signify -Cqp factory.pub -x DEVICE_NAME-factory-2021110122.zip.sig &amp;&amp; echo verified</pre>
<pre>signify -Cqp factory.pub -x <var>DEVICE_NAME</var>-factory-2021110122.zip.sig &amp;&amp; echo verified</pre>
<p>This will output <code>verified</code> if verification is successful. If something
goes wrong, it will output an error message rather than <code>verified</code>.</p>
@ -435,15 +435,15 @@ curl -O https://releases.grapheneos.org/DEVICE_NAME-factory-2021110122.zip.sig</
<p>On Linux:</p>
<pre>bsdtar xvf DEVICE_NAME-factory-2021110122.zip</pre>
<pre>bsdtar xvf <var>DEVICE_NAME</var>-factory-2021110122.zip</pre>
<p>On macOS and Windows:</p>
<pre>tar xvf DEVICE_NAME-factory-2021110122.zip</pre>
<pre>tar xvf <var>DEVICE_NAME</var>-factory-2021110122.zip</pre>
<p>Move into the directory:</p>
<pre>cd DEVICE_NAME-factory-2021110122</pre>
<pre>cd <var>DEVICE_NAME</var>-factory-2021110122</pre>
<p>Flash the images with the flash-all script in the directory.</p>

4
static/main.css
View File

@ -52,6 +52,10 @@ code {
border-radius: 2.5px;
}
var {
color: #ba1a1a;
}
#site-menu ul {
display: flex;
flex-wrap: nowrap;