mirror of
https://github.com/switchbrew/libnx.git
synced 2025-06-21 12:32:40 +02:00
187 lines
8.7 KiB
C
187 lines
8.7 KiB
C
/**
|
|
* @file web.h
|
|
* @brief Wrapper for using the web LibraryApplets.
|
|
* @author p-sam, yellows8
|
|
* @copyright libnx Authors
|
|
*/
|
|
#pragma once
|
|
#include "../types.h"
|
|
#include "../services/applet.h"
|
|
|
|
/// This indicates the type of web-applet.
|
|
typedef enum {
|
|
WebShimKind_Login = 2,
|
|
WebShimKind_Share = 4,
|
|
WebShimKind_Web = 5,
|
|
WebShimKind_Wifi = 6,
|
|
WebShimKind_Lobby = 7,
|
|
} WebShimKind;
|
|
|
|
typedef struct {
|
|
u32 unk_x0; ///< Official sw sets this to 0 with appletStorageWrite, separately from the rest of the config struct.
|
|
char conntest_url[0x100];
|
|
char initial_url[0x400];
|
|
u128 userID;
|
|
u32 unk_x514;
|
|
} PACKED WebWifiPageArg;
|
|
|
|
typedef struct {
|
|
u32 unk_x0;
|
|
Result res;
|
|
} PACKED WebWifiReturnValue;
|
|
|
|
typedef struct {
|
|
WebWifiPageArg arg;
|
|
} WebWifiConfig;
|
|
|
|
/// TLV storage, starts with \ref WebArgHeader followed by \ref WebArgTLV entries.
|
|
typedef struct {
|
|
u8 data[0x2000];
|
|
} WebCommonTLVStorage;
|
|
|
|
typedef struct {
|
|
u32 exitReason;
|
|
u32 pad;
|
|
char lastUrl[0x1000];
|
|
u64 lastUrlSize;
|
|
} PACKED WebCommonReturnValue;
|
|
|
|
/// Header struct at offset 0 in the web Arg storage (non-webWifi).
|
|
typedef struct {
|
|
u16 total_entries; ///< Total \ref WebArgTLV entries following this struct.
|
|
u16 pad;
|
|
WebShimKind shimKind;
|
|
} PACKED WebArgHeader;
|
|
|
|
/// Web TLV used in the web Arg storage.
|
|
typedef struct {
|
|
u16 type; ///< Type of this arg.
|
|
u16 size; ///< Size of the arg data following this struct.
|
|
u8 pad[4];
|
|
} PACKED WebArgTLV;
|
|
|
|
typedef struct {
|
|
WebCommonTLVStorage arg;
|
|
AppletId appletid;
|
|
u32 version;
|
|
} WebCommonConfig;
|
|
|
|
/// Types for \ref WebArgTLV.
|
|
typedef enum {
|
|
WebArgType_Url = 0x1, ///< [1.0.0+] String, size 0xC00. Initial URL.
|
|
WebArgType_CallbackUrl = 0x3, ///< [1.0.0+] String, size 0x400.
|
|
WebArgType_CallbackableUrl = 0x4, ///< [1.0.0+] String, size 0x400.
|
|
WebArgType_ShareStartPage = 0x9, ///< [1.0.0+] u32 enum WebShareStartPage
|
|
WebArgType_Whitelist = 0xA, ///< [1.0.0+] String, size 0x1000.
|
|
WebArgType_NewsFlag = 0xB, ///< [1.0.0+] u8 bool
|
|
WebArgType_UnknownD = 0xD, ///< [1.0.0+] u8
|
|
WebArgType_UserID = 0xE, ///< [1.0.0+] u128 userID, controls which user-specific savedata to mount.
|
|
WebArgType_AlbumEntry = 0xF, ///< [1.0.0+] Share-applet caps AlbumEntry
|
|
WebArgType_EcClientCertEnabled = 0x11, ///< [1.0.0+] u8 bool
|
|
WebArgType_Unknown12 = 0x12, ///< [1.0.0+] u8
|
|
WebArgType_PlayReportEnabled = 0x13, ///< [1.0.0+] u8 bool
|
|
WebArgType_Unknown14 = 0x14, ///< [1.0.0+] u8
|
|
WebArgType_Unknown15 = 0x15, ///< [1.0.0+] u8
|
|
WebArgType_BootDisplayKind = 0x17, ///< [1.0.0+] u32 enum enum WebBootDisplayKind
|
|
WebArgType_BackgroundKind = 0x18, ///< [1.0.0+] u32 enum u32 enum *BackgroundKind
|
|
WebArgType_FooterEnabled = 0x19, ///< [1.0.0+] u8 bool
|
|
WebArgType_PointerEnabled = 0x1A, ///< [1.0.0+] u8 bool
|
|
WebArgType_LeftStickMode = 0x1B, ///< [1.0.0+] u32 enum *LeftStickMode
|
|
WebArgType_KeyRepeatFrame0 = 0x1C, ///< [1.0.0+] s32 KeyRepeatFrame, first param
|
|
WebArgType_KeyRepeatFrame1 = 0x1D, ///< [1.0.0+] s32 KeyRepeatFrame, second param
|
|
WebArgType_BootAsMediaPlayerInverted = 0x1E, ///< [1.0.0+] u8 bool, set after BootAsMediaPlayer with the value inverted.
|
|
WebArgType_DisplayUrlKind = 0x1F, ///< [1.0.0+] u8 bool, DisplayUrlKind (value = (input_enumval==0x1)).
|
|
WebArgType_BootAsMediaPlayer = 0x21, ///< [2.0.0+] u8 bool
|
|
WebArgType_ShopJumpEnabled = 0x22, ///< [2.0.0+] u8 bool
|
|
WebArgType_MediaPlayerUserGestureRestrictionEnabled = 0x23, ///< [2.0.0+] u8 bool
|
|
WebArgType_LobbyParameter = 0x24, ///< [2.0.0+] String, size 0x100.
|
|
WebArgType_ApplicationAlbumEntry = 0x26, ///< [3.0.0+] Share-applet caps ApplicationAlbumEntry
|
|
WebArgType_JsExtensionEnabled = 0x27, ///< [3.0.0+] u8 bool
|
|
WebArgType_AdditionalCommentText = 0x28, ///< [4.0.0+] String, size 0x100. Share-applet AdditionalCommentText.
|
|
WebArgType_TouchEnabledOnContents = 0x29, ///< [4.0.0+] u8 bool
|
|
WebArgType_UserAgentAdditionalString = 0x2A, ///< [4.0.0+] String, size 0x80.
|
|
WebArgType_AdditionalMediaData = 0x2B, ///< [4.0.0+] Share-applet 0x10-byte u8 array, AdditionalMediaData. If the user-input size is less than 0x10, the remaining data used for the TLV is cleared.
|
|
WebArgType_MediaPlayerAutoCloseEnabled = 0x2C, ///< [4.0.0+] u8 bool
|
|
WebArgType_PageCacheEnabled = 0x2D, ///< [4.0.0+] u8 bool
|
|
WebArgType_WebAudioEnabled = 0x2E, ///< [4.0.0+] u8 bool
|
|
WebArgType_2F = 0x2F, ///< [5.0.0+] u8
|
|
WebArgType_YouTubeVideoFlag = 0x31, ///< [5.0.0+] u8 bool Indicates that the built-in whitelist for YouTubeVideo should be used.
|
|
WebArgType_FooterFixedKind = 0x32, ///< [5.0.0+] u32 enum *WebFooterFixedKind
|
|
WebArgType_PageFadeEnabled = 0x33, ///< [5.0.0+] u8 bool
|
|
WebArgType_MediaCreatorApplicationRatingAge = 0x34, ///< [5.0.0+] Share-applet 0x20-byte s8 array, MediaCreatorApplicationRatingAge.
|
|
WebArgType_BootLoadingIconEnabled = 0x35, ///< [5.0.0+] u8 bool
|
|
WebArgType_PageScrollIndicatorEnabled = 0x36, ///< [5.0.0+] u8 bool
|
|
} WebArgType;
|
|
|
|
/**
|
|
* @brief Creates the config for WifiWebAuthApplet.
|
|
* @param config WebWifiConfig object.
|
|
* @param conntest_url URL used for the connection-test requests, if NULL initial_url is used for this.
|
|
* @param initial_url Initial URL navigated to by the applet.
|
|
* @param userID Account userID, 0 for common.
|
|
* @param unk Value written to \ref WebWifiPageArg unk_x514, this can be 0.
|
|
*/
|
|
void webWifiCreate(WebWifiConfig* config, const char* conntest_url, const char* initial_url, u128 userID, u32 unk);
|
|
|
|
/**
|
|
* @brief Launches WifiWebAuthApplet with the specified config and waits for it to exit.
|
|
* @param config WebWifiConfig object.
|
|
* @param out Optional output applet reply data, can be NULL.
|
|
*/
|
|
Result webWifiShow(WebWifiConfig* config, WebWifiReturnValue *out);
|
|
|
|
/**
|
|
* @brief Creates the config for WebApplet. This applet uses an URL whitelist loaded from the user-process host title.
|
|
* @param config WebCommonConfig object.
|
|
* @param url Initial URL navigated to by the applet.
|
|
*/
|
|
Result webPageCreate(WebCommonConfig* config, const char* url);
|
|
|
|
/**
|
|
* @brief Sets the CallbackUrl.
|
|
* @note Only available with config created by \ref webPageCreate or with Share-applet.
|
|
* @param config WebCommonConfig object.
|
|
* @param url URL
|
|
*/
|
|
Result webConfigSetCallbackUrl(WebCommonConfig* config, const char* url);
|
|
|
|
/**
|
|
* @brief Sets the CallbackableUrl.
|
|
* @note Only available with config created by \ref webPageCreate.
|
|
* @param config WebCommonConfig object.
|
|
* @param url URL
|
|
*/
|
|
Result webConfigSetCallbackableUrl(WebCommonConfig* config, const char* url);
|
|
|
|
/**
|
|
* @brief Sets the whitelist.
|
|
* @note Only available with config created by \ref webPageCreate.
|
|
* @note If the whitelist isn't formatted properly, the applet will exit briefly after the applet is launched.
|
|
* @param config WebCommonConfig object.
|
|
* @param whitelist Whitelist string, each line is a regex for each whitelisted URL.
|
|
*/
|
|
Result webConfigSetWhitelist(WebCommonConfig* config, const char* whitelist);
|
|
|
|
/**
|
|
* @brief Sets the DisplayUrlKind.
|
|
* @param config WebCommonConfig object.
|
|
* @param kind Kind
|
|
*/
|
|
Result webConfigSetDisplayUrlKind(WebCommonConfig* config, bool kind);
|
|
|
|
/**
|
|
* @brief Sets the UserAgentAdditionalString.
|
|
* @note Only available with config created by \ref webPageCreate on [4.0.0+].
|
|
* @param config WebCommonConfig object.
|
|
* @param str String
|
|
*/
|
|
Result webConfigSetUserAgentAdditionalString(WebCommonConfig* config, const char* str);
|
|
|
|
/**
|
|
* @brief Launches the {web applet} with the specified config and waits for it to exit.
|
|
* @param config WebCommonConfig object.
|
|
* @param out Optional output applet reply data, can be NULL.
|
|
*/
|
|
Result webConfigShow(WebCommonConfig* config, WebCommonReturnValue *out);
|
|
|