passforios/passKit/Models/Password.swift

//
//  Password.swift
//  pass
//
//  Created by Mingshen Sun on 2/2/2017.
//  Copyright © 2017 Bob Sun. All rights reserved.
//

import Foundation
import SwiftyUserDefaults
import OneTimePassword
import Base32
import Yams

struct AdditionField {
    var title: String
    var content: String
}

enum PasswordChange: Int {
    case path = 0x01
    case content = 0x02
    case none = 0x00
}

public class Password {
    public static let otpKeywords = ["otp_secret", "otp_type", "otp_algorithm", "otp_period", "otp_digits", "otp_counter", "otpauth"]
    private static let OTPAUTH = "otpauth"
    private static let OTPAUTH_URL_START = "\(OTPAUTH)://"

    public var name = ""
    public var url: URL?
    public var namePath: String {
        get {
            if url == nil {
                return ""
            }
            return url!.deletingPathExtension().path
        }
    }
    public var password = ""
    public var changed: Int = 0
    public var plainText = ""
    
    private var additions = [(String, String)]()
    private var firstLineIsOTPField = false
    private var otpToken: Token?
    
    public enum OtpType {
        case totp, hotp, none
    }
    
    public var otpType: OtpType {
        get {
            guard let token = self.otpToken else {
                return OtpType.none
            }
            switch token.generator.factor {
            case .counter:
                return OtpType.hotp
            case .timer:
                return OtpType.totp
            }
        }
    }
    
    public init(name: String, url: URL?, plainText: String) {
        self.initEverything(name: name, url: url, plainText: plainText)
    }
    
    public func updatePassword(name: String, url: URL?, plainText: String) {
        if self.plainText != plainText || self.url != url {
            if self.plainText != plainText {
                changed = changed|PasswordChange.content.rawValue
            }
            if self.url != url {
                changed = changed|PasswordChange.path.rawValue
            }
            self.initEverything(name: name, url: url, plainText: plainText)
        }
    }
    
    private func initEverything(name: String, url: URL?, plainText: String) {
        self.name = name
        self.url = url
        self.plainText = plainText
        additions.removeAll()
        
        // split the plain text
        let plainTextSplit = self.plainText.split(omittingEmptySubsequences: true) {
            $0 == "\n" || $0 == "\r\n"
            }.map(String.init)
    
        // get password
        password  = plainTextSplit.first ?? ""
        
        // get remaining lines
        let additionalLines = plainTextSplit[1...]
        
        // separate normal lines (no otp tokens)
        let normalAdditionalLines = additionalLines.filter {
            !$0.hasPrefix(Password.OTPAUTH_URL_START)
            }.joined(separator: "\n")
        
        // try to interpret the text format as YAML first
        do {
            try getAdditionalFields(fromYaml: normalAdditionalLines)
        }
        catch {
            getAdditionalFields(fromPlainText: normalAdditionalLines)
        }

        // get and append otp tokens
        let otpAdditionalLines = additionalLines.filter { $0.hasPrefix(Password.OTPAUTH_URL_START) }
        otpAdditionalLines.forEach { self.additions.append((Password.OTPAUTH, $0)) }
        
        // check whether the first line looks like an otp entry
        let (key, value) = Password.getKeyValuePair(from: self.password)
        if Password.otpKeywords.contains(key ?? "") {
            firstLineIsOTPField = true
            self.additions.append((key!, value))
        } else {
            firstLineIsOTPField = false
        }
        
        // construct the otp token
        self.updateOtpToken()
    }
    
    // check whether the file has lines with duplicated field names
    private func checkDuplicatedFields(lines: String) -> Bool {
        var keys = Set<String>()
        var hasDuplicatedFields = false
        lines.enumerateLines { (line, stop) -> () in
            let (key, _) = Password.getKeyValuePair(from: line)
            if let key = key {
                if keys.contains(key) {
                    hasDuplicatedFields = true
                    stop = true
                }
                keys.insert(key)
            }
        }
        return hasDuplicatedFields
    }

    private func getAdditionalFields(fromYaml: String) throws {
        guard !fromYaml.isEmpty else { return }
        if checkDuplicatedFields(lines: fromYaml) {
            throw AppError.YamlLoadError
        }
        let yamlFile = try Yams.load(yaml: fromYaml) as! [String: Any]
        additions.append(contentsOf: yamlFile.map { ($0, String(describing: $1)) })
    }

    private func getAdditionalFields(fromPlainText: String) {
        var unknownIndex = 0
        fromPlainText.enumerateLines() { line, _ in
            if !line.isEmpty {
                var (key, value) = Password.getKeyValuePair(from: line)
                if key == nil {
                    unknownIndex += 1
                    key = "unknown \(unknownIndex)"
                }
                self.additions.append((key!, value))
            }
        }
    }
    
    public func getFilteredAdditions() -> [(String, String)] {
        var filteredAdditions = [(String, String)]()
        additions.forEach { (key: String, value: String) in
            if key.lowercased() != "username" && key.lowercased() != "login" && key.lowercased() != "password" &&
                (!key.hasPrefix("unknown") || !SharedDefaults[.isHideUnknownOn]) &&
                (!Password.otpKeywords.contains(key) || !SharedDefaults[.isHideOTPOn]) {
                filteredAdditions.append((key, value))
            }
        }
        return filteredAdditions
    }
    
    public func getUsername() -> String? {
        return getAdditionValue(withKey: "username", caseSensitive: false)
    }
    
    public func getLogin() -> String? {
        return getAdditionValue(withKey: "login", caseSensitive: false)
    }
    
    public func getURLString() -> String? {
        return getAdditionValue(withKey: "url", caseSensitive: false)
    }
    
    // return a key-value pair from the line
    // key might be nil, if there is no ":" in the line
    private static func getKeyValuePair(from line: String) -> (key: String?, value: String) {
        let items = line.components(separatedBy: ": ").map{String($0).trimmingCharacters(in: .whitespaces)}
        var key : String? = nil
        var value = ""
        if items.count == 1 || (items[0].isEmpty && items[1].isEmpty) {
            // no ": " found, or empty on both sides of ": "
            value = line
            // otpauth special case
            if value.hasPrefix(Password.OTPAUTH_URL_START) {
                key = Password.OTPAUTH
            }
        } else {
            if !items[0].isEmpty {
                key = items[0]
            }
            value = items[1]
        }
        return (key, value)
    }
    
    public func getAdditionsPlainText() -> String {
        // lines starting from the second
        let plainTextSplit = plainText.split(maxSplits: 1, omittingEmptySubsequences: false) {
            $0 == "\n" || $0 == "\r\n"
            }.map(String.init)
        if plainTextSplit.count == 1 {
            return ""
        } else {
            return plainTextSplit[1]
        }
    }
    
    private func getPlainText() -> String {
        return self.plainText
    }
    
    public func getPlainData() -> Data {
        return getPlainText().data(using: .utf8)!
    }
    
    private func getAdditionValue(withKey key: String, caseSensitive: Bool = true) -> String? {
        let searchKey = caseSensitive ? key : key.lowercased()
        for (currentKey, value) in additions {
            let currentKeyTrans = caseSensitive ? currentKey : currentKey.lowercased()
            if searchKey == currentKeyTrans {
                return value
            }
        }
        return nil
    }
    
    /*
     Set otpType and otpToken, if we are able to construct a valid token.
     
     Example of TOTP otpauth
     (Key Uri Format: https://github.com/google/google-authenticator/wiki/Key-Uri-Format)
     otpauth://totp/totp-secret?secret=AAAAAAAAAAAAAAAA&issuer=totp-secret
     
     Example of TOTP fields [Legacy, lower priority]
     otp_secret: secretsecretsecretsecretsecretsecret
     otp_type: totp
     otp_algorithm: sha1 (default: sha1, optional)
     otp_period: 30 (default: 30, optional)
     otp_digits: 6 (default: 6, optional)
     
     Example of HOTP fields [Legacy, lower priority]
     otp_secret: secretsecretsecretsecretsecretsecret
     otp_type: hotp
     otp_counter: 1
     otp_digits: 6 (default: 6, optional)
     
     */
    private func updateOtpToken() {
        self.otpToken = nil
        
        // get otpauth, if we are able to generate a token, return
        if var otpauthString = getAdditionValue(withKey: Password.OTPAUTH) {
            if !otpauthString.hasPrefix("\(Password.OTPAUTH):") {
                otpauthString = "\(Password.OTPAUTH):\(otpauthString)"
            }
            if let otpauthUrl = URL(string: otpauthString),
                let token = Token(url: otpauthUrl) {
                self.otpToken = token
                return
            }
        }
        
        // get secret data
        guard let secretString = getAdditionValue(withKey: "otp_secret"),
            let secretData = MF_Base32Codec.data(fromBase32String: secretString),
            !secretData.isEmpty else {
                // print("Missing / Invalid otp secret")
                return
        }
        
        // get type
        guard let type = getAdditionValue(withKey: "otp_type")?.lowercased(),
            (type == "totp" || type == "hotp") else {
                // print("Missing  / Invalid otp type")
                return
        }
        
        // get algorithm (optional)
        var algorithm = Generator.Algorithm.sha1
        if let algoString = getAdditionValue(withKey: "otp_algorithm") {
            switch algoString.lowercased() {
                case "sha256":
                    algorithm = .sha256
                case "sha512":
                    algorithm = .sha512
                default:
                    algorithm = .sha1
            }
        }
    
        // construct the token
        if type == "totp" {
            // HOTP
            // default: 6 digits, 30 seconds
            guard let digits = Int(getAdditionValue(withKey: "otp_digits") ?? "6"),
                let period = Double(getAdditionValue(withKey: "otp_period") ?? "30.0") else {
                    let alertMessage = "Invalid otp_digits or otp_period."
                    print(alertMessage)
                    return
            }
            guard let generator = Generator(
                factor: .timer(period: period),
                secret: secretData,
                algorithm: algorithm,
                digits: digits) else {
                    let alertMessage = "Invalid OTP generator parameters."
                    print(alertMessage)
                    return
            }
            self.otpToken = Token(name: self.name, issuer: "", generator: generator)
        } else {
            // HOTP
            // default: 6 digits
            guard let digits = Int(getAdditionValue(withKey: "otp_digits") ?? "6"),
                let counter = UInt64(getAdditionValue(withKey: "otp_counter") ?? "") else {
                    let alertMessage = "Invalid otp_digits or otp_counter."
                    print(alertMessage)
                    return
            }
            guard let generator = Generator(
                factor: .counter(counter),
                secret: secretData,
                algorithm: algorithm,
                digits: digits) else {
                    let alertMessage = "Invalid OTP generator parameters."
                    print(alertMessage)
                    return
            }
            self.otpToken = Token(name: self.name, issuer: "", generator: generator)
        }
    }
    
    // return the description and the password strings
    public func getOtpStrings() -> (description: String, otp: String)? {
        guard let token = self.otpToken else {
            return nil
        }
        var description : String
        switch token.generator.factor {
        case .counter:
            // htop
            description = "HMAC-based"
        case .timer(let period):
            // totp
            let timeSinceEpoch = Date().timeIntervalSince1970
            let validTime = Int(period - timeSinceEpoch.truncatingRemainder(dividingBy: period))
            description = "time-based (expiring in \(validTime)s)"
        }
        let otp = self.otpToken?.currentPassword ?? "error"
        return (description, otp)
    }
    
    // return the password strings
    public func getOtp() -> String? {
        if let otp = self.otpToken?.currentPassword {
            return otp
        } else {
            return nil
        }
    }
    
    // return the password strings
    // it is guaranteed that it is a HOTP password when we call this
    public func getNextHotp() -> String? {
        // increase the counter
        otpToken = otpToken?.updatedToken()
        
        // replace old HOTP settings with the new otpauth
        var newOtpauth = try! otpToken?.toURL().absoluteString
        newOtpauth?.append("&secret=")
        newOtpauth?.append(MF_Base32Codec.base32String(from: otpToken?.generator.secret))
        
        var lines : [String] = []
        self.plainText.enumerateLines() { line, _ in
            let (key, _) = Password.getKeyValuePair(from: line)
            if !Password.otpKeywords.contains(key ?? "") {
                lines.append(line)
            } else if key == Password.OTPAUTH && newOtpauth != nil {
                lines.append(newOtpauth!)
                // set to nil to prevent duplication
                newOtpauth = nil
            }
        }
        if newOtpauth != nil {
            lines.append(newOtpauth!)
        }
        self.updatePassword(name: self.name, url: self.url, plainText: lines.joined(separator: "\n"))
        
        // get and return the password
        return self.otpToken?.currentPassword
    }
    
    public static func LooksLikeOTP(line: String) -> Bool {
        let (key, _) = getKeyValuePair(from: line)
        return Password.otpKeywords.contains(key ?? "")
    }
}