zii/MRCI
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
8a06b5a186
MRCI/docs/intern_commands.md
Maurice ONeal 80d493ad16 Few Updates to SSL Cert Handling 
- SSL certs are no longer stored in the host database. This was
  done not only for security reasons but there is simply no need
  to do such thing anymore.

- The host will longer support multiple SSL certs and will instead
  have just a single cert for all TCP connections. This required a
  change to the client header format that simply replaced the the
  common name with padding. The host will also no longer send the
  HOST_CERT type id during session initialization. HOST_CERT was
  also removed as a type id.

- The cert and privite key are now pointed to files in the local
  file system by the environment variables: MRCI_PRIV_KEY and
  MRCI_PUB_KEY.

- The host will still create a default self-signed cert if a valid
  cert and private key is not defined in the above environmental
  vars. Since the host only support single certs now, the default
  cert needed to be expanded to include subject alternative names.
  The host will try to detect it's WAN ip address using ipify.org
  and then assign SANs for all detected local LAN interfaces.

- Since the cert is now handled by environmental vars and nothing
  related to it stored in the database, all the core commands
  related to cert management were removed.
2020-04-05 15:51:11 -04:00

7.6 KiB
Raw Blame History

7.1 Internal Commands

The host is extendable via 3rd party modules but the host itself is an internal module that load commands with direct access to the host database.

  • accept_ch - accept an invite to a channel to become a regular member of it.

  • add_acct - create a new host user account.

  • add_ch - create a new channel.

  • add_mod - add a new module to the host.

  • add_ranked_cmd - assign a rank to a module's command name.

  • add_rdonly_flag - add a read only flag to a certain sub-channel and privilege level.

  • add_sub_ch - create a new sub-channel within a channel.

  • auth - login to the host using a registered user account name or email address.

  • cast - broadcast data to all sessions listening to any matching sub-channels.

  • ch_owner_override - set/unset the channel owner override flag for your current session.

  • close_host - close the host instance.

  • close_sub_ch - close a sub-channel for your current session.

  • decline_ch - decline an invite to a channel.

  • find_ch - search for channels within the host based on the channel name or channel id.

  • force_set_email - overwrite/change the email address of another user's account.

  • fs_cd - display or change the current directory for the current session.

  • fs_copy - copy a file or directory in the host file system.

  • fs_delete - delete a file or directory in the host file system.

  • fs_download - download a single file from the host.

  • fs_info - get detailed information about a file in the host file system.

  • fs_list - list all files or sub-directories in a directory.

  • fs_mkpath - attempt to create a directory and all sub-directories of a given path.

  • fs_move - move/rename a file or directory in the host file system.

  • fs_tree - list all files and sub-directories of an entire directory tree.

  • fs_upload - upload a single file to the host.

  • host_config - view/change various host settings.

  • host_info - display system information about the host.

  • invite_to_ch - invite a host user to join a channel.

  • is_email_verified - check if your email address is verified.

  • lock_acct - lock a user account.

  • ls_act_log - display or manage the client activity log.

  • ls_auth_log - display the host authorization activity log.

  • ls_ch_members - list all members in a channel.

  • ls_chs - list all channels you are currently a member of and all pending invites.

  • ls_dbg - display all debug log messages.

  • ls_mods - list all available modules currently configured in the host.

  • ls_open_chs - list all of the sub-channels that are currently open.

  • ls_p2p - list all p2p connections and pending p2p request you currently have.

  • ls_ranked_cmds - list all module commands with assigned host ranks.

  • ls_rdonly_flags - list all read only flags currently present for a channel.

  • ls_sub_chs - list all sub-channels within a channel.

  • ls_users - list all users currently registered in the host database.

  • my_info - display information about your current session and your account.

  • open_sub_ch - open a sub-channel to send/receive broadcasted data to/from peers.

  • p2p_close - close the p2p connection with the peer given in this command or decline a p2p request.

  • p2p_open - accept the p2p request you may have received from another peer connected to the host.

  • p2p_request - send out a p2p request to the peer session id given in this command.

  • ping_peers - ping all peer sessions with any matching sub-channels to return information about themselves to you.

  • preview_email - preview the confirmation or password reset emails with dummy values.

  • recover_acct - login to a user account using a temporary password.

  • remove_ch_member - remove a user as a member of a channel you currently a member of or cancel an invite.

  • rename_ch - rename a channel.

  • rename_sub_ch - rename a sub-channel within a channel.

  • request_new_pw - enable/disable a password change request for a user on next login.

  • request_new_user_name - enable/disable a user name change request for a user on next login.

  • request_pw_reset - request a password reset for a user account.

  • restart_host - re-start the host instance.

  • rm_acct - delete a user account from the host database.

  • rm_ch - permanently remove a channel and all of it's sub-shannels from the host.

  • rm_mod - remove a module from the host.

  • rm_ranked_cmd - remove a rank from a module command name.

  • rm_rdonly_flag - remove a read only flag from a certain sub-channel privilege level combination.

  • rm_sub_ch - remove a sub-channel within a channel.

  • set_active_flag - set or unset the active update flag of a sub-channel.

  • set_disp_name - change your account display name.

  • set_email - set the user account email address.

  • set_email_template - set the email template used by the host to send emails for user account resets and confirmations.

  • set_member_level - set the user privilege levels of a channel member.

  • set_pw - update your account password.

  • set_sub_ch_level - set the lowest privilege level that members need to be in order to open a certain sub-channel.

  • set_user_name - change your account user name.

  • set_user_rank - change a user account's host rank.

  • to_peer - send/receive any data directly with a client connected to the host.

  • verify_email - verify your email address by sending a confirmation code to it.