Skip to content
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.

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

Connect video server #159

Open
wants to merge 6 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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 index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,10 @@ include::zimbra-connect-guide.adoc[]

<<<

include::zimbra-connect-videoserver.adoc[]

<<<

ifndef::z9[]
:leveloffset: -1
include::zimbra-drive-open-guide.adoc[]
Expand Down
100 changes: 98 additions & 2 deletions ng-mobile.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ User-level settings override COS-level settings.
[[mobile-passwords-and-you]]
=== Mobile Passwords and You

The `Mobile Password` feature allows Global and Delegated Admins to set an additional password for an account to be used for Exchange ActiveSync authentications only.
The `Mobile Password` feature allows to set an additional password for an account to be used for Exchange ActiveSync authentications only.

The main benefits of using this feature are:

Expand All @@ -118,10 +118,74 @@ The main benefits of using this feature are:

A `Mobile Password` will not be valid for Webmail/POP3/IMAP/SMTP logins, and the account password will not be valid for mobile logins.

== Data Storage
Both Mobile Passwords and QR Code data is saved in a local HSQL database.

All passwords, tokens and sensitive information are stored in hashed form using the SHA256 algorithm using auto-generated keys and no credential or sensitive information is ever stored cleartext.

[[how-to-set-a-mobile-password-for-a-mailbox]]
=== How to Set a Mobile Password for a Mailbox

Setting a mobile password is easy:
**Zimbra 8.8.15 patch 16+, 9.0.0 patch9+ (Classic UI)**
Starting from Zimbra 8.8.15p16 and 9.0.0p9, Mobile Passwords are now managed by the user via the new Auth Zimlet, which can be installed by running `zxsuite auth doDeployAuthZimlet`.

TIP: This new Mobile Password management system allows the user to set multiple independent Mobile Passwords for an account, to be used with different devices.

Once the Zimlet is deployed and enabled, the user can create a new Mobile Password following this steps:

* Open the Zextras Auth Zimlet and click on "New Password";
* Enter an easy to remember identifier for the password in the "Password Label" field and select "Text code" as the Password Type;
* Click "Next";
* The new Mobile Password will be displayed;

WARNING: Mobile Passwords are randomly generated and cannot be displayed again after the creation is complete.

* Click on "Done" to close the Zextras Auth window. An entry for the new Mobile Password is now visible in the "Active Passwords" list of the Zextras Auth Zimlet.

Admins can also create a Mobile Password from the CLI, use the `zxsuite auth credential` command with the following attributes:

* password: enter the password you wish to set as the Mobile Password
* label: enter the label for the Mobile Password
* service: use `eas` to set a Mobile Password

E.g.
To add the `gn89hg95hvmn59..]` Mobile Password to the `[email protected]` account, labeled as "Personal Phone", run:

`zxsuite auth credential add [email protected] password "gn89hg95hvmn59..]" label "Personal Phone" service eas`

The system will confirm the success of the operation and display all the password's information:

----
Credential correctly added

values
generated 0
created 1603120995372
label Personal Phone
id Fr2jM
services

service EAS
hash +Crk6YcPL7IapCg6xfT6oXWP977uTeZdJTVQDQZd+Io=
enabled true
algorithm SHA256
text_data
auth_method password
password gn89hg95hvmn59..]
user [email protected]
----

=== List existing Mobile Passwords
Any user can see the list of active Mobile Passwords in the Zextras Auth Zimlet. Each entry of the list displays the label of the password, its status, the service it is valid for and its creation date.

Specifically, all passwords valid for the "EAS" service are Mobile Passwords.

System Administrators, on the other hand, can view an extended list of all credentials, including Mobile Passwords,

=== Editing a Mobile Password
While a Mobile Password itself cannot be edited, the System Administrator can edit its label and properties using the `zxsuite auth credential update command`

**versions up to 8.8.15 patch15 and 9.0.0 patch8**

* Open the Zimbra Administration Console.
* Right-click the user for which you want to set a Mobile Password and select `Edit`.
Expand All @@ -130,6 +194,38 @@ Setting a mobile password is easy:
You can also choose to generate a random mobile password by clicking btn:[Generate random password].
* btn:[Save].

== Application Password (QR Code)

The Auth Zimlet can speed up and manage Application logins, such as those for the Drive and Team/Connect apps made by Zextras.

This is achieved through the creation of a QR Code in the Zimbra WebClient, which the user can then scan from the App's login page to log in.

WARNING: QR Codes are a one-time credential only, meaning that once generated it will grant access to the app until the relevant credential itself is deleted from the account.
Once generated, the QR Code can only be viewed once.

=== QR Code Requirements
The QR Code Application Password feature requires the following properties to be set at domain level in order to be functional:

* `zimbraPublicServiceHostname`
* `zimbraPublicServicePort`
* `zimbraPublicServiceProtocol`

Should one or more of the properties be unset, a notification will be delivered to the Admin reporting the affected domains and their missing properties.

=== Creating a new QR Code Credential
While, as all credentials, QR Codes can be created from both the Zextras Auth Zimlet and Zextras CLI, only the former allows the user to use the QR code itself so the latter will not be taken into consideration in this guide.

==== Creating a QR Code Credential from the Zextras Auth Zimlet
To create a new QR Code, open the Auth Zimlet and click on "New Password";:

* Enter an easy to remember identifier for the password in the "Password Label" field and select "QR code" as the Password Type;
* Click "Next";
* The new QR Code will be displayed;

WARNING: QR Codes are randomly generated and cannot be displayed again after the creation is complete.

* Click on "Done" to close the Auth Zimlet. An entry for the new QR Code is now visible in the "Active Passwords" list of the Auth Zimlet.

[[mobile-device-management-a.k.a.-mobile-provisioning]]
== Mobile Device Management a.k.a. Mobile Provisioning

Expand Down
Loading