Skip to content

Commit

Permalink
Merge pull request #330 from wp-cli/add/application-passwords
Browse files Browse the repository at this point in the history 
Add application password commands
  • Loading branch information
@schlessera
schlessera authored Jan 4, 2022
2 parents 42507ed + d5ef2da commit 49897ba
Show file tree
Hide file tree
Showing 4 changed files with 838 additions and 4 deletions.
18 changes: 15 additions & 3 deletions entity-command.php
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
<?php

use WP_CLI\Utils;

if ( ! class_exists( 'WP_CLI' ) ) {
return;
}
Expand Down Expand Up @@ -63,26 +65,36 @@
'Term_Meta_Command',
array(
'before_invoke' => function() {
if ( \WP_CLI\Utils\wp_version_compare( '4.4', '<' ) ) {
if ( Utils\wp_version_compare( '4.4', '<' ) ) {
WP_CLI::error( 'Requires WordPress 4.4 or greater.' );
}
},
)
);
WP_CLI::add_command( 'user', 'User_Command' );
WP_CLI::add_command(
'user application-password',
'User_Application_Password_Command',
array(
'before_invoke' => function() {
if ( Utils\wp_version_compare( '5.6', '<' ) ) {
WP_CLI::error( 'Requires WordPress 5.6 or greater.' );
}
},
)
);
WP_CLI::add_command( 'user meta', 'User_Meta_Command' );
WP_CLI::add_command(
'user session',
'User_Session_Command',
array(
'before_invoke' => function() {
if ( \WP_CLI\Utils\wp_version_compare( '4.0', '<' ) ) {
if ( Utils\wp_version_compare( '4.0', '<' ) ) {
WP_CLI::error( 'Requires WordPress 4.0 or greater.' );
}
},
)
);

WP_CLI::add_command( 'user term', 'User_Term_Command' );

if ( class_exists( 'WP_CLI\Dispatcher\CommandNamespace' ) ) {
Expand Down
269 changes: 269 additions & 0 deletions features/user-application-password.feature
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,269 @@
Feature: Manage user custom fields

@less-than-php-8.0
Scenario: User application passwords are disabled for WordPress lower than 5.6
Given a WP install
And I try `wp theme install twentytwenty --activate`
And I run `wp core download --version=5.5 --force`

When I try `wp user application-password create 1 myapp`
Then STDERR should contain:
"""
Error: Requires WordPress 5.6 or greater.
"""

When I try `wp user application-password list 1`
Then STDERR should contain:
"""
Error: Requires WordPress 5.6 or greater.
"""

When I try `wp user application-password get 1 123`
Then STDERR should contain:
"""
Error: Requires WordPress 5.6 or greater.
"""

When I try `wp user application-password delete 1 123`
Then STDERR should contain:
"""
Error: Requires WordPress 5.6 or greater.
"""

@require-wp-5.6
Scenario: User application password CRUD
Given a WP install

When I run `wp user application-password create 1 myapp`
Then STDOUT should not be empty

When I run `wp user application-password list 1`
Then STDOUT should contain:
"""
myapp
"""

When I run `wp user application-password list 1 --name=myapp --field=uuid`
And save STDOUT as {UUID}
And I run `wp user application-password get 1 {UUID}`
Then STDOUT should contain:
"""
myapp
"""

When I try `wp user application-password get 2 {UUID}`
Then STDERR should be:
"""
Error: Invalid user ID, email or login: '2'
"""
And the return code should be 1

When I try `wp user application-password get 1 123`
Then STDERR should be:
"""
Error: No application password found for this user ID and UUID.
"""
And the return code should be 1

When I run `wp user application-password update 1 {UUID} --name=anotherapp`
Then STDOUT should not be empty

When I run `wp user application-password get 1 {UUID}`
Then STDOUT should contain:
"""
anotherapp
"""
Then STDOUT should not contain:
"""
myapp
"""

When I run `wp user application-password delete 1 {UUID}`
Then STDOUT should contain:
"""
Success: Deleted 1 of 1 application password.
"""

When I try `wp user application-password get 1 {UUID}`
Then the return code should be 1

When I run `wp user application-password create 1 myapp1`
And I run `wp user application-password create 1 myapp2`
And I run `wp user application-password create 1 myapp3`
And I run `wp user application-password create 1 myapp4`
And I run `wp user application-password create 1 myapp5`
Then STDOUT should not be empty

When I run `wp user application-password list 1 --format=count`
Then STDOUT should be:
"""
5
"""

When I run `wp user application-password list 1 --name=myapp1 --field=uuid`
And save STDOUT as {UUID1}
And I run `wp user application-password list 1 --name=myapp2 --field=uuid`
And save STDOUT as {UUID2}
When I try `wp user application-password delete 1 {UUID1} {UUID2} nonsense`
Then STDERR should contain:
"""
Warning: Failed to delete UUID nonsense
"""
Then STDOUT should contain:
"""
Success: Deleted 2 of 3 application passwords.
"""

When I run `wp user application-password list 1 --format=count`
Then STDOUT should be:
"""
3
"""

When I run `wp user application-password delete 1 --all`
And I run `wp user application-password list 1 --format=count`
Then STDOUT should be:
"""
0
"""

@require-wp-5.6
Scenario: List user application passwords
Given a WP install

When I run `wp user application-password create 1 myapp1`
Then STDOUT should not be empty

When I run `wp user application-password create 1 myapp2 --app-id=42`
Then STDOUT should not be empty

When I run `wp user application-password list 1 --name=myapp1 --field=uuid`
Then save STDOUT as {UUID1}

When I run `wp user application-password list 1 --name=myapp2 --field=uuid`
Then save STDOUT as {UUID2}

When I run `wp user application-password list 1 --name=myapp1 --field=password`
Then save STDOUT as {HASH1}

When I run `wp user application-password list 1 --name=myapp1 --field=password | sed 's#/#\\\/#g'`
Then save STDOUT as {JSONHASH1}

When I run `wp user application-password list 1 --name=myapp2 --field=password`
Then save STDOUT as {HASH2}

When I run `wp user application-password list 1 --name=myapp2 --field=password | sed 's#/#\\\/#g'`
Then save STDOUT as {JSONHASH2}

When I run `wp user application-password list 1 --name=myapp1 --field=created`
Then save STDOUT as {CREATED1}

When I run `wp user application-password list 1 --name=myapp2 --field=created`
Then save STDOUT as {CREATED2}

When I run `wp user application-password list 1 --format=json`
Then STDOUT should contain:
"""
{"uuid":"{UUID1}","app_id":"","name":"myapp1","password":"{JSONHASH1}","created":{CREATED1},"last_used":null,"last_ip":null}
"""
And STDOUT should contain:
"""
{"uuid":"{UUID2}","app_id":"42","name":"myapp2","password":"{JSONHASH2}","created":{CREATED2},"last_used":null,"last_ip":null}
"""

When I run `wp user application-password list 1 --format=json --fields=uuid,name`
Then STDOUT should contain:
"""
{"uuid":"{UUID1}","name":"myapp1"}
"""
And STDOUT should contain:
"""
{"uuid":"{UUID2}","name":"myapp2"}
"""

When I run `wp user application-password list 1`
Then STDOUT should be a table containing rows:
| uuid | app_id | name | password | created | last_used | last_ip |
| {UUID2} | 42 | myapp2 | {HASH2} | {CREATED2} | | |
| {UUID1} | | myapp1 | {HASH1} | {CREATED1} | | |

When I run `wp user application-password list 1 --fields=uuid,app_id,name`
Then STDOUT should be a table containing rows:
| uuid | app_id | name |
| {UUID2} | 42 | myapp2 |
| {UUID1} | | myapp1 |

When I run `wp user application-password list admin`
Then STDOUT should be a table containing rows:
| uuid | app_id | name | password | created | last_used | last_ip |
| {UUID2} | 42 | myapp2 | {HASH2} | {CREATED2} | | |
| {UUID1} | | myapp1 | {HASH1} | {CREATED1} | | |

When I run `wp user application-password list admin --orderby=created --order=asc`
Then STDOUT should be a table containing rows:
| uuid | app_id | name | password | created | last_used | last_ip |
| {UUID1} | | myapp1 | {HASH1} | {CREATED1} | | |
| {UUID2} | 42 | myapp2 | {HASH2} | {CREATED2} | | |

When I run `wp user application-password list admin --orderby=name --order=asc`
Then STDOUT should be a table containing rows:
| uuid | app_id | name | password | created | last_used | last_ip |
| {UUID1} | | myapp1 | {HASH1} | {CREATED1} | | |
| {UUID2} | 42 | myapp2 | {HASH2} | {CREATED2} | | |

When I run `wp user application-password list admin --orderby=name --order=desc`
Then STDOUT should be a table containing rows:
| uuid | app_id | name | password | created | last_used | last_ip |
| {UUID2} | 42 | myapp2 | {HASH2} | {CREATED2} | | |
| {UUID1} | | myapp1 | {HASH1} | {CREATED1} | | |

When I run `wp user application-password list admin --name=myapp2 --format=json`
Then STDOUT should contain:
"""
myapp2
"""
And STDOUT should not contain:
"""
myapp1
"""

When I run `wp user application-password list admin --field=name`
Then STDOUT should contain:
"""
myapp1
"""
And STDOUT should contain:
"""
myapp2
"""

When I run `wp user application-password list 1 --field=name --app-id=42`
Then STDOUT should be:
"""
myapp2
"""

@require-wp-5.6
Scenario: Get particular user application password hash
Given a WP install

When I run `wp user create testuser testuser@example.com --porcelain`
Then STDOUT should be a number
And save STDOUT as {USER_ID}

When I try the previous command again
Then the return code should be 1

Given I run `wp user application-password create {USER_ID} someapp --porcelain`
And save STDOUT as {PASSWORD}
And I run `wp user application-password list {USER_ID} --name=someapp --field=uuid`
And save STDOUT as {UUID}

Given I run `wp user application-password get {USER_ID} {UUID} --field=password | sed 's/\$/\\\$/g'`
And save STDOUT as {HASH}

When I run `wp eval "var_export( wp_check_password( '{PASSWORD}', '{HASH}', {USER_ID} ) );"`
Then STDOUT should contain:
"""
true
"""
2 changes: 1 addition & 1 deletion phpcs.xml.dist
View file
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@
<exclude-pattern>*/src/Post(_Meta|_Term|_Type)?_Command\.php$</exclude-pattern>
<exclude-pattern>*/src/Site(_Meta|_Option)?_Command\.php$</exclude-pattern>
<exclude-pattern>*/src/Term(_Meta)?_Command\.php$</exclude-pattern>
<exclude-pattern>*/src/User(_Meta|_Session|_Term)?_Command\.php$</exclude-pattern>
<exclude-pattern>*/src/User(_Application_Password|_Meta|_Session|_Term)?_Command\.php$</exclude-pattern>
</rule>

<!-- Whitelisting to provide backward compatibility to classes possibly extending this class. -->
Expand Down
Loading

0 comments on commit 49897ba

Please sign in to comment.