Feature Request: logging of client IP in standard logs

[deepjansari]

Hi,

I am running the proxy on Linux with --no-gui mode and everything is working fine and it's great however wanted to see some of the below options are possible by any chance.

1. Logging of client IP address in the standard logs (currently it only logs the username)
2. Enable debug mode without killing the process and starting again
3. Reload config file without killing the process and starting again

The last 2 options are present with GUI and want to see if same can be done with --no-gui option.

Thank you!

[simonrob]

Hi - thanks for these suggestions.

1. Logging of client IP address in the standard logs (currently it only logs the username)

The standard non-debug log output already displays the proxy's local address as set up in the config file, and the debug log just expands this to show the eventual local port and remote server address. When you're running the proxy on the same system as the email client, showing its address would be a bit meaningless. Do you mean the remote client address in the case that you're using the proxy on a public server?

2. Enable debug mode without killing the process and starting again

From memory this may have been suggested before, but I can't find the discussion right now (it'll be in a GitHub issue). How would you suggest this is achieved?

3. Reload config file without killing the process and starting again

This is already possible on macOS and Linux by sending SIGHUP – for example, pkill -SIGHUP -f emailproxy.py. I'm open to suggestions about how to achieve this on Windows if needed.

[deepjansari]

Hello,

Thank you for quick response! :)

1. Yes, I mean the remote client address as I am running the proxy on separate server
2. Sorry, I am new to Python hence can not suggest on this
3. Thank you for providing SIGHUP example. This is exactly what I needed.

[simonrob]

I think the debug mode toggle is a useful idea, so have added it in 5f83395. Toggle modes by sending SIGUSR (e.g., via pkill -USR1 -f emailproxy.py).

The client address could be printed fairly easily when clients first connect, but providing this for every log line as is currently done with the server address(es) would require more effort. Would a message on a new connection be useful? (i.e., as part of the New incoming connection to IMAP server at XXX or related log lines)

[deepjansari]

Thanks for update.
Debug mode - I tested the "pkill -SIGUSR1 -f emailproxy.py" and "pkill -USR1 -f emailproxy.py" with new proxy and seems the whole proxy process is just getting killed. Would there be also an option to disable debug mode (e.g. in scenario after troubleshooting is done and debug mode is no longer needed)

Client address - Yes, in my view when client first connect should be enough to have address for audit purpose. Also, it would be nice to have client address printed for failed login attempts.

[simonrob]

Thanks for testing this – I use the macOS version (which works); the Linux version had a typo, which is fixed in 73f7d8a. Sending the signal toggles debug mode, so yes, you can disable it when you don't need it any more.

If I get time, I'll see whether the client address can be printed.

[deepjansari]

Thanks, I have tested debug toggle on Linux and all works fine!!

[simonrob]

36a8e8d adds full connection details to the debug log, making it clearer which is the client, proxy and remote server address.