azure-cli/lib/commands/arm/network/zoneFile.js

Microsoft Azure Cross Platform Command Line tool

/*** Generated by streamline 0.10.17 (callbacks) - DO NOT EDIT ***//**
 * Copyright (c) Microsoft.  All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

var constants = require('./constants');
var moment = require('moment');
var util = require('util');
var utils = require('../../../util/utils');
var recordSetUtils = require('./recordSetUtils');
var __ = require('underscore');
var $ = utils.getLocaleString;

function ZoneFile(output) {
  this.output = output;
}

__.extend(ZoneFile.prototype, {

  checkCaaMultilineIssues: function(text) {
    var splitText = text.split('\n');
    splitText = splitText.map(function (line) { return line.replace('\r', ''); });

    var recRegex = /[^ ]+[ ]+[0-9]+[ ]+[\w]+[ ]+[A-Z]+.*/gim;
    var caaRegex = /[^ ]+[ ]+[0-9]+[ ]+[\w]+[ ]+CAA.*\(/gim;

    function checkRecord (lines) {
      if (!lines || !lines.length) {
        return;
      }
      if (lines[0].match(caaRegex) && lines.length > 1) {
        throw new Error(util.format($('Import file contains multiline record for CAA in:\n%s\nPlease change this to a single line and try again.'), lines.join('  \n')));
      }
    }

    var recordLines;

    for (i = 0; i < splitText.length; i++) {
      var line = splitText[i];

      if (!line.length) {
        continue;
      }

      if (line.match(recRegex)) {
        checkRecord(recordLines);
        recordLines = [line];
      } else if (recordLines) {
        recordLines.push(line);
      }
    }

    checkRecord(recordLines);
  },

  /**
   * Returns JSON object which represents standard zone file structure.
   */
  parse: function (zoneName, text) {
    text = this.removeComments(text);
    text = this.flatten(text);
    return this.parseRRs(zoneName, text);
  },

  /**
   * Generates standard zone file content from Azure DNS zone object.
   */
  generate: function (resourceGroupName, zoneName, recordSets) {
    var ttl = recordSets[0].tTL;
    var fileData = '';
    fileData = this.generateHeader(fileData, resourceGroupName, zoneName, ttl);
    fileData = this.generateRRs(fileData, recordSets);
    return fileData;
  },

  /**
   * Parse methods
   */
  flatten: function (text) {
    this.checkCaaMultilineIssues(text);
    var bracketsPattern = /\([\s\S]*?\)\s+$/gim;
    var match = bracketsPattern.exec(text);
    while (match !== null) {
      match.replacement = match[0].replace(/\s+/gm, ' ').replace(/^\(/i, '').replace(/\)\s+$/i, '').trim();
      var textAsCharsArray = text.split('');
      textAsCharsArray.splice(match.index, match[0].length, match.replacement); // Replace multi-line chars with single-line instead.
      text = textAsCharsArray.join('');
      bracketsPattern = /\([\s\S]*?\)/gim;
      match = bracketsPattern.exec(text);
    }
    return text;
  },

  /**
   * On Import, comments in the zone file will be ignored.  They will not be imported.
   * Mapping comments into ARM tags is a possible future feature.
   */
  removeComments: function (text) {
    text = text.match(/[^\r\n]+/g);
    var clearText = '';

    for (var k = 0; k < text.length; k++){
      var openQuote = false;
      for (var i = 0; i < text[k].length; i++) {
        if (text[k][i] == '\"')
          if (text[k][i-1] != '\\')
            openQuote = !openQuote;
        if (text[k][i] == ';' && !openQuote && text[k][i-1] != '\\'){
          text[k] = text[k].slice(0, i);
        }
      }
      clearText = clearText + text[k] + '\r\n';
    }

    return clearText;
  },

  parseRRs: function (zoneName, text) {
    var self = this;
    var res = {
      sets: []
    };

    zoneName = zoneName.toLowerCase();
    if (!utils.stringEndsWith(zoneName, '.', true)) zoneName += '.';

    var prevRrName = '';
    var prevTtl = constants.dnsZone.defTtl;
    var rrs = text.split('\n');
    for (var i in rrs) {
      var rr = rrs[i];
      if (!rr || !rr.trim()) {
        continue;
      }
      var recordSet;

      if (utils.stringStartsWith(rr, '$', true)) {
        self.parseDirective(rr, res);
      } else {
        if (res.$origin === undefined) res.$origin = zoneName;
        var baseRR = this.parseRR(rr, res.$origin, zoneName, prevTtl, prevRrName);
        if (baseRR.error) {
          this.output.warn(baseRR.error);
          prevRrName = baseRR.name;

          continue;
        }

        switch (baseRR.type) {
          case 'SOA':
            recordSet = self.parseSOA(baseRR, res.$origin);
            break;
          case 'NS':
            recordSet = self.parseNS(baseRR, res.$origin);
            break;
          case 'A':
            recordSet = self.parseA(baseRR);
            break;
          case 'AAAA':
            recordSet = self.parseAAAA(baseRR);
            break;
          case 'CNAME':
            recordSet = self.parseCNAME(baseRR, res.$origin);
            break;
          case 'TXT':
            recordSet = self.parseTXT(baseRR);
            if(!recordSet.name) {
              self.output.warn(util.format('Incorrect TXT record Value: "%s"', recordSet));
              continue;
            }
            break;
          case 'SPF':
            baseRR.type = constants.dnsZone.TXT;
            recordSet = self.parseTXT(baseRR);
            self.output.warn(util.format($('Warn: The SPF record type was deprecated by RFC 7208, which states TXT should be used instead. ' +
              'The SPF record "%s" was converted to TXT during import.'), baseRR.name));
            break;
          case 'MX':
            recordSet = self.parseMX(baseRR, res.$origin);
            break;
          case 'PTR':
            recordSet = self.parsePTR(baseRR, res.$origin);
            break;
          case 'SRV':
            recordSet = self.parseSRV(baseRR, res.$origin);
            break;
          case 'CAA':
            recordSet = self.parseCAA(baseRR, res.$origin);
            break;
          default:
            this.output.warn(util.format('Record of unsupported type: %s', rr));
            continue;
        }
      }

      if (recordSet) {
        var index = utils.indexOfCaseIgnore(res.sets, {name: recordSet.name, type: recordSet.type});
        if (index === -1) {
          res.sets.push(recordSet); // create new RecordSet.
        } else {
          res.sets[index].records.push(recordSet.records[0]); // Use existing Record set.
          if (recordSet.ttl !== res.sets[index].ttl) {
            var minTtl = recordSet.ttl < res.sets[index].ttl ? recordSet.ttl : res.sets[index].ttl;
            this.output.info(util.format('The TTLs %s and %s for record set "%s" of type "%s" are conflicts, using lower TTL of %s',
              recordSet.ttl, res.sets[index].ttl, recordSet.name, recordSet.type, minTtl));
            res.sets[index].ttl = minTtl;
          }
        }
        prevRrName = recordSet.name;
        prevTtl = recordSet.ttl;
        recordSet = undefined;
      }
    }
    return res;
  },

  /**
   * Any FQDN can be specified as $ORIGIN.  It does not have to match the zone name.
   * If the value in $ORIGIN does not end with a '.', a '.' shall be added and a warning given.
   */
  parse$ORIGIN: function (rr) {
    var self = this;
    var origin = rr.split(/\s+/g)[1];
    if (!utils.stringEndsWith(origin, '.', true)) {
      self.output.warn(util.format('The value "%s" of $ORIGIN directive doesn\'t end with a dot, dot added', origin));
      origin += '.';
    }
    return origin;
  },

  /**
   * The $TTL is optional in the zone file.
   * Where present, all subsequent record sets which do not specify an explicit TTL must use the TTL value from the $TTL directive.
   */
  parse$TTL: function (rr) {
    var value = rr.split(/\s+/g)[1];
    var ttl = this.parseTimestamp(value);
    return ttl;
  },

  /**
   * Returns seconds number from 1m, 2h, 3d, 4m TTL time format
   */
  parseTimestamp: function (str) {
    str = str.toLowerCase();

    var seconds = 0;
    var chunk = '';
    var prevChar;

    for (var i = 0, currChar = ''; i < str.length; i++) {
      currChar = str.charAt(i);
      if (!isNaN(parseInt(currChar))) {
        chunk += currChar;
      } else {
        if (i === 0) return undefined;
        if (isNaN(parseInt(prevChar))) return undefined;
        switch (currChar) {
          case 's':
            seconds += chunk * 1;
            break;
          case 'm':
            seconds += chunk * 60;
            break;
          case 'h':
            seconds += chunk * 3600;
            break;
          case 'd':
            seconds += chunk * 86400;
            break;
          case 'w':
            seconds += chunk * 604800;
            break;
          default:
            return undefined;
        }
        chunk = '';
      }
      prevChar = currChar;
    }

    if (chunk.length > 0) seconds += parseInt(chunk);
    return seconds;
  },

  parseRR: function (rr, $origin, zoneName, $ttl, prevRrName) {
    var self = this;
    var res = {
      data: []
    };

    var validTypes = ['A', 'AAAA', 'CNAME', 'MX', 'NS', 'PTR', 'SOA', 'SPF', 'SRV', 'TXT', 'CAA'];
    var validClasses = ['IN', 'CS', 'CH', 'HS'];
    
    /**
     * One DNS zone file contained additional fields that looked like [AGE:xxxxxx].
     * Those fields have no application in Azure so they are stripped.
     */
    var rrTokens = rr.replace(/\[[^\]]+\]/gi, '').trim().split(/\s+/g);
    var regexp = /^\s/;
    if(rr[0].match(regexp)) {
      rrTokens = [prevRrName].concat(rrTokens);
    }

    if (rrTokens.length < 2) {
      res.error = util.format('Invalid record format: %s', rr);
      return res;
    }
    var position = 0;
    while (rrTokens.length > 0) {
      var token = rrTokens.shift();
      if (validClasses.indexOf(token.toUpperCase()) !== -1 && (position <= 2)) {
        res.class = token.toUpperCase();
      } else if (position === 0) {
        res.name = token;
      } else if (position === 1 && token === '0') {
        // Use default TTL
        res.ttl = constants.dnsZone.defTtl;
      } else if (validTypes.indexOf(token.toUpperCase()) !== -1 && (position <= 3) && res.type != constants.dnsZone.TXT) {
        res.type = token.toUpperCase();
      } else if (self.parseTimestamp(token) && (position <= 1) && (res.type === undefined)) {
        // Support for numeric record names.
        if (res.ttl === undefined) {
          res.ttl = self.parseTimestamp(token);
        } else {
          res.name = res.ttl.toString();
          res.ttl = self.parseTimestamp(token);
        }
      } else {
        res.data.push(token);
      }
      position++;
    }

    if (res.data.length < 1) {
      res.error = util.format('Invalid record format: %s', rr);
      return res;
    }

    if (!res.type) {
      res = {
        error: util.format('Invalid record format: %s', rr)
      };
      return res;
    }

    if(!res.ttl) {
      res.ttl = ($ttl === undefined) ? constants.dnsZone.defTtl : $ttl;
    }

    /*
      The record name is optional. Where it is omitted, the record has the same record name
      as the previous record in the zone file. That record may have the same type or a different type.
      If record name is not specified, and no previous records have specified it, assume record name is '@'.

      Also, each label must only contain letters, numbers, underscores, and/or dashes. Each label should be
      separated from other labels by a period. A wildcard is permitted either as the single character in
      the name, or as the first label in the name.
     */

    if (!res.name) {
      res.name = (prevRrName === undefined) ? '@' : prevRrName;
    } else {
      var explicitCharacters = res.name.match(/[^a-z0-9\_\-\*\.\@]/gi);
      var wildcardIndex = res.name.indexOf('*');
      if (explicitCharacters || wildcardIndex > 0) {
        res.error = util.format('Record set name "%s" is invalid, skipped', res.name);
        return res;
      }
    }

    /*
      The value of $ORIGIN shall replace records named ‘@’, and shall be appended to any record name that is not fully-qualified.
      If, after this is done, the FQDN of a record does not match the zone name, then a warning shall be given.
     */
    var fqdnName = self.convertToFQDN(res.name, $origin);
    if (!utils.stringEndsWith(fqdnName, zoneName, true)) {
      res.error = util.format('The record set with fully-qualified name "%s" does not match the zone name "%s", skipped', fqdnName, zoneName);
      return res;
    }
    res.name = fqdnName;
    return res;
  },

  parseDirective: function (rr, res) {
    var self = this;
    var uRR = rr.toUpperCase();
    if (uRR.indexOf('$ORIGIN') === 0) {
      res.$origin = self.parse$ORIGIN(rr);
    } else if (uRR.indexOf('$TTL') === 0) {
      res.$ttl = self.parse$TTL(rr);
    } else {
      self.output.warn(util.format('Unrecognized directive: %s', rr));
    }
  },

  /**
   * The value of $ORIGIN shall be appended to any domain name specified in record RDATA
   * that is not fully-qualified (i.e. does not end in ‘.’).
   */
  convertToFQDN: function (value, $origin) {
    // Covers cases such as "@" and "subdomain.@"
    if (value.indexOf('@') !== -1) {
      return value.replace('@', $origin);
    }
    if (utils.stringEndsWith(value, '.', true)) return value;
    if (!$origin) {
      this.output.warn('$ORIGIN directive is not defined');
      return value;
    } else {
      var fdqn = value + '.';
      if ($origin !== '.') {
        fdqn += $origin;
      }
      return fdqn;
    }
  },

  covertFromFQDN: function (value, zoneName) {
    var zoneSuffix = zoneName;
    if (!utils.stringEndsWith(zoneSuffix, '.', true)) zoneSuffix += '.';

    if (value === zoneSuffix) {
      return '@';
    } else {
      var pattern = new RegExp('.' + zoneSuffix, 'i');
      var relativeName = value.replace(pattern, '');
      return relativeName;
    }
  },

  parseSOA: function (rr, $origin) {
    var self = this;
    var soa = {
      name: rr.name,
      type: rr.type,
      ttl: rr.ttl,
      records: [{
        host: rr.data[0],
        email: self.convertToFQDN(rr.data[1], $origin),
        serialNumber: self.parseTimestamp(rr.data[2]),
        refreshTime: self.parseTimestamp(rr.data[3]),
        retryTime: self.parseTimestamp(rr.data[4]),
        expireTime: self.parseTimestamp(rr.data[5]),
        minimumTtl: self.parseTimestamp(rr.data[6])
      }]
    };
    return soa;
  },

  parseNS: function (rr, $origin) {
    var self = this;
    var ns = {
      name: rr.name,
      type: rr.type,
      ttl: rr.ttl,
      records: [{
        nsdname: self.convertToFQDN(rr.data[0], $origin)
      }]
    };
    return ns;
  },

  parseA: function (rr) {
    var a = {
      name: rr.name,
      type: rr.type,
      ttl: rr.ttl,
      records: [{
        ipv4Address: rr.data[0]
      }]
    };
    return a;
  },

  parseAAAA: function (rr) {
    var aaaa = {
      name: rr.name,
      type: rr.type,
      ttl: rr.ttl,
      records: [{
        ipv6Address: rr.data[0]
      }]
    };
    return aaaa;
  },

  parseCNAME: function (rr, $origin) {
    var self = this;
    var cname = {
      name: rr.name,
      type: rr.type,
      ttl: rr.ttl,
      records: [{
        cname: self.convertToFQDN(rr.data[0], $origin)
      }]
    };
    return cname;
  },

  parseMX: function (rr, $origin) {
    var self = this;
    var mx = {
      name: rr.name,
      type: rr.type,
      ttl: rr.ttl,
      records: [{
        preference: parseInt(rr.data[0]),
        exchange: self.convertToFQDN(rr.data[1], $origin)
      }]
    };
    return mx;
  },

  /**
   * The DNS RFCs support multi-string TXT records (clients are expected to concatenate the strings).
   * However, today, Azure DNS only supports single-string TXT records.
   * Until Azure DNS supports multiple-string TXT records, zone import shall behave as follows:
   */
  parseTXT: function (rr) {

    // Where multiple strings are given, they should be concatenated into a single string (without adding any whitespace).
    var value = rr.data.join(' ');
    var textArray = recordSetUtils.splitTxtRecord(value);
    var txt = {
      name: rr.name,
      type: rr.type,
      ttl: rr.ttl,
      records: [{
        value: textArray
      }]
    };
    if(textArray === '') {
      return value;
    }
    return txt;
  },

  parsePTR: function (rr, $origin) {
    var self = this;
    var ptr = {
      name: rr.name,
      type: rr.type,
      ttl: rr.ttl,
      records: [{
        ptrdname: self.convertToFQDN(rr.data[0], $origin)
      }]
    };
    return ptr;
  },

  parseSRV: function (rr, $origin) {
    var self = this;
    var srv = {
      name: rr.name,
      type: rr.type,
      ttl: rr.ttl,
      records: [{
        priority: parseInt(rr.data[0]),
        weight: parseInt(rr.data[1]),
        port: parseInt(rr.data[2]),
        target: self.convertToFQDN(rr.data[3], $origin)
      }]
    };
    return srv;
  },

  parseCAA: function (rr) {
    var self = this;

    var warning = util.format('Record would be ignored. Record set: %s', rr.name);

    if (rr.data.length < 3) {
      self.output.warn(util.format('Failed to parse CAA record, it should contain all of the following: flags, tag, value. %s', warning));
      return;
    }

    var value = rr.data.slice(2).join(' ');

    if (value.indexOf(' ') !== -1 && !(value.startsWith('"') && value.endsWith('"'))) {
      self.output.warn(util.format('Failed to parse CAA value, values with spaces should be put in double-quotes. %s', warning));
      return;
    }

    // Strip double-quotes
    if (value.startsWith('"')) { value = value.substring(1); }
    if (value.endsWith('"')) { value = value.substring(0, value.length - 1); }

    // Unescape double-quotes
    value = value.replace(/\\"/g, '"');

    var caa = {
      name: rr.name,
      type: rr.type,
      ttl: rr.ttl,
      records: [{
        flags: parseInt(rr.data[0]),
        tag: rr.data[1],
        value: value
      }]
    };

    return caa;
  },

  /**
   * Generate methods
   */
  generateHeader: function (fileData, resourceGroupName, zoneName, ttl) {
    fileData += '; Exported zone file from Azure DNS\r\n';
    fileData += util.format('; Resource Group Name: %s\r\n', resourceGroupName);
    fileData += util.format('; Zone name: %s\n', zoneName);
    fileData += util.format('; Date and time (UTC): %s\r\n\r\n', moment.utc());
    fileData += util.format('$TTL %s\r\n', ttl);
    fileData += util.format('$ORIGIN %s.\r\n\r\n', zoneName);
    return fileData;
  },

  generateRRs: function (fileData, sets) {
    var self = this;

    var index;
    var soaSet = __.find(sets, function (rset, rindex) {
      if (rset.soaRecord) {
        index = rindex;
        return true;
      }
    });

    if (typeof index !== 'undefined') {
      fileData += self.generateFromSet(soaSet, 'soaRecord', constants.dnsZone.SOA, soaSet.tTL);
      sets.splice(index, 1);
    }

    sets.forEach(function (rset) {
      var ttl = rset.tTL;

      fileData += self.generateFromSet(rset, 'aRecords', constants.dnsZone.A, ttl);
      fileData += self.generateFromSet(rset, 'aaaaRecords', constants.dnsZone.AAAA, ttl);
      fileData += self.generateFromSet(rset, 'txtRecords', constants.dnsZone.TXT, ttl);
      fileData += self.generateFromSet(rset, 'ptrRecords', constants.dnsZone.PTR, ttl);
      fileData += self.generateFromSet(rset, 'mxRecords', constants.dnsZone.MX, ttl);
      fileData += self.generateFromSet(rset, 'nsRecords', constants.dnsZone.NS, ttl);
      fileData += self.generateFromSet(rset, 'srvRecords', constants.dnsZone.SRV, ttl);
      fileData += self.generateFromSet(rset, 'caaRecords', constants.dnsZone.CAA, ttl);
      fileData += self.generateFromSet(rset, 'cnameRecord', constants.dnsZone.CNAME, ttl);
    });
    return fileData;
  },

  generateFromSet: function (recordSet, propertyName, type, ttl) {
    var self = this;
    var fileData = '';

    var obj = recordSet[propertyName];
    if (!__.isEmpty(obj)) {
      if (Array.isArray(obj)) {
        for (var i = 0; i < obj.length; i++) {
          var record = obj[i];
          var recordName;
          if (i === 0) {
            recordName = recordSet.name;
          } else {
            recordName = utils.setIndent(recordSet.name.length);
          }
          fileData += self.generateRR(recordName, type, ttl, record);
        }
        fileData += '\r\n';
      } else {
        fileData += self.generateRR(recordSet.name, type, ttl, obj);
        fileData += '\r\n';
      }
    }
    return fileData;
  },

  generateRR: function (name, type, ttl, record) {
    var self = this;
    var defClass = constants.dnsZone.recordClasses[0];

    var rr = util.format('%s %s %s %s ', name, ttl, defClass, type);
    switch (type) {
      case constants.dnsZone.SOA:
        var serialNumber = record.serialNumber || moment().format('YYYYMMDDss');
        if (!utils.stringEndsWith(record.host, '.', true)) record.host += '.';
        if (!utils.stringEndsWith(record.email, '.', true)) record.email += '.';
        rr += util.format('%s %s (\r\n\t\t\t\t%s\r\n\t\t\t\t%s\r\n\t\t\t\t%s\r\n\t\t\t\t%s\r\n\t\t\t\t%s\r\n\t\t\t\t)', record.host, record.email,
          serialNumber, record.refreshTime, record.retryTime, record.expireTime, record.minimumTtl);
        break;
      case constants.dnsZone.A:
        rr += record.ipv4Address;
        break;
      case constants.dnsZone.AAAA:
        rr += record.ipv6Address;
        break;
      case constants.dnsZone.CNAME:
        rr += record.cname;
        if (!utils.stringEndsWith(record.cname, '.', true)) rr += '.';
        break;
      case constants.dnsZone.MX:
        rr += util.format('%s %s', record.preference, record.exchange);
        if (!utils.stringEndsWith(record.exchange, '.', true)) rr += '.';
        break;
      case constants.dnsZone.NS:
        rr += record.nsdname;
        if (!utils.stringEndsWith(record.nsdname, '.', true)) rr += '.';
        break;
      case constants.dnsZone.SRV:
        rr += util.format('%s %s %s %s', record.priority, record.weight, record.port, record.target);
        if (!utils.stringEndsWith(record.target, '.', true)) rr += '.';
        break;
      case constants.dnsZone.CAA:
        var caaValue = record.value;
        // Escape double-quotes
        caaValue = caaValue.replace(/([\\]*)(")/g, function (match) {
          var count = (match.match(/\\/g) || []).length;
          if (count % 2 === 0) { match = match.replace('"', '\\"'); }
          return match;
        });
        // Enclose value in double-quotes if it contains spaces or escaped characters
        if (caaValue.indexOf(' ') !== -1 || caaValue.indexOf('\\') !== -1) {
          if (!caaValue.startsWith('"')) { caaValue = '"' + caaValue; }
          if (!caaValue.endsWith('"')) { caaValue = caaValue + '"'; }
        }
        rr += util.format('%s %s %s', record.flags, record.tag, caaValue);
        break;
      case constants.dnsZone.TXT:
        record.value = record.value.join('');

        // Added slash to store quotes in JSON format.
        record.value = recordSetUtils.displaySpecialCharacters(record.value);
        rr += util.format('\"%s\"', record.value);
        break;
      case constants.dnsZone.PTR:
        rr += record.ptrdname;
        break;
      default:
        self.output.warn(util.format('Records of type "%s" are not supported, record with name "%s" not exported', type, name));
        return '';
    }

    rr += '\r\n';
    return rr;
  }

});

module.exports = ZoneFile;