2015-08-11 20:45:07 +03:00
< ? php
use \OCA\Files_External\Lib\Backend\Backend ;
2020-04-09 17:14:31 +03:00
use \OCA\Files_External\Lib\Auth\AuthMechanism ;
use \OCA\Files_External\Lib\DefinitionParameter ;
use \OCA\Files_External\Service\BackendService ;
Authentication mechanisms for external storage backends
A backend can now specify generic authentication schemes that it
supports, instead of specifying the parameters for its authentication
method directly. This allows multiple authentication mechanisms to be
implemented for a single scheme, providing altered functionality.
This commit introduces the backend framework for this feature, and so at
this point the UI will be broken as the frontend does not specify the
required information.
Terminology:
- authentication scheme
Parameter interface for the authentication method. A backend
supporting the 'password' scheme accepts two parameters, 'user' and
'password'.
- authentication mechanism
Specific mechanism implementing a scheme. Basic mechanisms may
forward configuration options directly to the backend, more advanced
ones may lookup parameters or retrieve them from the session
New dropdown selector for external storage configurations to select the
authentication mechanism to be used.
Authentication mechanisms can have visibilities, just like backends.
The API was extended too to make it easier to add/remove visibilities.
In addition, the concept of 'allowed visibility' has been introduced, so
a backend/auth mechanism can force a maximum visibility level (e.g.
Local storage type) that cannot be overridden by configuration in the
web UI.
An authentication mechanism is a fully instantiated implementation. This
allows an implementation to have dependencies injected into it, e.g. an
\OCP\IDB for database operations.
When a StorageConfig is being prepared for mounting, the authentication
mechanism implementation has manipulateStorage() called,
which inserts the relevant authentication method options into the
storage ready for mounting.
2015-08-12 12:54:03 +03:00
2020-04-09 17:14:31 +03:00
$canCreateMounts = $_ [ 'visibilityType' ] === BackendService :: VISIBILITY_ADMIN || $_ [ 'allowUserMounting' ];
2016-08-09 15:09:53 +03:00
2016-04-06 14:15:54 +03:00
$l -> t ( " Enable encryption " );
$l -> t ( " Enable previews " );
$l -> t ( " Enable sharing " );
$l -> t ( " Check for changes " );
$l -> t ( " Never " );
$l -> t ( " Once every direct access " );
2018-02-27 16:06:14 +03:00
$l -> t ( 'Read only' );
2016-04-06 14:15:54 +03:00
2018-10-19 09:41:01 +03:00
script ( 'files_external' , [
'settings' ,
'templates'
]);
2015-09-14 15:57:49 +03:00
style ( 'files_external' , 'settings' );
// load custom JS
foreach ( $_ [ 'backends' ] as $backend ) {
2016-04-06 14:15:54 +03:00
/** @var Backend $backend */
2016-02-08 16:16:00 +03:00
$scripts = $backend -> getCustomJs ();
foreach ( $scripts as $script ) {
script ( 'files_external' , $script );
2015-09-14 15:57:49 +03:00
}
}
foreach ( $_ [ 'authMechanisms' ] as $authMechanism ) {
2016-02-08 16:16:00 +03:00
/** @var AuthMechanism $authMechanism */
$scripts = $authMechanism -> getCustomJs ();
foreach ( $scripts as $script ) {
script ( 'files_external' , $script );
2015-09-14 15:57:49 +03:00
}
}
Authentication mechanisms for external storage backends
A backend can now specify generic authentication schemes that it
supports, instead of specifying the parameters for its authentication
method directly. This allows multiple authentication mechanisms to be
implemented for a single scheme, providing altered functionality.
This commit introduces the backend framework for this feature, and so at
this point the UI will be broken as the frontend does not specify the
required information.
Terminology:
- authentication scheme
Parameter interface for the authentication method. A backend
supporting the 'password' scheme accepts two parameters, 'user' and
'password'.
- authentication mechanism
Specific mechanism implementing a scheme. Basic mechanisms may
forward configuration options directly to the backend, more advanced
ones may lookup parameters or retrieve them from the session
New dropdown selector for external storage configurations to select the
authentication mechanism to be used.
Authentication mechanisms can have visibilities, just like backends.
The API was extended too to make it easier to add/remove visibilities.
In addition, the concept of 'allowed visibility' has been introduced, so
a backend/auth mechanism can force a maximum visibility level (e.g.
Local storage type) that cannot be overridden by configuration in the
web UI.
An authentication mechanism is a fully instantiated implementation. This
allows an implementation to have dependencies injected into it, e.g. an
\OCP\IDB for database operations.
When a StorageConfig is being prepared for mounting, the authentication
mechanism implementation has manipulateStorage() called,
which inserts the relevant authentication method options into the
storage ready for mounting.
2015-08-12 12:54:03 +03:00
function writeParameterInput ( $parameter , $options , $classes = []) {
$value = '' ;
if ( isset ( $options [ $parameter -> getName ()])) {
$value = $options [ $parameter -> getName ()];
}
$placeholder = $parameter -> getText ();
$is_optional = $parameter -> isFlagSet ( DefinitionParameter :: FLAG_OPTIONAL );
switch ( $parameter -> getType ()) {
case DefinitionParameter :: VALUE_PASSWORD : ?>
2020-04-10 15:19:56 +03:00
< ? php if ( $is_optional ) {
$classes [] = 'optional' ;
} ?>
Authentication mechanisms for external storage backends
A backend can now specify generic authentication schemes that it
supports, instead of specifying the parameters for its authentication
method directly. This allows multiple authentication mechanisms to be
implemented for a single scheme, providing altered functionality.
This commit introduces the backend framework for this feature, and so at
this point the UI will be broken as the frontend does not specify the
required information.
Terminology:
- authentication scheme
Parameter interface for the authentication method. A backend
supporting the 'password' scheme accepts two parameters, 'user' and
'password'.
- authentication mechanism
Specific mechanism implementing a scheme. Basic mechanisms may
forward configuration options directly to the backend, more advanced
ones may lookup parameters or retrieve them from the session
New dropdown selector for external storage configurations to select the
authentication mechanism to be used.
Authentication mechanisms can have visibilities, just like backends.
The API was extended too to make it easier to add/remove visibilities.
In addition, the concept of 'allowed visibility' has been introduced, so
a backend/auth mechanism can force a maximum visibility level (e.g.
Local storage type) that cannot be overridden by configuration in the
web UI.
An authentication mechanism is a fully instantiated implementation. This
allows an implementation to have dependencies injected into it, e.g. an
\OCP\IDB for database operations.
When a StorageConfig is being prepared for mounting, the authentication
mechanism implementation has manipulateStorage() called,
which inserts the relevant authentication method options into the
storage ready for mounting.
2015-08-12 12:54:03 +03:00
< input type = " password "
< ? php if ( ! empty ( $classes )) : ?> class="<?php p(implode(' ', $classes)); ?>"<?php endif; ?>
data - parameter = " <?php p( $parameter->getName ()); ?> "
value = " <?php p( $value ); ?> "
placeholder = " <?php p( $placeholder ); ?> "
/>
< ? php
break ;
case DefinitionParameter :: VALUE_BOOLEAN : ?>
2015-09-17 18:39:27 +03:00
< ? php $checkboxId = uniqid ( " checkbox_ " ); ?>
2016-06-15 16:24:01 +03:00
< div >
< label >
2015-09-17 18:39:27 +03:00
< input type = " checkbox "
id = " <?php p( $checkboxId ); ?> "
2015-10-13 15:56:55 +03:00
< ? php if ( ! empty ( $classes )) : ?> class="checkbox <?php p(implode(' ', $classes)); ?>"<?php endif; ?>
2015-09-17 18:39:27 +03:00
data - parameter = " <?php p( $parameter->getName ()); ?> "
< ? php if ( $value === true ) : ?> checked="checked"<?php endif; ?>
/>
2016-06-15 16:24:01 +03:00
< ? php p ( $placeholder ); ?>
</ label >
</ div >
Authentication mechanisms for external storage backends
A backend can now specify generic authentication schemes that it
supports, instead of specifying the parameters for its authentication
method directly. This allows multiple authentication mechanisms to be
implemented for a single scheme, providing altered functionality.
This commit introduces the backend framework for this feature, and so at
this point the UI will be broken as the frontend does not specify the
required information.
Terminology:
- authentication scheme
Parameter interface for the authentication method. A backend
supporting the 'password' scheme accepts two parameters, 'user' and
'password'.
- authentication mechanism
Specific mechanism implementing a scheme. Basic mechanisms may
forward configuration options directly to the backend, more advanced
ones may lookup parameters or retrieve them from the session
New dropdown selector for external storage configurations to select the
authentication mechanism to be used.
Authentication mechanisms can have visibilities, just like backends.
The API was extended too to make it easier to add/remove visibilities.
In addition, the concept of 'allowed visibility' has been introduced, so
a backend/auth mechanism can force a maximum visibility level (e.g.
Local storage type) that cannot be overridden by configuration in the
web UI.
An authentication mechanism is a fully instantiated implementation. This
allows an implementation to have dependencies injected into it, e.g. an
\OCP\IDB for database operations.
When a StorageConfig is being prepared for mounting, the authentication
mechanism implementation has manipulateStorage() called,
which inserts the relevant authentication method options into the
storage ready for mounting.
2015-08-12 12:54:03 +03:00
< ? php
break ;
case DefinitionParameter :: VALUE_HIDDEN : ?>
< input type = " hidden "
< ? php if ( ! empty ( $classes )) : ?> class="<?php p(implode(' ', $classes)); ?>"<?php endif; ?>
data - parameter = " <?php p( $parameter->getName ()); ?> "
value = " <?php p( $value ); ?> "
/>
< ? php
break ;
default : ?>
2020-04-10 15:19:56 +03:00
< ? php if ( $is_optional ) {
$classes [] = 'optional' ;
} ?>
Authentication mechanisms for external storage backends
A backend can now specify generic authentication schemes that it
supports, instead of specifying the parameters for its authentication
method directly. This allows multiple authentication mechanisms to be
implemented for a single scheme, providing altered functionality.
This commit introduces the backend framework for this feature, and so at
this point the UI will be broken as the frontend does not specify the
required information.
Terminology:
- authentication scheme
Parameter interface for the authentication method. A backend
supporting the 'password' scheme accepts two parameters, 'user' and
'password'.
- authentication mechanism
Specific mechanism implementing a scheme. Basic mechanisms may
forward configuration options directly to the backend, more advanced
ones may lookup parameters or retrieve them from the session
New dropdown selector for external storage configurations to select the
authentication mechanism to be used.
Authentication mechanisms can have visibilities, just like backends.
The API was extended too to make it easier to add/remove visibilities.
In addition, the concept of 'allowed visibility' has been introduced, so
a backend/auth mechanism can force a maximum visibility level (e.g.
Local storage type) that cannot be overridden by configuration in the
web UI.
An authentication mechanism is a fully instantiated implementation. This
allows an implementation to have dependencies injected into it, e.g. an
\OCP\IDB for database operations.
When a StorageConfig is being prepared for mounting, the authentication
mechanism implementation has manipulateStorage() called,
which inserts the relevant authentication method options into the
storage ready for mounting.
2015-08-12 12:54:03 +03:00
< input type = " text "
< ? php if ( ! empty ( $classes )) : ?> class="<?php p(implode(' ', $classes)); ?>"<?php endif; ?>
data - parameter = " <?php p( $parameter->getName ()); ?> "
value = " <?php p( $value ); ?> "
placeholder = " <?php p( $placeholder ); ?> "
/>
< ? php
}
}
2015-08-11 20:45:07 +03:00
?>
2016-06-21 14:55:07 +03:00
2018-02-22 20:14:19 +03:00
< div id = " emptycontent " class = " hidden " >
< div class = " icon-external " ></ div >
2018-02-23 14:13:10 +03:00
< h2 >< ? php p ( $l -> t ( 'No external storage configured or you don\'t have the permission to configure them' )); ?> </h2>
2018-02-22 20:14:19 +03:00
</ div >
2016-08-09 15:19:15 +03:00
< form data - can - create = " <?php echo $canCreateMounts ?'true':'false' ?> " id = " files_external " class = " section " data - encryption - enabled = " <?php echo $_['encryptionEnabled'] ?'true': 'false'; ?> " >
2021-05-20 13:13:04 +03:00
< h2 class = " inlineblock " data - anchor - name = " external-storage " >< ? php p ( $l -> t ( 'External storage' )); ?> </h2>
2019-10-17 16:09:49 +03:00
< a target = " _blank " rel = " noreferrer " class = " icon-info " title = " <?php p( $l->t ('Open documentation'));?> " href = " <?php p(link_to_docs('admin-external-storage')); ?> " ></ a >
2018-08-01 10:27:36 +03:00
< p class = " settings-hint " >< ? php p ( $l -> t ( 'External storage enables you to mount external storage services and devices as secondary Nextcloud storage devices. You may also allow users to mount their own external storage services.' )); ?> </p>
2020-04-10 15:19:56 +03:00
< ? php if ( isset ( $_ [ 'dependencies' ]) and ( $_ [ 'dependencies' ] !== '' ) and $canCreateMounts ) {
print_unescaped ( '' . $_ [ 'dependencies' ] . '' );
} ?>
2015-09-14 15:57:49 +03:00
< table id = " externalStorage " class = " grid " data - admin = '<?php print_unescaped(json_encode($_[' visibilityType '] === BackendService::VISIBILITY_ADMIN)); ?>' >
2014-03-27 19:35:34 +04:00
< thead >
< tr >
< th ></ th >
< th >< ? php p ( $l -> t ( 'Folder name' )); ?> </th>
< th >< ? php p ( $l -> t ( 'External storage' )); ?> </th>
Authentication mechanisms for external storage backends
A backend can now specify generic authentication schemes that it
supports, instead of specifying the parameters for its authentication
method directly. This allows multiple authentication mechanisms to be
implemented for a single scheme, providing altered functionality.
This commit introduces the backend framework for this feature, and so at
this point the UI will be broken as the frontend does not specify the
required information.
Terminology:
- authentication scheme
Parameter interface for the authentication method. A backend
supporting the 'password' scheme accepts two parameters, 'user' and
'password'.
- authentication mechanism
Specific mechanism implementing a scheme. Basic mechanisms may
forward configuration options directly to the backend, more advanced
ones may lookup parameters or retrieve them from the session
New dropdown selector for external storage configurations to select the
authentication mechanism to be used.
Authentication mechanisms can have visibilities, just like backends.
The API was extended too to make it easier to add/remove visibilities.
In addition, the concept of 'allowed visibility' has been introduced, so
a backend/auth mechanism can force a maximum visibility level (e.g.
Local storage type) that cannot be overridden by configuration in the
web UI.
An authentication mechanism is a fully instantiated implementation. This
allows an implementation to have dependencies injected into it, e.g. an
\OCP\IDB for database operations.
When a StorageConfig is being prepared for mounting, the authentication
mechanism implementation has manipulateStorage() called,
which inserts the relevant authentication method options into the
storage ready for mounting.
2015-08-12 12:54:03 +03:00
< th >< ? php p ( $l -> t ( 'Authentication' )); ?> </th>
2014-03-27 19:35:34 +04:00
< th >< ? php p ( $l -> t ( 'Configuration' )); ?> </th>
2020-04-10 15:19:56 +03:00
< ? php if ( $_ [ 'visibilityType' ] === BackendService :: VISIBILITY_ADMIN ) {
print_unescaped ( '<th>' . $l -> t ( 'Available for' ) . '</th>' );
} ?>
2014-03-27 19:35:34 +04:00
< th >& nbsp ; </ th >
2015-03-16 16:07:53 +03:00
< th >& nbsp ; </ th >
2018-02-27 13:35:11 +03:00
< th >& nbsp ; </ th >
2014-03-27 19:35:34 +04:00
</ tr >
</ thead >
2014-07-16 00:33:30 +04:00
< tbody >
2016-03-17 01:06:49 +03:00
< tr id = " addMountPoint "
2016-08-09 15:09:53 +03:00
< ? php if ( ! $canCreateMounts ) : ?>
2016-03-17 01:06:49 +03:00
style = " display: none; "
< ? php endif ; ?>
>
2015-08-11 20:45:07 +03:00
< td class = " status " >
2018-02-22 17:04:23 +03:00
< span data - placement = " right " title = " <?php p( $l->t ('Click to recheck the configuration')); ?> " ></ span >
2015-08-11 20:45:07 +03:00
</ td >
< td class = " mountPoint " >< input type = " text " name = " mountPoint " value = " "
placeholder = " <?php p( $l->t ('Folder name')); ?> " >
</ td >
< td class = " backend " >
< select id = " selectBackend " class = " selectBackend " data - configurations = '<?php p(json_encode($_[' backends '])); ?>' >
< option value = " " disabled selected
style = " display:none; " >
< ? php p ( $l -> t ( 'Add storage' )); ?>
</ option >
< ? php
2020-04-09 14:53:40 +03:00
$sortedBackends = array_filter ( $_ [ 'backends' ], function ( $backend ) use ( $_ ) {
2015-09-14 15:57:49 +03:00
return $backend -> isVisibleFor ( $_ [ 'visibilityType' ]);
});
2020-04-09 14:53:40 +03:00
uasort ( $sortedBackends , function ( $a , $b ) {
2015-08-11 20:45:07 +03:00
return strcasecmp ( $a -> getText (), $b -> getText ());
});
?>
< ? php foreach ( $sortedBackends as $backend ) : ?>
2020-04-10 15:19:56 +03:00
< ? php if ( $backend -> getDeprecateTo ()) {
continue ;
} // ignore deprecated backends?>
2015-08-12 22:03:11 +03:00
< option value = " <?php p( $backend->getIdentifier ()); ?> " >< ? php p ( $backend -> getText ()); ?> </option>
2015-08-11 20:45:07 +03:00
< ? php endforeach ; ?>
</ select >
</ td >
Authentication mechanisms for external storage backends
A backend can now specify generic authentication schemes that it
supports, instead of specifying the parameters for its authentication
method directly. This allows multiple authentication mechanisms to be
implemented for a single scheme, providing altered functionality.
This commit introduces the backend framework for this feature, and so at
this point the UI will be broken as the frontend does not specify the
required information.
Terminology:
- authentication scheme
Parameter interface for the authentication method. A backend
supporting the 'password' scheme accepts two parameters, 'user' and
'password'.
- authentication mechanism
Specific mechanism implementing a scheme. Basic mechanisms may
forward configuration options directly to the backend, more advanced
ones may lookup parameters or retrieve them from the session
New dropdown selector for external storage configurations to select the
authentication mechanism to be used.
Authentication mechanisms can have visibilities, just like backends.
The API was extended too to make it easier to add/remove visibilities.
In addition, the concept of 'allowed visibility' has been introduced, so
a backend/auth mechanism can force a maximum visibility level (e.g.
Local storage type) that cannot be overridden by configuration in the
web UI.
An authentication mechanism is a fully instantiated implementation. This
allows an implementation to have dependencies injected into it, e.g. an
\OCP\IDB for database operations.
When a StorageConfig is being prepared for mounting, the authentication
mechanism implementation has manipulateStorage() called,
which inserts the relevant authentication method options into the
storage ready for mounting.
2015-08-12 12:54:03 +03:00
< td class = " authentication " data - mechanisms = '<?php p(json_encode($_[' authMechanisms '])); ?>' ></ td >
< td class = " configuration " ></ td >
2015-09-14 15:57:49 +03:00
< ? php if ( $_ [ 'visibilityType' ] === BackendService :: VISIBILITY_ADMIN ) : ?>
2015-08-11 20:45:07 +03:00
< td class = " applicable " align = " right " >
< input type = " hidden " class = " applicableUsers " style = " width:20em; " value = " " />
</ td >
< ? php endif ; ?>
< td class = " mountOptionsToggle hidden " >
2018-08-01 10:19:52 +03:00
< div class = " icon-more " title = " <?php p( $l->t ('Advanced settings')); ?> " ></ div >
2015-08-11 20:45:07 +03:00
< input type = " hidden " class = " mountOptions " value = " " />
</ td >
2017-03-22 16:32:26 +03:00
< td class = " save hidden " >
2018-02-26 15:02:07 +03:00
< div class = " icon-checkmark " title = " <?php p( $l->t ('Save')); ?> " ></ div >
2017-03-22 16:32:26 +03:00
</ td >
2015-08-11 20:45:07 +03:00
</ tr >
2014-03-27 19:35:34 +04:00
</ tbody >
</ table >
2012-08-29 10:42:49 +04:00
2015-09-14 15:57:49 +03:00
< ? php if ( $_ [ 'visibilityType' ] === BackendService :: VISIBILITY_ADMIN ) : ?>
2015-10-13 15:56:55 +03:00
< input type = " checkbox " name = " allowUserMounting " id = " allowUserMounting " class = " checkbox "
2020-04-10 15:19:56 +03:00
value = " 1 " < ? php if ( $_ [ 'allowUserMounting' ]) {
print_unescaped ( ' checked="checked"' );
} ?> />
2015-11-03 10:56:15 +03:00
< label for = " allowUserMounting " >< ? php p ( $l -> t ( 'Allow users to mount external storage' )); ?> </label> <span id="userMountingMsg" class="msg"></span>
2014-02-18 19:36:02 +04:00
2017-11-09 16:49:21 +03:00
< p id = " userMountingBackends " < ? php if ( ! $_ [ 'allowUserMounting' ]) : ?> class="hidden"<?php endif; ?>>
2015-09-14 15:57:49 +03:00
< ? php
2020-04-09 14:53:40 +03:00
$userBackends = array_filter ( $_ [ 'backends' ], function ( $backend ) {
2015-09-14 15:57:49 +03:00
return $backend -> isAllowedVisibleFor ( BackendService :: VISIBILITY_PERSONAL );
});
?>
< ? php $i = 0 ; foreach ( $userBackends as $backend ) : ?>
2015-09-17 19:00:15 +03:00
< ? php if ( $deprecateTo = $backend -> getDeprecateTo ()) : ?>
< input type = " hidden " id = " allowUserMountingBackends<?php p( $i ); ?> " name = " allowUserMountingBackends[] " value = " <?php p( $backend->getIdentifier ()); ?> " data - deprecate - to = " <?php p( $deprecateTo->getIdentifier ()); ?> " />
< ? php else : ?>
2020-04-10 15:19:56 +03:00
< input type = " checkbox " id = " allowUserMountingBackends<?php p( $i ); ?> " class = " checkbox " name = " allowUserMountingBackends[] " value = " <?php p( $backend->getIdentifier ()); ?> " < ? php if ( $backend -> isVisibleFor ( BackendService :: VISIBILITY_PERSONAL )) {
print_unescaped ( ' checked="checked"' );
} ?> />
2015-09-17 19:00:15 +03:00
< label for = " allowUserMountingBackends<?php p( $i ); ?> " >< ? php p ( $backend -> getText ()); ?> </label> <br />
< ? php endif ; ?>
2014-03-27 19:35:34 +04:00
< ? php $i ++ ; ?>
< ? php endforeach ; ?>
</ p >
< ? php endif ; ?>
2012-09-25 14:01:09 +04:00
</ form >
2016-08-09 15:05:02 +03:00
2018-06-21 14:34:08 +03:00
< div class = " followupsection " >
< form autocomplete = " false " action = " # "
2020-11-17 18:14:21 +03:00
id = " global_credentials " method = " post " >
2018-06-21 14:34:08 +03:00
< h2 >< ? php p ( $l -> t ( 'Global credentials' )); ?> </h2>
2021-05-20 13:13:04 +03:00
< p class = " settings-hint " >< ? php p ( $l -> t ( 'Global credentials can be used to authenticate with multiple external storage that have the same credentials.' )); ?> </p>
2016-08-09 15:05:02 +03:00
< input type = " text " name = " username "
autocomplete = " false "
value = " <?php p( $_['globalCredentials'] ['user']); ?> "
placeholder = " <?php p( $l->t ('Username')) ?> " />
< input type = " password " name = " password "
autocomplete = " false "
value = " <?php p( $_['globalCredentials'] ['password']); ?> "
placeholder = " <?php p( $l->t ('Password')) ?> " />
< input type = " hidden " name = " uid "
value = " <?php p( $_['globalCredentialsUid'] ); ?> " />
< input type = " submit " value = " <?php p( $l->t ('Save')) ?> " />
</ form >
2018-06-21 14:34:08 +03:00
</ div >