Merge a6b4392fd7549f23fef1faaaa146c5408011d7c5 into eeacb488ad7157b6c515f807a9b28f22517ce09c

see #790

Dockerfile

@@ -1,6 +1,6 @@
 ARG SIGNAL_CLI_VERSION=0.14.1
 ARG LIBSIGNAL_CLIENT_VERSION=0.87.4
-ARG SIGNAL_CLI_NATIVE_PACKAGE_VERSION=0.14.1+morph027+1
+ARG SIGNAL_CLI_NATIVE_PACKAGE_VERSION=0.14.1+morph027+2
 
 ARG SWAG_VERSION=1.16.4
 ARG GRAALVM_VERSION=25.0.2

entrypoint.sh

@@ -4,40 +4,57 @@ set -x
 set -e
 
 [ -z "${SIGNAL_CLI_CONFIG_DIR}" ] && echo "SIGNAL_CLI_CONFIG_DIR environmental variable needs to be set! Aborting!" && exit 1;
+[ -z "${SIGNAL_CLI_UID}" ] && echo "SIGNAL_CLI_UID environmental variable needs to be set! Aborting!" && exit 1;
+[ -z "${SIGNAL_CLI_GID}" ] && echo "SIGNAL_CLI_GID environmental variable needs to be set! Aborting!" && exit 1;
 
-usermod -u ${SIGNAL_CLI_UID} signal-api
-groupmod -o -g ${SIGNAL_CLI_GID} signal-api
-
-# Fix permissions to ensure backward compatibility if SIGNAL_CLI_CHOWN_ON_STARTUP is not set to "false"
-if [ "$SIGNAL_CLI_CHOWN_ON_STARTUP" != "false" ]; then
-  echo "Changing ownership of ${SIGNAL_CLI_CONFIG_DIR} to ${SIGNAL_CLI_UID}:${SIGNAL_CLI_GID}"
-  chown ${SIGNAL_CLI_UID}:${SIGNAL_CLI_GID} -R ${SIGNAL_CLI_CONFIG_DIR}
-else
-  echo "Skipping chown on startup since SIGNAL_CLI_CHOWN_ON_STARTUP is set to 'false'"
+# Check if we are already running as the target user and group
+RUNNING_AS_TARGET_USER=false
+if [ "$(id -u)" -eq "${SIGNAL_CLI_UID}" ] && [ "$(id -g)" -eq "${SIGNAL_CLI_GID}" ]; then
+  RUNNING_AS_TARGET_USER=true
 fi
 
-# Show warning on docker exec
-cat <<EOF >> /root/.bashrc
+if [ "$RUNNING_AS_TARGET_USER" = "true" ]; then
+  echo "Already running as UID ${SIGNAL_CLI_UID} and GID ${SIGNAL_CLI_GID}. Skipping privileged operations."
+else
+  echo "Adjusting user and group IDs to ${SIGNAL_CLI_UID}:${SIGNAL_CLI_GID}"
+  usermod -u "${SIGNAL_CLI_UID}" signal-api
+  groupmod -o -g "${SIGNAL_CLI_GID}" signal-api
+
+  # Fix permissions to ensure backward compatibility if SIGNAL_CLI_CHOWN_ON_STARTUP is not set to "false"
+  if [ "$SIGNAL_CLI_CHOWN_ON_STARTUP" != "false" ]; then
+    echo "Changing ownership of ${SIGNAL_CLI_CONFIG_DIR} to ${SIGNAL_CLI_UID}:${SIGNAL_CLI_GID}"
+    chown "${SIGNAL_CLI_UID}":"${SIGNAL_CLI_GID}" -R "${SIGNAL_CLI_CONFIG_DIR}"
+  else
+    echo "Skipping chown on startup since SIGNAL_CLI_CHOWN_ON_STARTUP is set to 'false'"
+  fi
+
+  # Show warning on docker exec
+  cat <<EOF >> /root/.bashrc
 echo "WARNING: signal-cli-rest-api runs as signal-api (not as root!)" 
 echo "Run 'su signal-api' before using signal-cli!"
 echo "If you want to use signal-cli directly, don't forget to specify the config directory. e.g: \"signal-cli --config ${SIGNAL_CLI_CONFIG_DIR}\""
 EOF
-
-cap_prefix="-cap_"
-caps="$cap_prefix$(seq -s ",$cap_prefix" 0 $(cat /proc/sys/kernel/cap_last_cap))"
+fi
 
 # TODO: check mode
-if [ "$MODE" = "json-rpc" ]
-then
-/usr/bin/jsonrpc2-helper
-if [ -n "$JAVA_OPTS" ] ; then
-    echo "export JAVA_OPTS='$JAVA_OPTS'" >> /etc/default/supervisor
-fi
-service supervisor start
-supervisorctl start all
+if [ "$MODE" = "json-rpc" ]; then
+  /usr/bin/jsonrpc2-helper
+  if [ -n "$JAVA_OPTS" ]; then
+      echo "export JAVA_OPTS='$JAVA_OPTS'" >> /etc/default/supervisor
+  fi
+  service supervisor start
+  supervisorctl start all
 fi
 
 export HOST_IP=$(hostname -I | awk '{print $1}')
 
 # Start API as signal-api user
-exec setpriv --reuid=${SIGNAL_CLI_UID} --regid=${SIGNAL_CLI_GID} --init-groups --inh-caps=$caps signal-cli-rest-api -signal-cli-config=${SIGNAL_CLI_CONFIG_DIR}
+if [ "$RUNNING_AS_TARGET_USER" = "true" ]; then
+  # Already running as the target user, start directly
+  exec signal-cli-rest-api -signal-cli-config="${SIGNAL_CLI_CONFIG_DIR}"
+else
+  # Use setpriv to switch to target user
+  cap_prefix="-cap_"
+  caps="$cap_prefix$(seq -s ",$cap_prefix" 0 $(cat /proc/sys/kernel/cap_last_cap))"
+  exec setpriv --reuid="${SIGNAL_CLI_UID}" --regid="${SIGNAL_CLI_GID}" --init-groups --inh-caps="$caps" signal-cli-rest-api -signal-cli-config="${SIGNAL_CLI_CONFIG_DIR}"
+fi

src/api/api.go

@@ -1024,6 +1024,7 @@ func (a *Api) RemoveAdminsFromGroup(c *gin.Context) {
 // @Success 200 {object} []client.GroupEntry
 // @Failure 400 {object} Error
 // @Param number path string true "Registered Phone Number"
+// @Param use_only_uuid_as_identifier query bool false "Use UUIDs instead of phone numbers as identifier for (pending|requesting) members"
 // @Router /v1/groups/{number} [get]
 func (a *Api) GetGroups(c *gin.Context) {
 	number, err := url.PathUnescape(c.Param("number"))
@@ -1032,7 +1033,13 @@ func (a *Api) GetGroups(c *gin.Context) {
 		return
 	}
 
-	groups, err := a.signalClient.GetGroups(number)
+	useOnlyUuidAsIdentifier := c.DefaultQuery("use_only_uuid_as_identifier", "false")
+	if useOnlyUuidAsIdentifier != "true" && useOnlyUuidAsIdentifier != "false" {
+		c.JSON(400, Error{Msg: "Couldn't process request - use_only_uuid_as_identifier parameter needs to be either 'true' or 'false'"})
+		return
+	}
+
+	groups, err := a.signalClient.GetGroups(number, StringToBool(useOnlyUuidAsIdentifier))
 	if err != nil {
 		c.JSON(400, Error{Msg: err.Error()})
 		return
@@ -1050,6 +1057,7 @@ func (a *Api) GetGroups(c *gin.Context) {
 // @Failure 400 {object} Error
 // @Param number path string true "Registered Phone Number"
 // @Param groupid path string true "Group ID"
+// @Param use_only_uuid_as_identifier query bool false "Use UUIDs instead of phone numbers as identifier for (pending|requesting) members"
 // @Router /v1/groups/{number}/{groupid} [get]
 func (a *Api) GetGroup(c *gin.Context) {
 	number, err := url.PathUnescape(c.Param("number"))
@@ -1059,7 +1067,13 @@ func (a *Api) GetGroup(c *gin.Context) {
 	}
 	groupId := c.Param("groupid")
 
-	groupEntry, err := a.signalClient.GetGroup(number, groupId)
+	useOnlyUuidAsIdentifier := c.DefaultQuery("use_only_uuid_as_identifier", "false")
+	if useOnlyUuidAsIdentifier != "true" && useOnlyUuidAsIdentifier != "false" {
+		c.JSON(400, Error{Msg: "Couldn't process request - use_only_uuid_as_identifier parameter needs to be either 'true' or 'false'"})
+		return
+	}
+
+	groupEntry, err := a.signalClient.GetGroup(number, groupId, StringToBool(useOnlyUuidAsIdentifier))
 	if err != nil {
 		c.JSON(400, Error{Msg: err.Error()})
 		return

src/client/client.go

@@ -341,6 +341,18 @@ func getSignalCliModeString(signalCliMode SignalCliMode) string {
 	return "unknown"
 }
 
+func pickGroupMemberIdentifier(number string, uuid string, useOnlyUuidAsIdentifier bool) string {
+	if useOnlyUuidAsIdentifier {
+		return uuid
+	}
+
+	if number != "" {
+		return number
+	}
+
+	return uuid
+}
+
 func getRecipientType(s string) (ds.RecpType, error) {
 	// check if the provided recipient is of type 'group'
 	if strings.HasPrefix(s, groupPrefix) { // if the recipient starts with 'group.' it is either a group or a username that starts with 'group.'
@@ -1181,7 +1193,7 @@ func (s *SignalClient) updateGroupMembers(number string, groupId string, members
 		return nil
 	}
 
-	group, err := s.GetGroup(number, groupId)
+	group, err := s.GetGroup(number, groupId, false)
 	if err != nil {
 		return err
 	}
@@ -1243,7 +1255,7 @@ func (s *SignalClient) updateGroupAdmins(number string, groupId string, admins [
 		return nil
 	}
 
-	group, err := s.GetGroup(number, groupId)
+	group, err := s.GetGroup(number, groupId, false)
 	if err != nil {
 		return err
 	}
@@ -1300,7 +1312,7 @@ func (s *SignalClient) RemoveAdminsFromGroup(number string, groupId string, admi
 	return s.updateGroupAdmins(number, groupId, admins, false)
 }
 
-func (s *SignalClient) GetGroups(number string) ([]GroupEntry, error) {
+func (s *SignalClient) GetGroups(number string, useOnlyUuidAsIdentifier bool) ([]GroupEntry, error) {
 	groupEntries := []GroupEntry{}
 
 	var signalCliGroupEntries []SignalCliGroupEntry
@@ -1341,40 +1353,28 @@ func (s *SignalClient) GetGroups(number string) ([]GroupEntry, error) {
 
 		members := []string{}
 		for _, val := range signalCliGroupEntry.Members {
-			identifier := val.Number
-			if identifier == "" {
-				identifier = val.Uuid
-			}
+			identifier := pickGroupMemberIdentifier(val.Number, val.Uuid, useOnlyUuidAsIdentifier)
 			members = append(members, identifier)
 		}
 		groupEntry.Members = members
 
 		pendingMembers := []string{}
 		for _, val := range signalCliGroupEntry.PendingMembers {
-			identifier := val.Number
-			if identifier == "" {
-				identifier = val.Uuid
-			}
+			identifier := pickGroupMemberIdentifier(val.Number, val.Uuid, useOnlyUuidAsIdentifier)
 			pendingMembers = append(pendingMembers, identifier)
 		}
 		groupEntry.PendingInvites = pendingMembers
 
 		requestingMembers := []string{}
 		for _, val := range signalCliGroupEntry.RequestingMembers {
-			identifier := val.Number
-			if identifier == "" {
-				identifier = val.Uuid
-			}
+			identifier := pickGroupMemberIdentifier(val.Number, val.Uuid, useOnlyUuidAsIdentifier)
 			requestingMembers = append(requestingMembers, identifier)
 		}
 		groupEntry.PendingRequests = requestingMembers
 
 		admins := []string{}
 		for _, val := range signalCliGroupEntry.Admins {
-			identifier := val.Number
-			if identifier == "" {
-				identifier = val.Uuid
-			}
+			identifier := pickGroupMemberIdentifier(val.Number, val.Uuid, useOnlyUuidAsIdentifier)
 			admins = append(admins, identifier)
 		}
 		groupEntry.Admins = admins
@@ -1387,9 +1387,9 @@ func (s *SignalClient) GetGroups(number string) ([]GroupEntry, error) {
 	return groupEntries, nil
 }
 
-func (s *SignalClient) GetGroup(number string, groupId string) (*GroupEntry, error) {
+func (s *SignalClient) GetGroup(number string, groupId string, useOnlyUuidAsIdentifier bool) (*GroupEntry, error) {
 	groupEntry := GroupEntry{}
-	groups, err := s.GetGroups(number)
+	groups, err := s.GetGroups(number, useOnlyUuidAsIdentifier)
 	if err != nil {
 		return nil, err
 	}

src/docs/docs.go

@@ -917,6 +917,12 @@ const docTemplate = `{
                         "name": "number",
                         "in": "path",
                         "required": true
+                    },
+                    {
+                        "type": "boolean",
+                        "description": "Use UUIDs instead of phone numbers as identifier for (pending|requesting) members",
+                        "name": "use_only_uuid_as_identifier",
+                        "in": "query"
                     }
                 ],
                 "responses": {
@@ -1010,6 +1016,12 @@ const docTemplate = `{
                         "name": "groupid",
                         "in": "path",
                         "required": true
+                    },
+                    {
+                        "type": "boolean",
+                        "description": "Use UUIDs instead of phone numbers as identifier for (pending|requesting) members",
+                        "name": "use_only_uuid_as_identifier",
+                        "in": "query"
                     }
                 ],
                 "responses": {

src/docs/swagger.json

@@ -914,6 +914,12 @@
                         "name": "number",
                         "in": "path",
                         "required": true
+                    },
+                    {
+                        "type": "boolean",
+                        "description": "Use UUIDs instead of phone numbers as identifier for (pending|requesting) members",
+                        "name": "use_only_uuid_as_identifier",
+                        "in": "query"
                     }
                 ],
                 "responses": {
@@ -1007,6 +1013,12 @@
                         "name": "groupid",
                         "in": "path",
                         "required": true
+                    },
+                    {
+                        "type": "boolean",
+                        "description": "Use UUIDs instead of phone numbers as identifier for (pending|requesting) members",
+                        "name": "use_only_uuid_as_identifier",
+                        "in": "query"
                     }
                 ],
                 "responses": {

src/docs/swagger.yaml

@@ -1163,6 +1163,11 @@ paths:
         name: number
         required: true
         type: string
+      - description: Use UUIDs instead of phone numbers as identifier for (pending|requesting)
+          members
+        in: query
+        name: use_only_uuid_as_identifier
+        type: boolean
       produces:
       - application/json
       responses:
@@ -1254,6 +1259,11 @@ paths:
         name: groupid
         required: true
         type: string
+      - description: Use UUIDs instead of phone numbers as identifier for (pending|requesting)
+          members
+        in: query
+        name: use_only_uuid_as_identifier
+        type: boolean
       produces:
       - application/json
       responses: