API Reference
SecurityTXTAnalysis
Downloads and validates security.txt files according to the specification.
Inheritance
- Object
- SecurityTXTAnalysis
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Property DomainHealthCheck.SecurityTXTAnalysis
- Property SecurityTxtInfo.Raw
Accepted by parameters
- Method SecurityTxtNarrative.Build
- Method Converters.Convert
Constructors
public SecurityTXTAnalysis() #Methods
public async Task AnalyzeSecurityTxtRecord(String domainName, InternalLogger logger, String pgpPublicKey = null) #TaskRetrieves and parses the security.txt file for the given domain.
Parameters
- domainName System.String
- logger DomainDetective.InternalLogger
- pgpPublicKey System.String = null
public static Void ClearCache() #VoidClears cached security.txt content used across instances.
ExtractClearText(System.String arg1) #Extracts clear text from a PGP signed message.
Parameters
- arg1 System.String
ParseSecurityTxt(System.String arg1, System.String arg2, System.String arg3) #Parses the contents of a security.txt file.
Parameters
- arg1 System.String
- arg2 System.String
- arg3 System.String
Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
Properties
public String Domain { get; set; } #Domain that was analyzed.
public Boolean RecordPresent { get; set; } #True when a security.txt record was found.
public Boolean RecordValid { get; set; } #True when the record passed validation.
public Boolean PGPSigned { get; set; } #Indicates the record is signed with PGP.
public Boolean FallbackUsed { get; set; } #Set when fallback retrieval method was used.
public String Url { get; set; } #URL from which the record was downloaded.
public HashSet<String> DuplicateTags { get; } #Gets the duplicate tags value.
public List<String> ContactEmail { get; set; } #Gets or sets the contact email value.
public List<String> ContactWebsite { get; set; } #Gets or sets the contact website value.
public List<String> Acknowledgments { get; set; } #Gets or sets the acknowledgments value.
public List<String> PreferredLanguages { get; set; } #Gets or sets the preferred languages value.
public List<String> Encryption { get; set; } #Gets or sets the encryption value.
public List<String> Policy { get; set; } #Gets or sets the policy value.
public List<String> Hiring { get; set; } #Gets or sets the hiring value.
public List<String> Canonical { get; set; } #Gets or sets the canonical value.
public String Expires { get; set; } #Gets or sets the expires value.
public String SignatureEncryption { get; set; } #Gets or sets the signature encryption value.
public virtual List<Assessment> Assessments { get; } #Gets the assessments value.
public IReadOnlyList<RecommendationAdvice> Recommendations { get; } #Represents the recommendations value.
Fields
_client #Downloads the security.txt file from the specified URL.