Unable to authenticate to API "Please provide token"

[sidhoah8]

Thanks for creating these Ansible modules. They look really useful and I look forward to using them. But I've tried using the basic examples to create a playbook using the codeaffen.phpipam.vlan and codeaffen.phpipam.address modules and no matter what I do, they both fail authentication.

I modified the api.py class in phpypam to print the output of the requests response as otherwise, no useful information is shown:

          if result['code'] not in (200, 201) or not result['success']:
              print(result) # added otherwise no error details shown
              raise PHPyPAMException(code=result['code'], message=result['message'])

and now I can see the following error in the Ansible output:

module_stdout": "{'code': 403, 'success': False, 'message': 'Please provide token', 'time': 0.001}\n"

I don't see anywhere that I can provide the token in Ansible. I was going to raise a bug issue and look further... but I wonder if this is user error? Am I supposed to define the "App code" somewhere or a token? I've tried creating a fresh Python virtual environment with the latest ansible, phpypam, inflection packages but no difference.

[cmeissner]

Hi @sidhoah8,

thank you for asking question here. Can you please provide your ansible playbook so that I can try to reproduce your issue here?
Without these information I would guess that you try to connect to an unencrypted (http) api endpoint. This

I modified the api.py class in phpypam to print the output of the requests response as otherwise, no useful information is shown:

   if result['code'] not in (200, 201) or not result['success']:
       print(result) # added otherwise no error details shown
       raise PHPyPAMException(code=result['code'], message=result['message'])

Good workaround for your local debugging. You also can extend phpypam/core/exceptions.py to handle these issue too and than open a pull request.

[sidhoah8]

Hi @cmeissner

Thanks for the quick reply. Here's the playbook:

---

- name: phpIPAM testing
  hosts: localhost
  gather_facts: false

  vars:
    phpipam_server_url: "https://MY_PHPIPAM_INSTANCE"
    phpipam_login_user: "MY_OWN_AD_USERID"
    phpipam_login_password: 'MY_OWN_AD_PASS'
    phpipam_app_id: "ansible"

  tasks:
    - name: "Create vlan"
      codeaffen.phpipam.vlan:
        username: "{{ phpipam_login_user }}"
        password: "{{ phpipam_login_password }}"
        server_url: "{{ phpipam_server_url }}"
        app_id: "{{ phpipam_app_id }}"
        validate_certs: no
        name: "my vlan"
        vlan_id: 1337
        state: present

As you see, I'm trying to connect via HTTPS. The API settings look as follows:

And yep, good idea for the exception handling. I'm new to git but trying to learn so I will have a look at extending exceptions.py in phpypam :-)

[cmeissner]

Ok, thank you for supplying your test code. It works well on my side. I Only change the vars corresponding to my phpipam installation. The vlan is created as expected.
So I suspect an issues on phpipam side. Maybe we have to digging here a bit more.

What you can try is to run the tests from phpypam directly against your installation, if the issue is still there we can put the phpipam-ansible-modules a side. What do you think?

[sidhoah8]

Ok, that's good to know it's working on your side. Then I'm not missing something obvious in the code.

I just wanted to make sure I wasn't missing something before putting unnecessary time in to troubleshooting. So I'll try phpypam on it's own and I'll also try a fresh install of phpIPAM to compare.

Thanks a lot for the quick replies and I'll let you know how I get on.

[sidhoah8]

So I tried it in phpypam and it's just the same as with phpipam-ansible-modules.

But I then tried the plain python requests package and it works:

>>> r = requests.post('https://XXXXXXXXXX/api/ansible/user/', auth=('XXXXXX', 'XXXXXXX'), verify=False)
env/phpipamans/lib64/python3.6/site-packages/urllib3/connectionpool.py:1020: InsecureRequestWarning: Unverified HTTPS request is being made to host 'XXXXXX'. Adding certificate verification is strongly advised. See: https://urllib3.readthedocs.io/en/latest/advanced-usage.html#ssl-warnings
  InsecureRequestWarning,
>>> r.json()
{'code': 200, 'success': True, 'data': {'token': 'XXXXXXXX', 'expires': '2021-02-24 03:54:07'}, 'time': 0.02}

I'm also able to 'get' data using the token.. so with requests it works.. but not with the phpypam package.

The only thing I noticed when playing with requests was that I used requests.get() by mistake to start with and that then gave the same error about a missing token:

>>> r.json()
{'code': 403, 'success': False, 'message': 'Please provide token', 'time': 0.001}

I will keep digging to see why it's not working with my setup but it doesn't appear to be a problem in phpipam-ansible-modules.

[cmeissner]

I switched to phpipam v1.4.1 and it works too.

[sidhoah8]

Ok, don't put any more effort in to it. It seems like the issue is on my side. I will build up a totally fresh environment and test there.
If I find out why it's not working and it looks like a bug, I'll open a bug in phpypam.

[sidhoah8]

So I created a fresh install of phpIPAM version 1.4.2 and it works with phpypam. So the issue is definitely on my side. I don't know why it works with requests in Python, other than I'm not passing auth details via objects there.

Sorry that you put so much effort looking at it but thanks a lot for the support.

[cmeissner]

Great to hear that it's now working on your side.
If you finally use our modules and like it, feel free to start the involved repos.

stay well

[sidhoah8]

I still had the problem in our "prod" environment and did more troubleshooting. I've now opened a bug report in phpypam at https://github.com/codeaffen/phpypam/issues/46