Skip to content

Commit

Permalink
Added BannerCfg class to hostcfgd to handle Banner messages
Browse files Browse the repository at this point in the history
Signed-off-by: Yevhen Fastiuk <yfastiuk@nvidia.com>
  • Loading branch information
fastiuk committed May 9, 2024
1 parent 722b796 commit b718247
Showing 1 changed file with 92 additions and 0 deletions.
92 changes: 92 additions & 0 deletions scripts/hostcfgd
Original file line number Diff line number Diff line change
Expand Up @@ -1500,6 +1500,85 @@ class FipsCfg(object):
syslog.syslog(syslog.LOG_INFO, f'FipsCfg: update the FIPS enforce option {self.enforce}.')
loader.set_fips(image, self.enforce)


class BannerCfg(object):
"""
Banner Config Daemon
Handles changes in BANNER_MESSAGE table.
1) Handle change of feature state
2) Handle change of login message
3) Handle change of MOTD message
4) Handle change of logout message
"""

def __init__(self):
self.cache = {}

def load(self, banner_messages_config: dict):
"""Banner messages configuration
Force load banner configuration. Login messages should be taken at boot-time by
SSH daemon.
Args:
banners_message_config: Configured banner messages.
"""

syslog.syslog(syslog.LOG_INFO, 'BannerCfg: load initial')

if not banner_messages_config:
banner_messages_config = {}

# Force load banner messages.
# Login messages show be taken at boot-time by SSH daemon.
state_data = banner_messages_config.get("state", {})
login_data = banner_messages_config.get("login", {})
motd_data = banner_messages_config.get("motd", {})
logout_data = banner_messages_config.get("logout", {})

self.banner_message("state", state_data)
self.banner_message("login", login_data)
self.banner_message("motd", motd_data)
self.banner_message("logout", logout_data)

def banner_message(self, key, data):
"""
Apply banner message handler.
Args:
cache: Cache to compare/save data.
db: DB instance.
table: DB table that was changed.
key: DB table's key that was triggered change.
data: Read table data.
"""
# Handling state, login/logout and MOTD messages. Data should be a dict
if type(data) != dict:
# Nothing to handle
return

update_required = False
# Check with cache
for k,v in data.items():
if v != self.cache.get(k):
update_required = True
break

if update_required == False:
return

try:
run_cmd(["systemctl", "restart", "banner-config"], True, True)
except Exception:
syslog.syslog(syslog.LOG_ERR, 'BannerCfg: Failed to restart '
'banner-config service')
return

# Update cache
for k,v in data.items():
self.cache[k] = v


class HostConfigDaemon:
def __init__(self):
self.state_db_conn = DBConnector(STATE_DB, 0)
Expand Down Expand Up @@ -1551,6 +1630,9 @@ class HostConfigDaemon:
# Initialize FipsCfg
self.fipscfg = FipsCfg(self.state_db_conn)

# Initialize BannerCfg
self.bannermsgcfg = BannerCfg()

def load(self, init_data):
aaa = init_data['AAA']
tacacs_global = init_data['TACPLUS']
Expand All @@ -1571,6 +1653,7 @@ class HostConfigDaemon:
ntp_global = init_data.get(swsscommon.CFG_NTP_GLOBAL_TABLE_NAME)
ntp_servers = init_data.get(swsscommon.CFG_NTP_SERVER_TABLE_NAME)
ntp_keys = init_data.get(swsscommon.CFG_NTP_KEY_TABLE_NAME)
banner_messages = init_data.get(swsscommon.CFG_BANNER_MESSAGE_TABLE_NAME)

self.aaacfg.load(aaa, tacacs_global, tacacs_server, radius_global, radius_server)
self.iptables.load(lpbk_table)
Expand All @@ -1584,6 +1667,7 @@ class HostConfigDaemon:
self.dnscfg.load(dns)
self.fipscfg.load(fips_cfg)
self.ntpcfg.load(ntp_global, ntp_servers, ntp_keys)
self.bannermsgcfg.load(banner_messages)

# Update AAA with the hostname
self.aaacfg.hostname_update(self.devmetacfg.hostname)
Expand Down Expand Up @@ -1716,6 +1800,10 @@ class HostConfigDaemon:
data = self.config_db.get_table("FIPS")
self.fipscfg.fips_handler(data)

def banner_handler(self, key, op, data):
syslog.syslog(syslog.LOG_INFO, 'BANNER_MESSAGE table handler...')
self.bannermsgcfg.banner_message(key, data)

def wait_till_system_init_done(self):
# No need to print the output in the log file so using the "--quiet"
# flag
Expand Down Expand Up @@ -1778,6 +1866,10 @@ class HostConfigDaemon:
self.config_db.subscribe(swsscommon.CFG_NTP_KEY_TABLE_NAME,
make_callback(self.ntp_srv_key_handler))

# Handle BANNER_MESSAGE changes
self.config_db.subscribe(swsscommon.CFG_BANNER_MESSAGE_TABLE_NAME,
make_callback(self.banner_handler))

syslog.syslog(syslog.LOG_INFO,
"Waiting for systemctl to finish initialization")
self.wait_till_system_init_done()
Expand Down

0 comments on commit b718247

Please sign in to comment.