Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updated Secure Tunneling close logic for Secure Tunneling Component #427

Merged
merged 2 commits into from
Oct 3, 2023
Merged

Updated Secure Tunneling close logic for Secure Tunneling Component #427

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bbd0042
Updated tunnel shutdown logic for Secure Tunneling component
HarshGandhi-AWS Sep 30, 2023
301c422
removed extra log statement
HarshGandhi-AWS Oct 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 40 additions & 30 deletions source/main.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,24 +145,27 @@ void shutdown()
LOG_DEBUG(TAG, "Calling stop all");
features->stopAll();
}
resourceManager->dumpMemTrace();

LOG_INFO(TAG, "All features have stopped");
// terminate program
#if !defined(DISABLE_MQTT)
resourceManager->disconnect();
if (resourceManager != NULL)
{
resourceManager->dumpMemTrace();
resourceManager->disconnect();
resourceManager.reset();
}
#endif
LoggerFactory::getLoggerInstance().get()->shutdown();
resourceManager.reset();
exit(0);
LoggerFactory::getLoggerInstance()->shutdown();
exit(EXIT_SUCCESS);
}

/**
* \brief This function shuts down device client when aborting execution due to some type of configuration issue
*
* @param reason the reason why the abort is happening
*/
void deviceClientAbort(const string &reason)
void deviceClientAbort(const string &reason, int exitCode)
{
if (resourceManager != NULL)
{
Expand All @@ -172,7 +175,7 @@ void deviceClientAbort(const string &reason)
LoggerFactory::getLoggerInstance()->shutdown();
cout << "AWS IoT Device Client must abort execution, reason: " << reason << endl;
cout << "Please check the AWS IoT Device Client logs for more information" << endl;
exit(EXIT_FAILURE);
exit(exitCode);
}

void attemptConnection()
Expand All @@ -190,7 +193,8 @@ void attemptConnection()
"IoT credentials, "
"configuration and/or certificate policy. ***",
DC_FATAL_ERROR);
deviceClientAbort("Failed to establish MQTT connection due to credential/configuration error");
deviceClientAbort(
"Failed to establish MQTT connection due to credential/configuration error", EXIT_FAILURE);
return true;
}
else if (SharedCrtResourceManager::SUCCESS == connectionStatus)
Expand All @@ -209,7 +213,7 @@ void attemptConnection()
catch (const std::exception &e)
{
LOGM_ERROR(TAG, "Error attempting to connect: %s", e.what());
deviceClientAbort("Failure from attemptConnection");
deviceClientAbort("Failure from attemptConnection", EXIT_FAILURE);
}
}

Expand Down Expand Up @@ -237,10 +241,6 @@ namespace Aws
case ClientBaseEventNotification::FEATURE_STOPPED:
{
LOGM_INFO(TAG, "%s has stopped", feature->getName().c_str());
// Stopping DC instance if secure tunnel is closed for a ST component
#if defined(DISABLE_MQTT)
shutdown();
#endif
break;
}
default:
Expand Down Expand Up @@ -283,7 +283,7 @@ namespace Aws
TAG,
"*** %s: Aborting program due to unrecoverable feature error! ***",
DeviceClient::DC_FATAL_ERROR);
deviceClientAbort(feature->getName() + " encountered an error");
deviceClientAbort(feature->getName() + " encountered an error", EXIT_FAILURE);
#endif
}
};
Expand All @@ -305,7 +305,7 @@ int main(int argc, char *argv[])
TAG,
"*** %s: AWS IoT Device Client must abort execution, reason: Invalid configuration ***",
DC_FATAL_ERROR);
deviceClientAbort("Invalid configuration");
deviceClientAbort("Invalid configuration", EXIT_FAILURE);
}

if (!LoggerFactory::reconfigure(config.config) &&
Expand Down Expand Up @@ -334,7 +334,7 @@ int main(int argc, char *argv[])
if (!init(argc, argv))
{
LOGM_ERROR(TAG, "*** %s: An instance of Device Client is already running.", DC_FATAL_ERROR);
deviceClientAbort("An instance of Device Client is already running.");
deviceClientAbort("An instance of Device Client is already running.", EXIT_FAILURE);
}
#endif

Expand All @@ -356,7 +356,7 @@ int main(int argc, char *argv[])
if (!resourceManager.get()->initialize(config.config, features))
{
LOGM_ERROR(TAG, "*** %s: Failed to initialize AWS CRT SDK.", DC_FATAL_ERROR);
deviceClientAbort("Failed to initialize AWS CRT SDK");
deviceClientAbort("Failed to initialize AWS CRT SDK", EXIT_FAILURE);
}

#if !defined(EXCLUDE_FP) && !defined(DISABLE_MQTT)
Expand Down Expand Up @@ -384,7 +384,7 @@ int main(int argc, char *argv[])
"Please verify your AWS IoT credentials, "
"configuration, Fleet Provisioning Template, claim certificate and policy used. ***",
DC_FATAL_ERROR);
deviceClientAbort("Fleet provisioning failed");
deviceClientAbort("Fleet provisioning failed", EXIT_FAILURE);
}
resourceManager->disconnect();
}
Expand All @@ -395,8 +395,10 @@ int main(int argc, char *argv[])
TAG,
"*** %s: Fleet Provisioning configuration is enabled but feature is not compiled into binary.",
DC_FATAL_ERROR);
deviceClientAbort("Invalid configuration. Fleet Provisioning configuration is enabled but feature is not "
"compiled into binary.");
deviceClientAbort(
"Invalid configuration. Fleet Provisioning configuration is enabled but feature is not "
"compiled into binary.",
EXIT_FAILURE);
}
#endif

Expand All @@ -415,7 +417,7 @@ int main(int argc, char *argv[])
TAG,
"*** %s: Secure Element configuration is enabled but feature is not compiled into binary.",
DC_FATAL_ERROR);
deviceClientAbort("Invalid configuration");
deviceClientAbort("Invalid configuration", EXIT_FAILURE);
}
else
{
Expand All @@ -429,7 +431,8 @@ int main(int argc, char *argv[])
"*** %s: Secure Element configuration is enabled but feature is not compiled into binary.",
DC_FATAL_ERROR);
deviceClientAbort(
"Invalid configuration. Secure Element configuration is enabled but feature is not compiled into binary.");
"Invalid configuration. Secure Element configuration is enabled but feature is not compiled into binary.",
EXIT_FAILURE);
}
#endif

Expand All @@ -453,7 +456,7 @@ int main(int argc, char *argv[])
TAG,
"*** %s: Config Shadow configuration is enabled but feature is not compiled into binary.",
DC_FATAL_ERROR);
deviceClientAbort("Invalid configuration");
deviceClientAbort("Invalid configuration", EXIT_FAILURE);
}
#endif

Expand All @@ -477,7 +480,8 @@ int main(int argc, char *argv[])
LOGM_ERROR(
TAG, "*** %s: Jobs configuration is enabled but feature is not compiled into binary.", DC_FATAL_ERROR);
deviceClientAbort(
"Invalid configuration. Config Shadow configuration is enabled but feature is not compiled into binary.");
"Invalid configuration. Config Shadow configuration is enabled but feature is not compiled into binary.",
EXIT_FAILURE);
}
#endif

Expand All @@ -502,8 +506,10 @@ int main(int argc, char *argv[])
TAG,
"*** %s: Secure Tunneling configuration is enabled but feature is not compiled into binary.",
DC_FATAL_ERROR);
deviceClientAbort("Invalid configuration. Secure Tunneling configuration is enabled but feature is not "
"compiled into binary.");
deviceClientAbort(
"Invalid configuration. Secure Tunneling configuration is enabled but feature is not "
"compiled into binary.",
EXIT_FAILURE);
}
#endif

Expand All @@ -529,7 +535,8 @@ int main(int argc, char *argv[])
"*** %s: Device Defender configuration is enabled but feature is not compiled into binary.",
DC_FATAL_ERROR);
deviceClientAbort(
"Invalid configuration. Device Defender configuration is enabled but feature is not compiled into binary.");
"Invalid configuration. Device Defender configuration is enabled but feature is not compiled into binary.",
EXIT_FAILURE);
}
#endif

Expand All @@ -555,7 +562,8 @@ int main(int argc, char *argv[])
"*** %s: Sample Shadow configuration is enabled but feature is not compiled into binary.",
DC_FATAL_ERROR);
deviceClientAbort(
"Invalid configuration. Sample Shadow configuration is enabled but feature is not compiled into binary.");
"Invalid configuration. Sample Shadow configuration is enabled but feature is not compiled into binary.",
EXIT_FAILURE);
}
#endif

Expand All @@ -581,7 +589,8 @@ int main(int argc, char *argv[])
"*** %s: PubSub sample configuration is enabled but feature is not compiled into binary.",
DC_FATAL_ERROR);
deviceClientAbort(
"Invalid configuration. PubSub sample configuration is enabled but feature is not compiled into binary.");
"Invalid configuration. PubSub sample configuration is enabled but feature is not compiled into binary.",
EXIT_FAILURE);
}
#endif

Expand All @@ -607,7 +616,8 @@ int main(int argc, char *argv[])
"*** %s: Sensor Publish configuration is enabled but feature is not compiled into binary.",
DC_FATAL_ERROR);
deviceClientAbort(
"Invalid configuration. Sensor Publish configuration is enabled but feature is not compiled into binary.");
"Invalid configuration. Sensor Publish configuration is enabled but feature is not compiled into binary.",
EXIT_FAILURE);
}
#endif

Expand Down
8 changes: 5 additions & 3 deletions source/tunneling/SecureTunnelingFeature.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
#include "TcpForward.h"
#include <aws/crt/mqtt/MqttClient.h>
#include <aws/iotsecuretunneling/SubscribeToTunnelsNotifyRequest.h>
#include <csignal>
#include <map>
#include <memory>
#include <thread>
Expand Down Expand Up @@ -272,14 +273,15 @@ namespace Aws
void SecureTunnelingFeature::OnConnectionShutdown(SecureTunnelingContext *contextToRemove)
{
LOG_DEBUG(TAG, "SecureTunnelingFeature::OnConnectionShutdown");
#if defined(DISABLE_MQTT)
this->stop();
#else
auto it =
find_if(mContexts.begin(), mContexts.end(), [&](const unique_ptr<SecureTunnelingContext> &c) {
return c.get() == contextToRemove;
});
mContexts.erase(std::remove(mContexts.begin(), mContexts.end(), *it));

#if defined(DISABLE_MQTT)
LOG_INFO(TAG, "Secure Tunnel closed, component cleaning up open thread");
raise(SIGTERM);
#endif
}

Expand Down
Loading