docs: STK menu

content/stk/_index.md

@@ -0,0 +1,6 @@
++++
+title = "STK Menu"
+weight = 4
+[_build]
+  render = "never"
++++

content/stk/about.md

@@ -0,0 +1,18 @@
++++
+title = "About"
+weight = 5
++++
+
+{{% notice style="note" title="Notice"%}}
+It may **not be possible** to display all information during some operations.
+{{% /notice %}}
+
+## Information about your eSTK.me
+
+This page displays these information about your eSTK.me:
+
+- **EID**: The serial number of the eSE.
+- **Free NVRAM**: Remaining space in eSE occupied by profile or notification.
+- **SAS Number**: The SAS-UP number of the eSE.
+- **Serial**: The serial number of the eSTK.me.
+- **Firmware**: Firmware version on the eSTK.me.

content/stk/download.md

@@ -0,0 +1,20 @@
++++
+title = "Download"
+weight = 2
++++
+
+{{% notice style="note" title="Disclaimer" %}}
+This feature connects to the internet to operate.  
+**Use of this feature acknowledges your responsibility for internet access costs and understanding of potential interruptions in service.**  
+For more information, visit [Cloud Enhance](/stk/settings/cloud-enhance/#disclaimer)
+{{% /notice %}}
+
+{{% notice style="info" title="Config Cloud Enhance First" %}}
+You need to config and enable [Cloud Enhance](/stk/settings/cloud-enhance) first to use.  
+When Cloud Enhance task is running, status information is displayed on this page.
+{{% /notice %}}
+
+## Download profiles to eSTK.me via Cloud Enhance
+
+Enter your [AC](/manual/activation-code) in the pop-up input box, eSTK.me will use Cloud Enhance to download your profile, a pop-up will inform the user of the result.  
+After the process, the server will be disconnected immediately.  

content/stk/profiles/_index.md

@@ -0,0 +1,19 @@
++++
+title = "Profiles"
+weight = 1
++++
+
+## Manage profiles stored in eSE via STK
+
+> The STK menu consists of **5 profiles per page** and a 'Next Page' button (if there are more profiles not shown).  
+> Profiles have prefixes represented by "\< \>" or "\<\*\>", where "\<\*\>" indicates the current selection.  
+
+The name of a profile is determined by both **"nickname"** and **"provider"**.  
+The **"nickname"** will be displayed **first**. If the "nickname" does not exist, the **"provider"** information will be displayed.
+
+When a profile is selected, its detail menu is displayed with these operation options:
+
+- [Enable Profile](/stk/profiles/enable)
+- [Disable Profile](/stk/profiles/disable)
+- [Set Nickname](/stk/profiles/nickname)
+- [Delete Profile](/stk/profiles/delete)

content/stk/profiles/delete.md

@@ -0,0 +1,14 @@
++++
+title = "Delete Profile"
+weight = 4
++++
+
+{{% notice style="warning" %}}
+This operation **cannot be restored**, **You need to be very clear about what you are doing**.  
+This operation does **not** process notifications to SM-DP+, if necessary, visit [Process Notification](/stk/tools/process-notification).
+{{% /notice %}}
+
+## Delete Profiles stored in eSE
+
+This operation requires a secondary confirmation to delete the profile stored in eSE.
+After the confirmation, eSTK.me will [reboot](/stk/tools/reboot) and a pop-up will inform the user of the result.

content/stk/profiles/disable.md

@@ -0,0 +1,12 @@
++++
+title = "Disable Profile"
+weight = 2
++++
+
+{{% notice style="info" %}}
+If no profile is active, a dummy profile is active for device recognition.
+{{% /notice %}}
+
+## Deactivate current profile
+
+Deactivate current profile, eSTK.me will [reboot](/stk/tools/reboot) and a pop-up will inform the user of the result.

content/stk/profiles/enable.md

@@ -0,0 +1,8 @@
++++
+title = "Enable Profile"
+weight = 1
++++
+
+## Activate a new profile
+
+Activate a new profile, eSTK.me will [reboot](/stk/tools/reboot) and a pop-up will inform the user of the result.

content/stk/profiles/nickname.md

@@ -0,0 +1,16 @@
++++
+title = "Set Nickname"
+weight = 3
++++
+
+{{% notice style="info" title="Limitation"%}}
+The input length of nickname in the STK menu is limited to **16** characters.
+{{% /notice %}}
+
+## Set Nickname for profiles
+
+{{% notice style="tip" %}}
+If no characters are entered, the nickname will be deleted.
+{{% /notice %}}
+
+Input new Nickname in the pop-up input box, eSTK.me will [reboot](/stk/tools/reboot) and a pop-up will inform the user of the result.  

content/stk/settings/_index.md

@@ -0,0 +1,6 @@
++++
+title = "Settings"
+weight = 4
+[_build]
+  render = "never"
++++

content/stk/settings/ara-m.md

@@ -0,0 +1,20 @@
++++
+linkTitle = "ARA-M SHA-1"
+title = "Config ARA-M Slot"
+weight = 1
++++
+
+{{% notice style="note" title="Notice" %}}
+An incorrect ARA-M will cause the LPA application unable to manage the eUICC. You need to ensure that you can access the STK or have a PC/SC reader.
+{{% /notice %}}
+
+ARA-M, as a special application of smartcards, is used to control which applications can access the smartcard. It is widely used on Android devices that support OMAPI.  
+UICC uses the SHA-1 or SHA-256 values of the application certificate signatures in ARA-M to inform the operating system which applications can access the card.
+
+## Grant access to APP using ARA-M
+
+{{% notice style="tip" %}}
+If no characters are entered, the value of the ARA-M in the slot is set to zero.
+{{% /notice %}}
+
+There are 5 ARA-M slots in eSTK.me, select any slot to enter edit mode, enter the SHA-1 of the APP you want to store in the slot.

content/stk/settings/atr.md

@@ -0,0 +1,26 @@
++++
+linkTitle = "ATR Mode"
+title = "Set ATR Mode"
+weight = 5
++++
+
+{{% notice style="warning" title="Warning"%}}
+If "[ATR Mode](/stk/settings/atr)" is set to **"eUICC"** and "[ISD-R Mode](/stk/settings/isd-r)" is in **Disable**, some devices may indicate that eSTK.me is corrupted.
+{{% /notice %}}
+
+{{% notice style="info" title="Limitation"%}}
+Although eSTK.me has the ability to fully customise the ATR, an **incorrect** ATR response can **easily damage equipment**.  
+Therefore, users are **only** allowed to select from pre-set ATR data that has undergone safety testing.  
+For OEMs, eSTK.me can provide more extensive ATR customisation and assist in testing the reliability of the ATR.  
+{{% /notice %}}
+
+## Configure ATR Response for eSTK.me
+
+The ATR is the first block of data sent from the UICC to the device and contains important information such as communication methods, data structures and more.
+
+> Options have prefixes represented by "\< \>" or "\<\*\>", where "\<\*\>" indicates the current selection.  
+
+Options available for ATR mode:
+
+- **Generic**: Announcement as a generic UICC card.
+- **eUICC**: Announcement as a UICC with **eUICC related function**.

content/stk/settings/cloud-enhance.md

@@ -0,0 +1,46 @@
++++
+linkTitle = "Cloud Enhance"
+title = "Config Cloud Enhance"
+weight = 2
++++
+
+{{% notice style="note" title="Data usage warning" %}}
+Cloud Enhance requires profile to be used to access the internet via **cellular data** to connect to the Remote LPA server.  
+Typically Wi-Fi **cannot** be used as a substitute.
+
+A network connection is **only established** when a Cloud Enhance process is actively in use. Once the process is finished, the connection is **immediately disconnected**.
+{{% /notice %}}
+
+{{% notice style="info" title="About Remote LPA Server" %}}
+Cloud Enhance relies on Remote LPA server located **on the Internet**. Users can specify the server address and whether to enable this function.  
+The Remote LPA server **source code** is freely available under the terms of the **AGPLv3 licence**, you can find the source code [here](https://github.com/estkme-group/rlpa-server).  
+You can build your own Remote LPA server as you wish.
+{{% /notice %}}
+
+## Config Cloud Enhance
+
+This menu contains the following items:
+
+1. Current Remote LPA server address, edit by clicking on it.
+2. Options for Cloud Enhance.
+
+> Options have prefixes represented by "\< \>" or "\<\*\>", where "\<\*\>" indicates the current selection.  
+
+Options available for Cloud Enhance mode:
+
+- **Enabled**: Enable Cloud Enhance.
+- **Disabled**: Disable Cloud Enhance.
+
+## Disclaimer
+
+{{% notice style="warning" title="About Network Security" %}}
+When using Cloud Enhance, eSTK.me will **transmit data over the Internet** and **communicate with external Remote LPA server**.  
+During use, you will be exposed to the following risks:
+
+1. **Privacy leakage**
+2. **Risk from malicious servers**
+3. **Risk from human error**
+
+Cloud Enhance **cannot avoid monitoring and interception** by your carrier.  
+**Use of this feature acknowledges your responsibility for internet access costs and understanding of potential interruptions in service.**
+{{% /notice %}}

content/stk/settings/ecasd.md

@@ -0,0 +1,17 @@
++++
+linkTitle = "ECASD Mode"
+title = "Set ECASD Mode"
+weight = 7
++++
+
+## Configure ECASD domain accessibility
+
+ECASD is a special domain. Unlike ISD-R, ECASD holds the most critical certificates and key data of the eUICC.  
+Typically, access to the ECASD domain is only required by the manufacturer of the eSE.  
+
+> Options have prefixes represented by "\< \>" or "\<\*\>", where "\<\*\>" indicates the current selection.  
+
+Options available for ECASD mode:
+
+- **Enabled**: The ECASD domain can be accessed normally.
+- **Disabled**: **Forbid any access** to ECASD domain.

content/stk/settings/isd-r.md

@@ -0,0 +1,23 @@
++++
+linkTitle = "ISD-R Mode"
+title = "Set ISD-R Mode"
+weight = 6
++++
+
+{{% notice style="warning" title="Warning"%}}
+An **unexpected ISD-R mode** will result in the LPA being **unable to manage the eUICC**. You **must** ensure that you have access to the STK or a PC/SC smartcard reader.
+
+If "[ATR Mode](/stk/settings/atr)" is set to **"eUICC"** and "[ISD-R Mode](/stk/settings/isd-r)" is in **Disable**, some devices may indicate that eSTK.me is corrupted.
+{{% /notice %}}
+
+## Configure ISD-R domain accessibility
+
+ISD-R is used by the LPA to interact with the eUICC. The management of profiles and the retrieval of eUICC information all use this domain as an entry point.
+
+> Options have prefixes represented by "\< \>" or "\<\*\>", where "\<\*\>" indicates the current selection.  
+
+Options available for ISD-R mode:
+
+- **Shared**: The ISD-R domain can be shared, meaning that all requests to access the ISD-R are allowed.
+- **Exclusive**: Access to ISD-R domain is **exclusive**. You must wait for the current operation before you can access it.
+- **Disabled**: **Forbid any access** to ISD-R domain.

content/stk/settings/motd.md

@@ -0,0 +1,22 @@
++++
+linkTitle = "MOTD"
+title = "Set MOTD Mode"
+weight = 4
++++
+
+## Toggle MOTD message
+
+Config the welcome message for eSTK.me, which is the information that pops up after eSTK.me starts normally.  
+This message can be used to notify users that eSTK.me has been detected or to monitor for unexpected reboots.
+
+This menu contains the following items:
+
+1. Current MOTD message, edit by clicking on it.
+2. Options for MOTD mode.
+
+> Options have prefixes represented by "\< \>" or "\<\*\>", where "\<\*\>" indicates the current selection.  
+
+Options available for MOTD mode:
+
+- **Enabled**: Enable MOTD.
+- **Disabled**: Disable MOTD.

content/stk/settings/proactive-refresh.md

@@ -0,0 +1,13 @@
++++
+title = "Proactive Refresh"
+weight = 8
++++
+
+## Toggle Proactive Refresh
+
+> Options have prefixes represented by "\< \>" or "\<\*\>", where "\<\*\>" indicates the current selection.  
+
+Options available for Proactive Refresh:
+
+- **Enabled**: Enable Proactive Refresh.
+- **Disabled**: Disable Proactive Refresh.

content/stk/settings/virtual-eid.md

@@ -0,0 +1,28 @@
++++
+linkTitle = "Virtual EID"
+title = "Set Virtual EID"
+weight = 3
++++
+
+{{% notice style="note" title="Notice"%}}
+**Special EIDs may make some LPAs abnormal**  
+When communicating with the SM-DP+ server, the virtual EID **cannot take effect** due to the GSMA PKI certificate, and the server will always receive the **real EID number**.
+{{% /notice %}}
+
+## Mock the value of EID in ISD-R
+
+Virtual EID can mock the EID value read by the LPA to the value set by the user.
+
+If Virtual EID is enabled, the EID value **read from the ISD-R** is mocked.
+
+This menu contains the following items:
+
+1. Current Virtual EID value, edit by clicking on it.
+2. Options for Virtual EID.
+
+> Options have prefixes represented by "\< \>" or "\<\*\>", where "\<\*\>" indicates the current selection.  
+
+Options available for Virtual EID mode:
+
+- **Enabled**: Enable Virtual EID.
+- **Disabled**: Disable Virtual EID.

content/stk/tools/_index.md

@@ -0,0 +1,6 @@
++++
+title = "Tools"
+weight = 3
+[_build]
+  render = "never"
++++

content/stk/tools/bypass-stk.md

@@ -0,0 +1,15 @@
++++
+title = "Bypass STK Menu"
+weight = 1
++++
+
+{{% notice style="note" title="Notice" %}}
+Once this operation is completed, you **must power cycling** eSTK.me to return to the eSTK.me menu.  
+Apple devices need to re-enter the STK menu to apply the new menu.
+{{% /notice %}}
+
+## Pass through to the profile's STK menu
+
+Some Profiles provide their own STK menu, and these STK menus can be accessed using this tool.  
+
+This operation requires a secondary confirmation to bypass STK menu; if there is no STK in the profile, a pop-up will inform the user.

content/stk/tools/factory-reset.md

@@ -0,0 +1,13 @@
++++
+title = "Factory Reset"
+weight = 7
++++
+
+{{% notice style="note" title="Notice"%}}
+This operation does **not** affect data storage in eSE.  
+**All** configurable settings in the STK menu are reset and **cannot be restored**.
+{{% /notice %}}
+
+## Perform a Factory Reset to eSTK.me COS
+
+This operation requires a secondary confirmation.

content/stk/tools/process-notification.md

@@ -0,0 +1,30 @@
++++
+title = "Process Notification"
+weight = 2
++++
+
+{{% notice style="note" title="Disclaimer" %}}
+This feature connects to the internet to operate.  
+**Use of this feature acknowledges your responsibility for internet access costs and understanding of potential interruptions in service.**  
+For more information, visit [Cloud Enhance](/stk/settings/cloud-enhance/#disclaimer)
+{{% /notice %}}
+
+{{% notice style="info" title="Config Cloud Enhance First" %}}
+You need to config and enable [Cloud Enhance](/stk/settings/cloud-enhance) first to use.  
+When Cloud Enhance task is running, status information is displayed on this page.
+{{% /notice %}}
+
+{{% notice style="tip" title="Notification Categories" %}}
+There are 4 operation types of notifications:
+
+- **Install**: Generated when installing a profile, containing the results of the installation.
+- **Enable**: Generated when a profile is activated.
+- **Disable**: Generated when a profile is disabled.
+- **Delete**: Generated when removing a profile, it is **important** to successfully send this notification.
+
+{{% /notice %}}
+
+## Process notifications on eSTK.me via Cloud Enhance
+
+Process notifications will send notifications in eSE to SM-DP+ Server, after notifications are sent, **notifications will be deleted except for "Delete"**.  
+When the process is complete, a pop-up will inform the user of the result and the server will be disconnected.