Jump to: navigation, search

Difference between revisions of "Designate/Blueprints/IPABackend"

(backend.create_domain(self, context, domain))
(Create, Update, Delete Domain)
Line 133: Line 133:
 
==== backend.delete_domain(self, context, domain) ====
 
==== backend.delete_domain(self, context, domain) ====
 
The method name is dnszone_del, and the only parameter is the domain name.
 
The method name is dnszone_del, and the only parameter is the domain name.
 +
=== Create, Update, Delete Record ===
 +
==== backend.create_record(self, context, domain, recordset, record) ====
 +
IPA wants the relative host/domain name, not the FQDN, for the record name.  So, instead of adding an A record a.example.org., IPA wants to add a record named 'a' to domain 'example.org.'.  Similarly for PTR records - IPA wants '100' in domain '122.168.192.in-addr.arpa.'.  There is currently a bug in IPA - if you want to add a record to the domain itself, you must use '@' for the domain name.  There is logic in the backend code to handle these cases.  The recname parameter below is derived from recordset['name'] by this logic.
 +
 +
The type of record is derived from a mapping of the recordset['type'] to the IPA keyword for that type.  So, recordset['type'] = 'A' is mapped to 'arecord', etc.
 +
 +
The JSON looks like this:
 +
{
 +
  'method': 'dnsrecord_add',
 +
  'params': [
 +
    [ domain['name'], recname ],
 +
    {
 +
      'arecord': record['data'],
 +
      'version': '2.65'
 +
    }],
 +
  'id': 0
 +
}
 +
For SRV and MX records, the record['priority'] is added to the beginning of record['data'].
 +
 +
==== backend.update_record(self, context, domain, recordset, record) ====
 +
IPA doesn't have the same Designate concept as a unique identifier for a record.  There isn't an easy way to just modify the data of a particular record.  For example, there isn't a good way to just modify the priority of a particular MX record.  For updates, the ipa backend will get all of the records of the given record['recordset_id'], and replace _all_ of the records of that type.  For example, if there are MX records in IPA like this:
 +
10 mx1.example.org.
 +
20 mx2.example.org.
 +
30 mx3.example.org.
 +
And there is an update_record to update the second one to have a priority of 5, the ipa backend will do a dnsrecord_mod like this:
 +
{
 +
  'method': 'dnsrecord_mod',
 +
  'params': [
 +
    [ domain['name'], recname ],
 +
    {
 +
      'mxrecord': ['10 mx1.example.org.', '5 mx2.example.org.', '30 mx3.example.org.'],
 +
      'version': '2.65'
 +
    }],
 +
  'id': 0
 +
}
 +
This is not expected to cause performance problems, unless there are hundreds of records (possible?  likely?).
 +
 +
==== backend.delete_domain(self, context, domain) ====
 +
The method name is dnsrecord_del.  The same mapping of type and data as above for create_record is done.  IPA is able to delete specific record data e.g. you can delete just the '10 mx1.example.org.' MX record as above.
  
 
== API Changes ==
 
== API Changes ==

Revision as of 23:43, 2 April 2014

Overview

Gerrit Patch []
Launchpad Blueprint [1]

Summary

This implements support for using FreeIPA as a backend. FreeIPA has full support for DNS, using the JSON RPC interface for dnszone (domain) and dnsrecord commands.

Requirements

  • python-kerberos 1.1 or later
  • MIT kerberos5 version 1.11.3 or later
  • A FreeIPA deployment, with an account that has access to manage the DNS portion. The admin@DOMAIN account can be used for testing, but is not recommended for production. You must generate a keytab file for this account, and Designate Central must have read access to the keytab file.
  • The CA cert file from FreeIPA (default /etc/ipa/ca.crt).

Configuration

To use the IPA backend, in /etc/designate/designate.conf set

[service:central]
backend_driver = ipa

Then set the [backend:ipa] configuration parameters:

Name Required Default Description
ipa_host Yes None Name (FQDN) of IPA host
ipa_port No 80 Port number for IPA HTTPS service
ipa_client_keytab Yes None Absolute path to IPA client kerberos keytab file
ipa_ca_cert Yes None Absolute path to IPA CA cert file
ipa_base_url No https://$ipa_host/ipa Base URL for IPA HTTPS RPC interfaces
ipa_json_url No https://$ipa_host/ipa/json Base URL for IPA JSON RPC interface
ipa_version Yes 2.65 IPA JSON RPC version

HTTPS

IPA requires the use of HTTPS for security. By default, IPA generates a CA cert and stores it in /etc/ipa/ca.crt. For HTTPS communication with IPA, the requests module is used, and the request verify member is set to the IPA CA cert.

Kerberos

IPA requires the use of Kerberos for authentication. The IPA backend uses the KRB5_CLIENT_KEYTAB feature of MIT Kerberos 1.11. For the HTTP communication with IPA, the backend uses the requests module, and sets the header Authorization: negotiate $token where $token is the Kerberos token generated by the python-kerberos module from the keytab file. This is done automatically with the requests object via the auth member. There is a subclass of requests.auth.AuthBase called IPAAuth which handles the Kerberos authentication upon demand.

The Kerberos auth token will expire periodically. An IPA request will return with a status_code of 401 when the token expires, and the code in the backend will refresh the auth token.

One current limitation is that only one identity can be used at a time. This is because KRB5_CLIENT_KEYTAB is global.

IPA JSON RPC

This interface is not currently documented in the official documentation, but is officially supported. A JSON call to IPA looks like this:

{
  'method': $methodname,
  'params': [
    [ $positionalparam, $positionalparam2 ],
    {
      $param1: $value1,
      ...
      'version': $ipa_version
    }],
  'id': 0
}

Where $methodname is one of 'dnszone_add', 'dnszone_mod', 'dnszone_del', 'dnsrecord_add', 'dnsrecord_mod', 'dnsrecord_del'.

All of the methods take $positionalparam, which is usually the name of the zone (domain). The dnsrecord methods use $positionalparam2 as the record name.

Depending on the method and record type, there will be keyword params $param1, etc. For example, a dnszone_add looks like this:

{
  'method': 'dnszone_add',
  'params': [
    [[ 'example.org.' ]],
    {
      'idnssoamname': 'ns.example.org.',
      'force': True,
      'idnssoarname': 'hostmaster@example.org.',
      'dnsttl': 3600,
      'idnssoaserial': 13789910123,
      'idnssoaexpire': 12345,
      'idnssoaminimum': 1200,
      'idnssoarefresh': 54321,
      'idnssoaretry': 11111,
      'version': '2.65'
    }],
  'id': 0
}

Adding an A record looks like this:

{
  'method': 'dnsrecord_add',
  'params': [
    [ 'example.org.', 'a'],
    {
      'arecord': '192.168.122.100.',
      'version': '2.65'
    }],
  'id': 0
}

The ipa backend code has mappings from the domain/recordset/record object properties to the IPA JSON parameters.

Create, Update, Delete Domain

backend.create_domain(self, context, domain)

The code first does

servers = self.central_service.find_servers(self.admin_context)

to get the list of name servers for the domain. Then it sends the following IPA JSON RPC:

{
  'method': 'dnszone_add',
  'params': [
    [[ domain['name'] ]],
    {
      'idnssoamname': servers[0]['name'],
      'force': True,
      'idnssoarname': domain['email'],
      'dnsttl': domain['ttl'],
      'idnssoaserial': domain['serial'],
      'idnssoaexpire': domain['expire'],
      'idnssoaminimum': domain['minimum'],
      'idnssoarefresh': domain['refresh'],
      'idnssoaretry': domain['retry'],
      'version': '2.65'
    }],
  'id': 0
}

The 'force': True parameter is used because, by default, IPA will not allow the use of an SOA mname if there is no corresponding A/AAAA record that can be resolved. Also note that, in the dnszone_add method, only one name server can be specified with the idnssoamname parameter. This is the first one returned by the central_service.find_servers method. The other servers are added as NS records by the create_domain method.

backend.update_domain(self, context, domain)

Same as above, but with method name dnszone_mod.

backend.delete_domain(self, context, domain)

The method name is dnszone_del, and the only parameter is the domain name.

Create, Update, Delete Record

backend.create_record(self, context, domain, recordset, record)

IPA wants the relative host/domain name, not the FQDN, for the record name. So, instead of adding an A record a.example.org., IPA wants to add a record named 'a' to domain 'example.org.'. Similarly for PTR records - IPA wants '100' in domain '122.168.192.in-addr.arpa.'. There is currently a bug in IPA - if you want to add a record to the domain itself, you must use '@' for the domain name. There is logic in the backend code to handle these cases. The recname parameter below is derived from recordset['name'] by this logic.

The type of record is derived from a mapping of the recordset['type'] to the IPA keyword for that type. So, recordset['type'] = 'A' is mapped to 'arecord', etc.

The JSON looks like this:

{
  'method': 'dnsrecord_add',
  'params': [
    [ domain['name'], recname ],
    {
      'arecord': record['data'],
      'version': '2.65'
    }],
  'id': 0
}

For SRV and MX records, the record['priority'] is added to the beginning of record['data'].

backend.update_record(self, context, domain, recordset, record)

IPA doesn't have the same Designate concept as a unique identifier for a record. There isn't an easy way to just modify the data of a particular record. For example, there isn't a good way to just modify the priority of a particular MX record. For updates, the ipa backend will get all of the records of the given record['recordset_id'], and replace _all_ of the records of that type. For example, if there are MX records in IPA like this:

10 mx1.example.org.
20 mx2.example.org.
30 mx3.example.org.

And there is an update_record to update the second one to have a priority of 5, the ipa backend will do a dnsrecord_mod like this:

{
  'method': 'dnsrecord_mod',
  'params': [
    [ domain['name'], recname ],
    {
      'mxrecord': ['10 mx1.example.org.', '5 mx2.example.org.', '30 mx3.example.org.'],
      'version': '2.65'
    }],
  'id': 0
}

This is not expected to cause performance problems, unless there are hundreds of records (possible? likely?).

backend.delete_domain(self, context, domain)

The method name is dnsrecord_del. The same mapping of type and data as above for create_record is done. IPA is able to delete specific record data e.g. you can delete just the '10 mx1.example.org.' MX record as above.

API Changes

None

One Per Change

Verb Resource Description
GET /resource Description of call
GET /resource/{id} Description of call

Database Changes

Description of Changes to DB schemas

eg -

Name Data Type Length Nullable Details
id VARCHAR 36 False Primary Key, Generated UUID
name VARCHAR 255 False Domain name to be blacklisted
version INTEGER - False Designate API version
created_at DATETIME - False UTC time of creation
updated_at DATETIME - True UTC time of creation
description VARCHAR 160 True UTF-8 text field