win_service quotes in path to handle spaces

[valerius257]

ISSUE TYPE

• Bug Report

COMPONENT NAME

win_service

ANSIBLE VERSION

ansible 2.4.0.0
  config file = /etc/ansible/ansible.cfg
  configured module search path = [u'/root/.ansible/plugins/modules', u'/usr/share/ansible/plugins/modules']
  ansible python module location = /usr/lib/python2.7/site-packages/ansible
  executable location = /bin/ansible
  python version = 2.7.5 (default, Aug  4 2017, 00:39:18) [GCC 4.8.5 20150623 (Red Hat 4.8.5-16)]

CONFIGURATION

DEFAULT_ROLES_PATH(/etc/ansible/ansible.cfg) = [u'/etc/ansible/roles', u'/usr/share/ansible/roles']
PERSISTENT_CONNECT_TIMEOUT(/etc/ansible/ansible.cfg) = 30

OS / ENVIRONMENT

Ansible Host: CentOS 7
Managing: Windows 2012 R2

SUMMARY

win_service fails to create service when quoted path which is needed to handle spaces in path.

STEPS TO REPRODUCE

- name: create jenkins slave service
  win_service:
   name: jenkins-slave
   display_name: Jenkins Slave
   start_mode: auto
   path: '"C:\Jenkins Slave\jenkins-slave.exe"'

EXPECTED RESULTS

windows service created with path being in quotes

ACTUAL RESULTS

win_service failed to create service

fatal: [host]: FAILED! => {
    "changed": false,
    "failed": true,
    "msg": "Get-AnsibleParam: Parameter 'path' has an invalid path '\"C:\\Jenkins Slave\\jenkins-slave.exe\"' specified."
}

[ansibot]

cc @chrishoffman @dagwieers @jborean93 @jhawkesworth
click here for bot help

[jborean93]

Do you need to quote the path? I've got plenty of local services where the Path to executable is in C:\Program Files\* and they are not quoted.

[valerius257]

In this particular case quotes are not needed but this may be needed when additional parameters are passed to the service or parameters itself should be in quotes.
For example Microsoft Policy Platform Local Authority service have the following path "C:\Program Files\Microsoft Policy Platform\policyHost.exe" /service

[dssdss]

I have the same issue when I try to deploy Zabbix Agent service with the command line: "C:\Program Files\zabbix\zabbix_agentd.exe" --config "C:\Program Files\zabbix\zabbix_agentd.conf".

It is standard for Windows to use quotas, while using long folder of filenames in the path.

For example path to executable for the regular Microsoft service - MSSQLSERVER:
"E:\Program Files\Microsoft SQL Server\MSSQL11.MSSQLSERVER\MSSQL\Binn\sqlservr.exe" -sMSSQLSERVER

Its a bug with quotes in win_service, please fix it!!!

[jborean93]

Thanks for the info @valerius257 and @dssdss. I suppose it is also a security risk as someone could create a malicious exe at C:\Program.exe and Windows will execute that per their process argument rules.

I've raised a PR to fix this here #32469 so if you can check it out we can merge it in hopefully before 2.4.2 is out.

The issue is from a change in 2.4 where parameters with a type of path were actually validated as a valid path which when quotes are used makes it invalid. I've fixed it up and added integration tests so it should be working.

[dssdss]

Now, it works! Thank you very much.

[jborean93]

Fixed has been merged to devel and cherry-picked to stable-2.4 with e771b64. Will be released under 2.4.2 beta 3