inetsim.conf(5)

📦
version 1.3.2 · 4 versions
, in ubuntu jammy, ubuntu noble

💖 inetsim.conf(5) — the manual page, bestie edition 💖

okay so you opened inetsim.conf(5), the config file page for inetsim(1). welcome, you're gonna slay this 🫶

✨ NAME ✨

inetsim.conf — bestie, it's literally just the configuration file for INetSim. that's the whole vibe. 💅

🌸 DESCRIPTION 🌸

So inetsim.conf is the config file for inetsim(1). that's it, that's the girl.

the format?? iconic, actually, because it's so simple: one option per line. blank lines? ignored. lines starting with #? also ignored. that's the entire ruleset, no cap. 🌈

👑 GLOBAL OPTIONS 👑

These ones set the whole mood for every service, periodt.

  • start_service SERVICE — start the service SERVICE. go girl, activate her.
  • service_bind_address ADDRESS — the IP address to bind services to. where the services live, fr fr.
  • service_run_as_user USER — the user to run services as. give her an identity 💜
  • service_max_childs NUMBER — max number of child processes — aka the number of parallel connections — for each service. so how many besties can be in the group chat at once.
  • service_timeout SECONDS — timeout in seconds, after which the service just closes the connection. bye bestie, time's up 😭
  • [servicename]_bind_port PORT — the PORT number to bind the service to. where she parks herself.
  • create_reports [YES|NO] — on shutdown, create a report with a summary of connections for the session. receipts! 🎀
  • report_language LANGUAGE — set the language for reports.
  • include FILENAME — include an additional file in the configuration. ⚠️ heads up bestie: this is allowed only in the main configuration file. no nesting shenanigans.

🦋 FAKETIME OPTIONS 🦋

playing pretend with the clock, lowkey her best bit.

  • faketime_init_delta SECONDS — initial number of seconds — positive or negative — relative to the current date/time, for the fake time used by all services. if you set it to 0, the current date/time is used. so 0 means no pretending, we're being real for once.
  • faketime_auto_delay SECONDS — how many seconds to wait before incrementing/decrementing fake time by the amount you set in faketime_auto_increment. setting it to 0 disables this option.
  • faketime_auto_increment SECONDS — number of seconds by which fake time gets incremented/decremented at regular intervals set by faketime_auto_delay. ⚠️ this one only takes effect if faketime_auto_delay is enabled — meaning not set to 0. they're a package deal, iykyk.

🌈 ADDITIONAL DNS OPTIONS 🌈

  • dns_default_ip IP-ADDRESS — default IP address to return in DNS replies.
  • dns_default_hostname HOSTNAME — default hostname to return in DNS replies.
  • dns_default_domainname DOMAINNAME — default domainname to return in DNS replies.
  • dns_static FQDN_HOSTNAME IP-ADDRESS — static mapping for DNS. locked in 🔒
  • dns_version STRING — version string to return.

✨ ADDITIONAL HTTP(S) OPTIONS ✨

  • http(s)_version — version string to return in HTTP(S) replies.
  • http(s)_post_limit NUMBER — size limit for POST requests, in bytes.
  • http(s)_fakemode [YES|NO] — turn HTTP(S) fake mode on or off.
  • http(s)_fakefile EXTENSION FILENAME MIMETYPE — the fake files returned in fake mode, based on the file extension in the HTTP(S) request.
  • http(s)_default_fakefile FILENAME MIMETYPE — the default fake file and MIME type returned in fake mode, used when the file extension in the HTTP(S) request doesn't match any of the extensions you defined with http(s)_fakefile. the fallback queen 👑
  • http(s)_static_fakefile PATH FILENAME MIMETYPE — the fake files returned in fake mode, based on the path in the HTTP(S) request.

💌 ADDITIONAL SMTP(S) OPTIONS 💌

  • smtp(s)_banner STRING — the banner string used in the SMTP greeting message.
  • smtp(s)_fqdn_hostname FQDN_HOST — the FQDN hostname used for SMTP.
  • smtp(s)_helo_required [YES|NO] — client has to send HELO/EHLO before any other command. no skipping the intro, bestie.
  • smtp(s)_extended_smtp — turn support for 'Extended SMTP' (ESMTP) on or off.
  • smtp(s)_service_extension EXTENSION [PARAMETER(S)] — SMTP service extensions offered to the client.
  • smtp(s)_auth_reversibleonly [YES|NO] — only offer authentication mechanisms which allow reversing the authentication information sent by a client to clear text username/password.
  • smtp(s)_auth_required [YES|NO] — force the client to authenticate. no auth, no entry 🚪

🎀 ADDITIONAL POP3(S) OPTIONS 🎀

  • pop3(s)_banner STRING — the banner string used in the POP3 greeting message.
  • pop3(s)_hostname HOST — the hostname used in the POP3 greeting message.
  • pop3(s)_mbox_maxmails NUMBER — maximum number of e-mails to select from the supplied mbox files, for creation of a random POP3 mailbox.
  • pop3(s)_mbox_reread NUMBER — re-read supplied mbox files if the POP3 service was inactive for <NUMBER> seconds.
  • pop3(s)_mbox_rebuild NUMBER — rebuild the random POP3 mailbox if the POP3 service was inactive for <NUMBER> seconds.
  • pop3(s)_auth_reversibleonly [YES|NO] — only offer authentication mechanisms which allow reversing the authentication information sent by a client to clear text username/password.
  • pop3(s)_enable_apop [YES|NO] — turn APOP on or off.
  • pop3(s)_enable_capabilities [YES|NO] — turn support for pop3 capabilities on or off.
  • pop3(s)_capability CAPABILITY [PARAMETER(S)] — POP3 capabilities offered to the client.

🍓 ADDITIONAL FTP(S) OPTIONS 🍓

  • ftp(s)_banner STRING — the banner string used in the FTP greeting message.
  • ftp(s)_version STRING — version string to return in replies to the STAT command.
  • ftp(s)_recursive_delete [YES|NO] — allow recursive deletion of directories, even if they are not empty. ⚠️ yes bestie, even the full ones. be careful with this one fr.
  • ftp(s)_max_filesize NUMBER — size limit for uploaded files, in bytes.

🧚 ADDITIONAL TFTP OPTIONS 🧚

  • tftp_allow_overwrite [YES|NO] — allow overwriting of existing files.
  • tftp_max_filesize NUMBER — size limit for uploaded files, in bytes.
  • tftp_enable_options [YES|NO] — turn support for tftp options on or off.
  • tftp_option OPTION PARAMETER(S) — TFTP options offered to the client.

⭐ ADDITIONAL NTP OPTIONS ⭐

  • ntp_server_ip IP-ADDRESS — the IP address to return in NTP replies.
  • ntp_strict_checks [YES|NO] — turn strict checks for client packets on or off.

💜 ADDITIONAL IRC OPTIONS 💜

  • irc_fqdn_hostname FQDN_HOST — the FQDN hostname used for IRC.
  • irc_version STRING — version string to return.

🙈 ADDITIONAL DUMMY OPTIONS 🙈

the dummy service is giving silent treatment until it's not.

  • dummy_banner STRING — banner string sent to the client if no data has been received for dummy_banner_wait seconds since the client established the connection. if set to an empty string (""), only CRLF will be sent. ⚠️ this option only takes effect if dummy_banner_wait is not set to 0.
  • dummy_banner_wait NUMBER — number of seconds to wait for the client to send any data after establishing a new connection. if no data has been received within that time, dummy_banner gets sent to the client. setting it to 0 disables sending of a banner string.

🔥 REDIRECT OPTIONS 🔥

  • redirect_enabled [YES|NO] — turn connection redirection on or off.
  • redirect_unknown_services [YES|NO] — redirect connection attempts to unbound ports to the dummy service.
  • redirect_external_address IP-ADDRESS — IP address used as source address if INetSim acts as a router for redirecting packets to external networks. ⚠️ this option only takes effect if static rules for redirecting packets to external networks are defined — see redirect_static_rule.
  • redirect_static_rule PROTOCOL IP-ADDRESS:PORT IP-ADDRESS:PORT — static mappings for connection redirection.
  • redirect_change_ttl [YES|NO] — change the time-to-live header field to a random value in outgoing IP packets.
  • redirect_exclude_port PROTOCOL:PORT — connections to <service_bind_address> on this port are not redirected. she's exempt 💅
  • redirect_ignore_bootp [YES|NO] — if set to 'yes', BOOTP (DHCP) broadcasts will not be redirected (UDP packets with source address 0.0.0.0, port 68 and destination address 255.255.255.255, port 67 or vice versa).
  • redirect_ignore_netbios [YES|NO] — if set to 'yes', NetBIOS broadcasts will not be redirected (UDP packets with source/destination port 137/138 and destination address x.x.x.255 on the local network).
  • redirect_icmp_timestamp [MS|SEC|NO] — if set to 'ms', ICMP Timestamp requests will be answered with the number of milliseconds since midnight UTC according to faketime. if set to 'sec', ICMP Timestamp requests will be answered with the number of seconds since epoch — the high order bit of the timestamp will be set to indicate a non-standard value. setting it to 'no' disables manipulation of ICMP Timestamp requests.

🦄 SSL OPTIONS 🦄

  • [servicename]_ssl_keyfile FILENAME — name of the SSL private key PEM file. 🚨 THE KEY MUST NOT BE ENCRYPTED! like, literally must not. no cap.
  • [servicename]_ssl_certfile FILENAME — name of the SSL certificate file.
  • [servicename]_ssl_dhfile FILENAME — name of the Diffie-Hellman parameter PEM file.

🌟 SEE ALSO 🌟

💖 AUTHOR 💖

Matthias Eckert <me@inetsim.org>, Thomas Hungenberg <th@inetsim.org> — legends, honestly 🫶

and that's the whole page, bestie!! this one was rendered by perl v5.34.0 and dated 2022-02-16 — so go forth, edit your inetsim.conf, and remember: one option per line, # for comments, and you ate 💅✨

📦 where this page comes from