BIT-58: Configure the project to allow customizing bundle identifiers…

… and versions (#14)

.gitignore

@@ -70,3 +70,6 @@ fastlane/README.md
 
 # XcodeGen
 /*.xcodeproj
+
+# Local xcconfig
+Configs/Local.xcconfig

Bitwarden/Application/Support/Assets.xcassets/AppIcon-Dev.appiconset/Contents.json

@@ -1,6 +1,7 @@
 {
   "images" : [
     {
+      "filename" : "AppIcon-Dev.png",
       "idiom" : "universal",
       "platform" : "ios",
       "size" : "1024x1024"

Bitwarden/Application/Support/Assets.xcassets/AppIcon.appiconset/Contents.json

@@ -1,6 +1,7 @@
 {
   "images" : [
     {
+      "filename" : "Icon-1024.png",
       "idiom" : "universal",
       "platform" : "ios",
       "size" : "1024x1024"

Bitwarden/Application/Support/Bitwarden.entitlements

@@ -6,19 +6,18 @@
 	<true/>
 	<key>com.apple.security.application-groups</key>
 	<array>
-		<string>group.com.8bit.bitwarden</string>
+		<string>group.$(ORGANIZATION_IDENTIFIER).bitwarden</string>
 	</array>
 	<key>keychain-access-groups</key>
 	<array>
-		<string>$(AppIdentifierPrefix)com.8bit.bitwarden</string>
+		<string>$(AppIdentifierPrefix)$(ORGANIZATION_IDENTIFIER).bitwarden</string>
 	</array>
 	<key>com.apple.developer.ubiquity-container-identifiers</key>
 	<array>
 		<string>iCloud.$(CFBundleIdentifier)</string>
 	</array>
 	<key>com.apple.developer.nfc.readersession.formats</key>
 	<array>
-		<string>NDEF</string>
 		<string>TAG</string>
 	</array>
 	<key>com.apple.developer.associated-domains</key>

Bitwarden/Application/Support/Info.plist

@@ -11,13 +11,15 @@
 	<key>CFBundleExecutable</key>
 	<string>$(EXECUTABLE_NAME)</string>
 	<key>CFBundleIdentifier</key>
-	<string>com.8bit.bitwarden</string>
+	<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
 	<key>CFBundleShortVersionString</key>
-	<string>2023.7.1</string>
+	<string>$(MARKETING_VERSION)</string>
 	<key>CFBundleVersion</key>
-	<string>1</string>
+	<string>$(CURRENT_PROJECT_VERSION)</string>
 	<key>CFBundleIconName</key>
 	<string>AppIcon</string>
+	<key>CFBundlePackageType</key>
+	<string>$(PRODUCT_BUNDLE_PACKAGE_TYPE)</string>
 	<key>CFBundleURLTypes</key>
 	<array>
 		<dict>

BitwardenActionExtension/Application/Support/BitwardenActionExtension.entitlements

@@ -4,11 +4,11 @@
 <dict>
 	<key>com.apple.security.application-groups</key>
 	<array>
-		<string>group.com.8bit.bitwarden</string>
+		<string>group.$(ORGANIZATION_IDENTIFIER).bitwarden</string>
 	</array>
 	<key>keychain-access-groups</key>
 	<array>
-		<string>$(AppIdentifierPrefix)com.8bit.bitwarden</string>
+		<string>$(AppIdentifierPrefix)$(ORGANIZATION_IDENTIFIER).bitwarden</string>
 	</array>
 </dict>
 </plist>

BitwardenActionExtension/Application/Support/Info.plist

@@ -9,9 +9,9 @@
 		<key>CFBundleExecutable</key>
 		<string>$(EXECUTABLE_NAME)</string>
 		<key>CFBundleIdentifier</key>
-		<string>com.8bit.bitwarden.find-login-action-extension</string>
+		<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
 		<key>CFBundleShortVersionString</key>
-		<string>2023.7.1</string>
+		<string>$(MARKETING_VERSION)</string>
 		<key>CFBundleLocalizations</key>
 		<array>
 			<string>en</string>
@@ -101,6 +101,6 @@
 			<string>com.apple.ui-services</string>
 		</dict>
 		<key>CFBundleVersion</key>
-		<string>1</string>
+		<string>$(CURRENT_PROJECT_VERSION)</string>
 	</dict>
 </plist>

BitwardenAutoFillExtension/Application/Support/BitwardenAutoFill.entitlements

@@ -6,11 +6,11 @@
 	<true/>
 	<key>com.apple.security.application-groups</key>
 	<array>
-		<string>group.com.8bit.bitwarden</string>
+		<string>group.$(ORGANIZATION_IDENTIFIER).bitwarden</string>
 	</array>
 	<key>keychain-access-groups</key>
 	<array>
-		<string>$(AppIdentifierPrefix)com.8bit.bitwarden</string>
+		<string>$(AppIdentifierPrefix)$(ORGANIZATION_IDENTIFIER).bitwarden</string>
 	</array>
 </dict>
 </plist>

BitwardenAutoFillExtension/Application/Support/Info.plist

@@ -9,11 +9,11 @@
 	<key>CFBundleExecutable</key>
 	<string>$(EXECUTABLE_NAME)</string>
 	<key>CFBundleIdentifier</key>
-	<string>com.8bit.bitwarden.autofill</string>
+	<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
 	<key>CFBundleShortVersionString</key>
-	<string>2023.7.1</string>
+	<string>$(MARKETING_VERSION)</string>
 	<key>CFBundleVersion</key>
-	<string>1</string>
+	<string>$(CURRENT_PROJECT_VERSION)</string>
 	<key>CFBundleLocalizations</key>
 	<array>
 		<string>en</string>

BitwardenShareExtension/Application/Support/BitwardenShareExtension.entitlements

@@ -4,11 +4,11 @@
 <dict>
 	<key>com.apple.security.application-groups</key>
 	<array>
-		<string>group.com.8bit.bitwarden</string>
+		<string>group.$(ORGANIZATION_IDENTIFIER).bitwarden</string>
 	</array>
 	<key>keychain-access-groups</key>
 	<array>
-		<string>$(AppIdentifierPrefix)com.8bit.bitwarden</string>
+		<string>$(AppIdentifierPrefix)$(ORGANIZATION_IDENTIFIER).bitwarden</string>
 	</array>
 </dict>
 </plist>

BitwardenShareExtension/Application/Support/Info.plist

@@ -6,8 +6,10 @@
 	<string>Bitwarden Share</string>
 	<key>CFBundleName</key>
 	<string>Bitwarden Share Extension</string>
+	<key>CFBundleExecutable</key>
+	<string>$(EXECUTABLE_NAME)</string>
 	<key>CFBundleIdentifier</key>
-	<string>com.8bit.bitwarden.share-extension</string>
+	<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
 	<key>CFBundleDevelopmentRegion</key>
 	<string>en</string>
 	<key>CFBundleExecutable</key>
@@ -17,9 +19,9 @@
 	<key>CFBundlePackageType</key>
 	<string>XPC!</string>
 	<key>CFBundleShortVersionString</key>
-	<string>2023.7.1</string>
+	<string>$(MARKETING_VERSION)</string>
 	<key>CFBundleVersion</key>
-	<string>1</string>
+	<string>$(CURRENT_PROJECT_VERSION)</string>
 	<key>NSExtension</key>
 	<dict>
 		<key>NSExtensionMainStoryboard</key>

Configs/Bitwarden-Debug.xcconfig

@@ -0,0 +1,8 @@
+#include "./Common.xcconfig"
+#include? "./Local.xcconfig"
+
+ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon-Dev
+CODE_SIGN_ENTITLEMENTS = Bitwarden/Application/Support/Bitwarden.entitlements
+FIREBASE_CONFIG_FILENAME = GoogleService-Info.plist
+PRODUCT_BUNDLE_IDENTIFIER = $(ORGANIZATION_IDENTIFIER).bitwarden
+SWIFT_ACTIVE_COMPILATION_CONDITIONS = $(inherited) PREVIEWS

Configs/Bitwarden-Release.xcconfig

@@ -0,0 +1,10 @@
+// Prevents Xcodegen from overriding the CODE_SIGN_IDENTITY value from an included xcconfig.
+CODE_SIGN_IDENTITY = Apple Development
+
+#include "./Common.xcconfig"
+#include? "./Local.xcconfig"
+
+ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon
+CODE_SIGN_ENTITLEMENTS = Bitwarden/Application/Support/Bitwarden.entitlements
+FIREBASE_CONFIG_FILENAME = GoogleService-Info.plist
+PRODUCT_BUNDLE_IDENTIFIER = $(ORGANIZATION_IDENTIFIER).bitwarden

Configs/BitwardenActionExtension.xcconfig

@@ -0,0 +1,5 @@
+#include "./Common.xcconfig"
+#include? "./Local.xcconfig"
+
+PRODUCT_BUNDLE_IDENTIFIER = $(ORGANIZATION_IDENTIFIER).bitwarden.find-login-action-extension
+PROVISIONING_PROFILE_SPECIFIER = $(PROVISIONING_PROFILE_SPECIFIER_ACTION_EXTENSION)

Configs/BitwardenAutoFillExtension.xcconfig

@@ -0,0 +1,5 @@
+#include "./Common.xcconfig"
+#include? "./Local.xcconfig"
+
+PRODUCT_BUNDLE_IDENTIFIER = $(ORGANIZATION_IDENTIFIER).bitwarden.autofill
+PROVISIONING_PROFILE_SPECIFIER = $(PROVISIONING_PROFILE_SPECIFIER_AUTOFILL_EXTENSION)

Configs/BitwardenShareExtension.xcconfig

@@ -0,0 +1,5 @@
+#include "./Common.xcconfig"
+#include? "./Local.xcconfig"
+
+PRODUCT_BUNDLE_IDENTIFIER = $(ORGANIZATION_IDENTIFIER).bitwarden.share-extension
+PROVISIONING_PROFILE_SPECIFIER = $(PROVISIONING_PROFILE_SPECIFIER_SHARE_EXTENSION)

Configs/BitwardenShared.xcconfig

@@ -0,0 +1,4 @@
+#include "./Common.xcconfig"
+#include? "./Local.xcconfig"
+
+PRODUCT_BUNDLE_IDENTIFIER = $(ORGANIZATION_IDENTIFIER).bitwarden.bitwarden-shared

Configs/Common.xcconfig

@@ -0,0 +1,19 @@
+CODE_SIGN_STYLE = Automatic
+DEVELOPMENT_TEAM = LTZ2PFU5D6
+ORGANIZATION_IDENTIFIER = com.8bit
+
+// The above code signing settings can be overriden by adding a Local.xcconfig
+// file in the Configs directory.
+//
+// As an example, add the file Local.xcconfig with the following contents:
+//
+//    DEVELOPMENT_TEAM = <Your team ID>
+//    ORGANIZATION_IDENTIFIER = <Your reversed domain name>
+//    PROVISIONING_PROFILE_SPECIFIER = <Optional provisioning profile specifier for the main app>
+//    PROVISIONING_PROFILE_SPECIFIER_ACTION_EXTENSION = <Optional provisioning profile specifier for the action extension>
+//    PROVISIONING_PROFILE_SPECIFIER_AUTOFILL_EXTENSION = <Optional provisioning profile specifier for the autofill extension>
+//    PROVISIONING_PROFILE_SPECIFIER_SHARE_EXTENSION = <Optional provisioning profile specifier for the share extension>
+//
+// This should allow Xcode to build the application based on these settings without
+// code signing errors or having to modify the project itself.
+//

Scripts/update_settings_version_number.sh

@@ -6,7 +6,7 @@ set -e
 
 SETTINGS_BUNDLE_PATH="${CODESIGNING_FOLDER_PATH}/Settings.bundle/Root.plist"
 BUILD_VERSION=$(sed -n '/MARKETING_VERSION/{s/MARKETING_VERSION = //;s/;//;s/^[[:space:]]*//;p;q;}' "${PROJECT_FILE_PATH}/project.pbxproj")
-BUILD_NUMBER=$(/usr/libexec/PlistBuddy -c "Print CFBundleVersion" "${INFOPLIST_FILE}")
+BUILD_NUMBER=$(sed -n '/CURRENT_PROJECT_VERSION/{s/CURRENT_PROJECT_VERSION = //;s/;//;s/^[[:space:]]*//;p;q;}' "${PROJECT_FILE_PATH}/project.pbxproj")
 BUILD_STRING="${BUILD_VERSION} (${BUILD_NUMBER})"
 
 /usr/libexec/PlistBuddy -c "Set PreferenceSpecifiers:0:DefaultValue $BUILD_STRING" "${SETTINGS_BUNDLE_PATH}"

project.yml

@@ -3,7 +3,6 @@ configs:
   Debug: debug
   Release: release
 options:
-  bundleIdPrefix: com.8bit
   createIntermediateGroups: true
   deploymentTarget:
     iOS: 15.0
@@ -91,6 +90,12 @@ targets:
   Bitwarden:
     type: application
     platform: iOS
+    configFiles:
+      Debug: Configs/Bitwarden-Debug.xcconfig
+      Release: Configs/Bitwarden-Release.xcconfig
+    settings:
+      base:
+        INFOPLIST_FILE: Bitwarden/Application/Support/Info.plist
     sources:
       - path: Bitwarden
         excludes:
@@ -116,11 +121,6 @@ targets:
       - target: BitwardenShareExtension
       - package: Firebase
         product: FirebaseCrashlytics
-    settings:
-      base:
-        PRODUCT_BUNDLE_IDENTIFIER: com.8bit.bitwarden
-        INFOPLIST_FILE: Bitwarden/Application/Support/Info.plist
-        CODE_SIGN_ENTITLEMENTS: Bitwarden/Application/Support/Bitwarden.entitlements
     preBuildScripts:
       - path: Scripts/update_acknowledgements.sh
         name: "Settings.bundle: Update Acknowledgements"
@@ -161,11 +161,13 @@ targets:
   BitwardenActionExtension:
     type: app-extension
     platform: iOS
+    configFiles:
+      Debug: Configs/BitwardenActionExtension.xcconfig
+      Release: Configs/BitwardenActionExtension.xcconfig
     settings:
       base:
-        PRODUCT_BUNDLE_IDENTIFIER: com.8bit.bitwarden.find-login-action-extension
-        INFOPLIST_FILE: BitwardenActionExtension/Application/Support/Info.plist
         CODE_SIGN_ENTITLEMENTS: BitwardenActionExtension/Application/Support/BitwardenActionExtension.entitlements
+        INFOPLIST_FILE: BitwardenActionExtension/Application/Support/Info.plist
     sources:
       - path: BitwardenActionExtension
         excludes:
@@ -195,11 +197,13 @@ targets:
   BitwardenAutoFillExtension:
     type: app-extension
     platform: iOS
+    configFiles:
+      Debug: Configs/BitwardenAutoFillExtension.xcconfig
+      Release: Configs/BitwardenAutoFillExtension.xcconfig
     settings:
       base:
-        PRODUCT_BUNDLE_IDENTIFIER: com.8bit.bitwarden.autofill
-        INFOPLIST_FILE: BitwardenAutoFillExtension/Application/Support/Info.plist
         CODE_SIGN_ENTITLEMENTS: BitwardenAutoFillExtension/Application/Support/BitwardenAutoFill.entitlements
+        INFOPLIST_FILE: BitwardenAutoFillExtension/Application/Support/Info.plist
     sources:
       - path: BitwardenAutoFillExtension
         excludes:
@@ -229,11 +233,13 @@ targets:
   BitwardenShareExtension:
     type: app-extension
     platform: iOS
+    configFiles:
+      Debug: Configs/BitwardenShareExtension.xcconfig
+      Release: Configs/BitwardenShareExtension.xcconfig
     settings:
       base:
-        PRODUCT_BUNDLE_IDENTIFIER: com.8bit.bitwarden.share-extension
-        INFOPLIST_FILE: BitwardenShareExtension/Application/Support/Info.plist
         CODE_SIGN_ENTITLEMENTS: BitwardenShareExtension/Application/Support/BitwardenShareExtension.entitlements
+        INFOPLIST_FILE: BitwardenShareExtension/Application/Support/Info.plist
     sources:
       - path: BitwardenShareExtension
         excludes:
@@ -263,6 +269,9 @@ targets:
   BitwardenShared:
     type: framework
     platform: iOS
+    configFiles:
+      Debug: Configs/BitwardenShared.xcconfig
+      Release: Configs/BitwardenShared.xcconfig
     settings:
       base:
         APPLICATION_EXTENSION_API_ONLY: true