add-sftp-user/manifest.jps

162 lines
5.4 KiB
Plaintext
Raw Normal View History

2023-10-26 15:54:56 +00:00
type: update
name: Add SFTP User
2023-10-27 15:22:09 +00:00
2023-10-26 15:54:56 +00:00
targetNodes:
nodeGroup: cp
settings:
sfpform:
fields:
- type: string
inputType: text
name: root_directory
caption: Root Directory
2023-10-30 16:13:29 +00:00
default: "/var/www/webroot/ROOT/"
description: "A user-specific directory will be created under this path."
2023-10-30 16:13:29 +00:00
required: false
2023-10-26 15:54:56 +00:00
- type: checkbox
name: enable_ssh
caption: Also enable SSH access
default: false
2023-10-31 17:59:37 +00:00
manageUserForm:
fields:
- type: string
inputType: text
name: manage_username
caption: Username to Manage
description: "Input the username you want to manage."
required: true
2023-10-26 15:54:56 +00:00
globals:
2023-10-30 17:09:45 +00:00
username: "user${fn.random(10000,99999)}"
password: ${fn.password(min)}
2023-10-26 15:54:56 +00:00
sftpHost: ${env.domain}
sftpPort: 22
onInstall:
2023-10-30 12:52:48 +00:00
- cmd[cp]: mkdir -p /home/jelastic/add-sftp-user-addon/
- cmd[cp]: mkdir -p /home/jelastic/add-sftp-user-addon/logs
2023-10-30 12:52:48 +00:00
- cmd[cp]: wget https://deploy-proxy.mightybox.io/addons/add-sftp-user/raw/branch/main/add-sftp.sh -O /home/jelastic/add-sftp-user-addon/add-sftp.sh
- cmd[cp]: chmod +x /home/jelastic/add-sftp-user-addon/*.sh
- cmd[cp]:
commands:
- echo -e "\nMatch User user*\nPasswordAuthentication yes" >> /etc/ssh/sshd_config
user: root
- cmd[cp]:
commands:
- systemctl restart sshd
user: root
2023-10-30 13:21:51 +00:00
- api: environment.control.RestartContainer
2023-10-30 13:27:05 +00:00
nodeGroup: cp
nodeid: ${nodes.cp.id}
2023-10-27 15:17:35 +00:00
- return: installSuccess
2023-10-26 15:54:56 +00:00
actions:
add_sftp_user:
- cmd[cp]: # Use cmd action to check if user exists
commands: id ${globals.username} || echo "User not found"
- if ("${response.out}" == "User not found"): # If user doesn't exist
- cmd[cp]:
commands: bash /home/jelastic/add-sftp-user-addon/add-sftp.sh ${globals.username} ${globals.password}
user: root
- switch ("${response.exitStatus}"):
0:
return: sftpSuccess
2:
return: rootDirectoryError
3:
return: userExistsError
4:
return: createUserError
5:
return: symlinkError
6:
return: modifyGroupError
default:
return: unknownError
- else:
- setGlobals:
username: "user${fn.random(10000,99999)}"
- cmd[cp]: # Check again with the new username
commands: id ${globals.username} || echo "User not found"
- if ("${response.out}" != "User not found"):
return: userExistsError
2023-10-31 17:59:37 +00:00
- return: sftpSuccess
change_password:
- cmd[cp]:
commands:
- echo "${settings.manage_username}:${globals.password}" | chpasswd
- echo "Password changed for ${settings.manage_username}" >> /home/jelastic/add-sftp-user-addon/logs/script_output.log
user: root
- if ("${response.exitStatus}" != "0"):
return: passwordChangeError
- return: passwordChangeSuccess
delete_user:
- cmd[cp]:
commands:
- userdel ${settings.manage_username}
- echo "User ${settings.manage_username} deleted" >> /home/jelastic/add-sftp-user-addon/logs/script_output.log
user: root
- if ("${response.exitStatus}" != "0"):
return: deleteUserError
- return: deleteUserSuccess
2023-10-27 14:37:19 +00:00
responses:
2023-10-27 15:17:35 +00:00
installSuccess:
2023-10-27 16:31:40 +00:00
type: success
2023-10-27 15:17:35 +00:00
message: "Installed Successfully"
2023-10-30 13:13:03 +00:00
sftpError:
type: error
message: "Failed to add SFTP user. Please check the server logs for more details."
2023-10-31 17:59:37 +00:00
sftpSuccess:
type: success
message: "Connection Details\n\nSFTP Host: ${globals.sftpHost}\n\nPort: ${globals.sftpPort}\n\nLogin Credentials\n\nUsername: ${globals.username}\n\nPassword: ${globals.password}"
passwordChangeError:
type: error
message: "Failed to change password for ${settings.manage_username}. Check logs for details."
passwordChangeSuccess:
type: success
message: "Password changed successfully for ${settings.manage_username}.\n\n New password: ${globals.password}"
deleteUserError:
type: error
message: "Failed to delete user ${settings.manage_username}. Check logs for details."
deleteUserSuccess:
type: success
message: "User ${settings.manage_username} deleted successfully."
rootDirectoryError:
type: error
message: "ROOT_DIRECTORY does not exist. Please check the server logs for more details."
symlinkError:
type: error
message: "Failed to create symlink for the user. Check logs for details."
modifyGroupError:
type: error
message: "Failed to modify groups for the user. Check logs for details."
unknownError:
type: error
message: "An unknown error occurred. Please check the server logs for more details."
2023-10-26 15:54:56 +00:00
buttons:
- settings: sfpform
action: add_sftp_user
caption: Add SFTP/SSH User
2023-10-31 17:59:37 +00:00
confirmText: "Are you sure you want to add this SFTP user?"
- settings: manageUserForm
action: change_password
caption: Change Password
confirmText: "Are you sure you want to change the password for this user?"
- settings: manageUserForm
action: delete_user
caption: Delete User
confirmText: "Are you sure you want to delete this user?"
onUninstall:
- cmd[cp]:
commands:
- rm -vf /home/jelastic/add-sftp-user-addon/add-sftp.sh
- rm -vf /home/jelastic/add-sftp-user-addon/logs/script_output.log
- rmdir -v /home/jelastic/add-sftp-user-addon/logs/
- rmdir -v /home/jelastic/add-sftp-user-addon/
user: root