Skip to content

[macOS sandbox mode] Application group name mangling for semaphores #1167

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

Merged
merged 19 commits into from
Dec 21, 2022
Merged

[macOS sandbox mode] Application group name mangling for semaphores #1167

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
4f6f63c
attempt to query FirebaseSemaphorePrefix from Info.plist
DellaBitta Dec 8, 2022
92c5836
add util_apple files
DellaBitta Dec 8, 2022
b395150
remove cached util_ios changes
DellaBitta Dec 8, 2022
2bdf821
Merge branch 'main' into ddb/mac_threading
DellaBitta Dec 9, 2022
d010b7a
put GetCustomSemaphorePrefix() in firebase::util
DellaBitta Dec 9, 2022
2a6a8e3
some renames. Only applicable to macOS
DellaBitta Dec 9, 2022
597109b
append slash
DellaBitta Dec 9, 2022
e88d15e
revert scheduler debug logging
DellaBitta Dec 10, 2022
31677d5
proper semaphore creation detection for each platform
DellaBitta Dec 10, 2022
17827b9
release notes entry
DellaBitta Dec 10, 2022
97ac04c
lint fixes
DellaBitta Dec 10, 2022
c673949
Merge branch 'main' into ddb/mac_threading
DellaBitta Dec 10, 2022
60d38ed
linux semaphore pointer assertion
DellaBitta Dec 10, 2022
0641785
unlink the full semaphore name on macOS
DellaBitta Dec 11, 2022
36f845f
merge main
DellaBitta Dec 15, 2022
8edbe88
remove printfs, assert macOS on nullptr
DellaBitta Dec 15, 2022
d984319
merge main
DellaBitta Dec 20, 2022
771da32
test semaphore creation on init. Better logging on macOS error
DellaBitta Dec 20, 2022
586dbc8
add Firebase to assert message.
DellaBitta Dec 20, 2022
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
4 changes: 4 additions & 0 deletions app/src/app_desktop.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
#include "app/src/include/firebase/internal/common.h"
#include "app/src/include/firebase/version.h"
#include "app/src/log.h"
#include "app/src/semaphore.h"
#include "app/src/util.h"

namespace firebase {
Expand Down Expand Up @@ -131,6 +132,9 @@ App* App::Create(const AppOptions& options, const char* name) { // NOLINT
return app;
}
LogDebug("Creating Firebase App %s for %s", name, kFirebaseVersionString);
LogDebug("Validating semaphore creation.");
{ firebase::Semaphore sem_test(0); }

AppOptions options_with_defaults = options;
if (options_with_defaults.PopulateRequiredWithDefaults()) {
app = new App();
Expand Down
20 changes: 15 additions & 5 deletions app/src/semaphore.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@

#include <errno.h>

#include "app/src/assert.h"
#include "app/src/include/firebase/internal/platform.h"
#include "app/src/time.h"

Expand All @@ -40,6 +41,8 @@
#include "app/src/include/firebase/internal/mutex.h"
#include "app/src/pthread_condvar.h"
#include "app/src/util_apple.h"

#define FIREBASE_SEMAPHORE_DEFAULT_PREFIX "/firebase-"
#endif // FIREBASE_PLATFORM_OSX || FIREBASE_PLATFORM_IOS ||
// FIREBASE_PLATFORM_TVOS

Expand All @@ -61,24 +64,31 @@ class Semaphore {
snprintf(buffer, kBufferSize, "%016llx",
static_cast<unsigned long long>( // NOLINT
reinterpret_cast<intptr_t>(this)));

#if FIREBASE_PLATFORM_OSX
// Sandbox mode is currently only available for macOS.
// Append custom semaphore names, if present, to support macOS Sandbox
// mode.
std::string semaphore_name = util::GetSandboxModeSemaphorePrefix();
if (semaphore_name.empty()) {
semaphore_name = "/firebase-";
semaphore_name = FIREBASE_SEMAPHORE_DEFAULT_PREFIX;
}
#else
std::string semaphore_name = "/firebase-";
std::string semaphore_name = FIREBASE_SEMAPHORE_DEFAULT_PREFIX;
#endif // FIREBASE_PLATFORM_OSX

semaphore_name.append(buffer);

semaphore_ = sem_open(semaphore_name.c_str(),
O_CREAT | O_EXCL, // Create if it doesn't exist.
S_IRUSR | S_IWUSR, // Only the owner can read/write.
initial_count);

// Check for errors.
#if FIREBASE_PLATFORM_OSX
FIREBASE_ASSERT_MESSAGE(
semaphore_ != SEM_FAILED,
"Failed to create semaphore. If running in sandbox mode be sure to "
"configure FBAppGroupEntitlementName in your app's Info.plist.");
#endif // FIREBASE_PLATFORM_OSX

assert(semaphore_ != SEM_FAILED);
assert(semaphore_ != nullptr);

Expand Down