Homebrew Homebrew app [Release] ftpsrv - A small ftp server

[mhh996378373]

sphaira looks very good, even better than Homebrew Details, looking forward to supporting multiple languages (such as Chinese). I have been enduring hbmenu for a long time.

 

[AlM2023]

I decided to release my ftp server publicly. It has builds for various platforms, such as the wii, 3ds, nds etc...but i figure that most users of this app will be using the switch version
There exists 2 builds for the switch, application and sys-module. The application is to be launched via hbmenu, the sys-module runs in the background.

Performance wise, it out performs ftpd (application), sys-ftpd-light (sys-module) and a few other homebrew apps that feature ftp servers, all while having a smaller memory footprint.
Do keep in mind that the sys-module version will perform much slower than the application version due to reducing the amount of memory ftpsrv uses.

Link to the project
Link to the releases

Whilst i'm here, i might as well release a public build of sphaira, my hb-menu replacement app. Have fun!

Sphaira, the HB-Menu replacement app, is absolutely beautiful! Please consider making it publicly available and adding more features to enhance its functionality.

 

[impeeza]

I guess I could create a thread for sphaira. Irs is the infrared camera on the joycon. Sphaira is full of random features because i was too lazy to create a new project and copy over my gui lib and set everything up, so any new features were added to sphaira instead.

good idea. the name listing will only be possible in the app version as the only way (that i know) to retrieve the game name is using `nsGetApplicationControlData()` and the struct passed in is ~130KiB in size, which is massive as it returns the compressed jpeg as well sadly.

the sysmod version would instead just list the title id's of all the games instead.

this will take me a couple of days due to work keeping me busy and i will need to restructure the vfs code quite a bit.

Hi @TotalJustice Tried to PM you but no avail, I am not programmer but some good fella is a good one.

He was telling me if you are using LibNX stdio in your code (I can not tell, I have no such knowledge) the code is going to run into problems mounting all of the saves at once. Mainly because the line https://github.com/switchbrew/libnx...8799f/nx/source/runtime/devices/fs_dev.c#L111 is an array of 32, so can overflow with all the titles.

An example of a code to handle many things open at once, well until console exhaust, is on https://github.com/J-D-K/FsLib/blob...808a982d7458fe7/3DS/FsLib/source/FsLib.cpp#L8 is a C++ map.

Hope this help you.

Regards mate.

 

[TomSwitch]

@TotalJustice I tried changing CMakeLists.txt to increase buffer size to 64k but the speed did not change.
ftp_set_options(ftpsrv_sysmod 769 6 1024*64)

 

[Deleted member 413168]

@TotalJustice I tried changing CMakeLists.txt to increase buffer size to 64k but the speed did not change.
ftp_set_options(ftpsrv_sysmod 769 6 1024*64)

You need to buffer r/w as well, see vfs-nx.c. the socket size may also need updating.

Hi @TotalJustice Tried to PM you but no avail, I am not programmer but some good fella is a good one.

He was telling me if you are using LibNX stdio in your code (I can not tell, I have no such knowledge) the code is going to run into problems mounting all of the saves at once. Mainly because the line https://github.com/switchbrew/libnx...8799f/nx/source/runtime/devices/fs_dev.c#L111 is an array of 32, so can overflow with all the titles.

An example of a code to handle many things open at once, well until console exhaust, is on https://github.com/J-D-K/FsLib/blob...808a982d7458fe7/3DS/FsLib/source/FsLib.cpp#L8 is a C++ map.

Hope this help you.

Regards mate.

I don't use stdio, I use native fs services.

Sphaira, the HB-Menu replacement app, is absolutely beautiful! Please consider making it publicly available and adding more features to enhance its functionality.

It's unlikely I'll make the code public, or add features. I will look into adding translations tho.

 

[impeeza]

I don't use stdio, I use native fs services.

Great then, that is easy.

 

[Deleted member 413168]

I am not able to mount save. I have put in a game title id that has save in config.ini
save_application_id = 0x010048802017A000

Why there is the comment port needs to be <1024? I have been using 5000 and it seems to work fine with yours too.

Love the mount point concept. Is there a way to add more directory to mount point with config.ini?

##########
# ftpsrv #
##########

#######################################################################
# Rename config.ini.template to config.ini for changes to take effect.#
#######################################################################

[Login]
# disabled by default, do not enable if using ldn_mitm as
# it's a security risk - you have been warned!
anon = 1

# if anon is disabled, then user and pass must be set.
; user =
; pass =

[Network]
# ports to be opened (< 1024), however, port 21 works fine for me...
port = 21

[Log]
# enables log output to /config/ftpsrv/log.txt
log = 0

# options specific to Nintendo Switch
[Nx]
# enables showing all available mount points at root "/"
# for example, SdCard is as at "/sdmc:"
mount_devices = 1

# mounts the application save data, needs mount_devices = 1
save_application_id = 0x010048802017A000

# mounts the application bcat data, needs mount_devices = 1
bcat_application_id = 0x0100F2C0115B6000

# enables led on the controller to light flash
led = 0

Post automatically merged: Nov 30, 2024

How does ftp work in sphaira? Is there a config setting for ftp and mtp? I can't get ftp to work and mtp has only the sd card.

That comment is wrong, I was meant to say ports less than 1024 are privileged and won't work. However if you open socket service as system, you can use them. Hence why port 21 works.

For the save, are you using application version or sysmod?

 

[TomSwitch]

For the save, are you using application version or sysmod?

Both don't work.

 

[Deleted member 413168]

Btw TomSwitch, if you're interested in getting the sysmod to perform better, I'd recommend making changes to the application version instead. Set all the values to match the sysmod and make tweaks there. It'll be much easier / quicker to debug. You can add nxlink output as well and if it crashes, it won't fatal your switch.

Although saying that, maybe hold off until I release the next version as theres a few areas in the code that are blocking (meaning, it can hang/stop responding) I've fixed everything locally but haven't commited the changes yet.

 

[TomSwitch]

Btw TomSwitch, if you're interested in getting the sysmod to perform better, I'd recommend making changes to the application version instead. Set all the values to match the sysmod and make tweaks there. It'll be much easier / quicker to debug. You can add nxlink output as well and if it crashes, it won't fatal your switch.

Although saying that, maybe hold off until I release the next version as theres a few areas in the code that are blocking (meaning, it can hang/stop responding) I've fixed everything locally but haven't commited the changes yet.

I make it spit out the values and I got this, don't know how to interpret the result code but is uid all 0 a problem?

 

[retnuh730]

I tried the NRO forwarder functionality and it worked for a bit, then atmosphere crashed and the forwarders no longer work. Is this compatible with the latest pre-release Atmosphere?

 

[TomSwitch]

I make it spit out the values and I got this, don't know how to interpret the result code but is uid all 0 a problem?
View attachment 473604

Made this change and is working
AccountUid uid[2];
s32 actual_total;
if (R_SUCCEEDED(accountListAllUsers(uid, 2, &actual_total))) {
if (R_SUCCEEDED(fsdev_wrapMountSave("save0", save_id, uid[0]))) {
add_device("save0");
};
if (R_SUCCEEDED(fsdev_wrapMountSave("save1", save_id, uid[1]))) {
add_device("save1");
};
};

This can't work on sysmodule?

 

[Deleted member 413168]

I tried the NRO forwarder functionality and it worked for a bit, then atmosphere crashed and the forwarders no longer work. Is this compatible with the latest pre-release Atmosphere?

Yeah, I'm using latest ams. Did you upgrade ams after installing the forwarders?

 

[TomSwitch]

Yeah, I'm using latest ams. Did you upgrade ams after installing the forwarders?

I tried on firmware 19 and forwarder not working.

 

[retnuh730]

Yeah, I'm using latest ams. Did you upgrade ams after installing the forwarders?

Nope, everything was exactly the same AMS wise before and after using the forwarders. Which makes it even more confusing that it seemed to work.

 

[TomSwitch]

The save mounted cannot write through to the actual game save. The read out works fine but writing does not work whether the game is running or not. Having the ability to read the save when the game is running is very nice. Not able to write even when the game isn't running is I suppose a bug.

 

[Deleted member 413168]

The save mounted cannot write through to the actual game save. The read out works fine but writing does not work whether the game is running or not. Having the ability to read the save when the game is running is very nice. Not able to write even when the game isn't running is I suppose a bug.

I believe that's because I don't commit the changes using FS commit. Iirc that is needed for save writes. I just forgot about it when I added save mounting.

Post automatically merged: Dec 3, 2024

sad, but no problem at all.

i thought this a bit more, instead of using ns to read the application name (and the jpeg, that we don't need), i can just use ncm to read find and read the control nca and read the nacp (which has the application name). should be faster too due to not having the fetch the jpeg data. this is probably what ns does internally anyway.

 

[Deleted member 413168]

As explained by @impeeza . Thank you

​

i'm working on the save listing now. theres 2 ways it can be listed:
"/save:/account_name/bcat/game_name"
or
"/save:/bcat/account_name/game_name"
which would you prefer?

doing "save:/game_name/account_name/bcat/" isn't an option as it would be very inefficient to list games. i'd basically have to loop through every game, check if it has a save, has a save for x user, has a save for bcat etc. whereas with the first 2 options, i can use a filter and only fetch what i need. jksv and such can get away with it because they have a lot of memory to work with. the sysmod is working with like 2kb of ram heh.

 

[impeeza]

i'm working on the save listing now. theres 2 ways it can be listed:
"/save:/account_name/bcat/game_name"
or
"/save:/bcat/account_name/game_name"
which would you prefer?

doing "save:/game_name/account_name/bcat/" isn't an option as it would be very inefficient to list games. i'd basically have to loop through every game, check if it has a save, has a save for x user, has a save for bcat etc. whereas with the first 2 options, i can use a filter and only fetch what i need. jksv and such can get away with it because they have a lot of memory to work with. the sysmod is working with like 2kb of ram heh.

BCAT should be a «Account» by example if you have 2 users: Pepito & Susanita, and two games: Karts & Bros, you can see:

/save:/Pepito/Karts
             /Bros
      /Susanita/Karts
               /Bros
      /bcat/Karts
           /Bros

Or:

/save:/Karts/Pepito
            /Susanita
            /bcat
      /Bros/Pepito
           /Susanita
           /bcat

 

[Deleted member 413168]

BCAT should be a «Account» by example if you have 2 users: Pepito & Susanita, and two games: Karts & Bros, you can see:

/save:/Pepito/Karts
             /Bros
      /Susanita/Karts
               /Bros
      /bcat/Karts
           /Bros

Or:

/save:/Karts/Pepito
            /Susanita
            /bcat
      /Bros/Pepito
           /Susanita
           /bcat

thanks! i have save listing working now, the games will be listed like `Another Code: Recollection [0100CB9018F5A000]` and if the game is no longer installed (so i cant fetch the name), i will just show the id [01009B90006DC000]

btw i worked around that issue i mentioned before about not being able to get the game name. instead of using ns, i found the control nca using ncm, then get that nca path and then open it as a filesystem. when a nca is mounted, it is automatically decrypted by hos, so i can simply open it as a file and read the name

btw, do you think its a good idea to allow the save data to be writable? i am a little worried someone may accidentially destroy their save data. tools like jksv have a good ui and make it clear to the user that they're deleting their save, also they keep backups of save data. i cannot really do that with ftp. maybe i should have save be read only, but enable write mode in the config.ini?