1. GroupDocs Documentation
    2. /
    3. GroupDocs.Signature Product Family
    4. /
    5. GroupDocs.Signature for .NET
    6. /
    7. Developer Guide
    8. /
    9. Advanced usage
    10. /
    11. Searching for electronic signatures
    12. /
    13. Search for embedded and encrypted objects in Metadata signatures
    14. /
    15. Search for embedded object with custom serialization of Metadata signatures

    Search for embedded object with custom serialization of Metadata signatures

    On this page

    GroupDocs.Signature provides additional features when searching for Metadata Signatures that were previously encrypted and have embedded data objects.

    • ability to search for embedded custom objects into metadata and decrypt them to original source values
    • ability to search for encrypted text of metadata signature and decrypt it

    Here are the steps to search and decrypt previously encrypted text of metadata and decrypt custom object from metadata signature (MetadataSignature) with GroupDocs.Signature API:

    • Implement custom data serialization class that implement IDataEncryption interface. By default Signature uses embedded json format serialization but allows user to customize it. if object of class was serialized by custom serialization when searching for it, this class should also has same serialization attribute.
    • Implement custom data encryption class that implements IDataEncryption interface. By default Signature has several encryption implementation you can use but allows user to customize it. There’s ability to specify inline encryption to use
    • Define class with proper DataSerialization attribute
    • Instantiate the MetadataSearchOptions object value
    • Call Search method of Signature class instance and pass MetadataSearchOptions to it.
    • Process each Metadata signature and set property DataEncryption to specify data encryption and call GetData method to retrieve object

    Implementation of custom data serialization

    This example shows how to specify custom serialization class. This class should be implemented as Attribute and IDataSerializer interface.

    public class CustomSerializationAttribute : Attribute, IDataSerializer
{
    public T Deserialize<T>(string source) where T : class
    {
        return JsonConvert.DeserializeObject<T>(source);
    }
    public string Serialize(object data)
    {
        var serializerSettings = new JsonSerializerSettings { NullValueHandling = NullValueHandling.Ignore };
        return JsonConvert.SerializeObject(data, serializerSettings);
    }
}

    Implementation of custom data encryption

    This example shows how to specify custom serialization class. This class could be implemented also as Attribute (optional) to specify as class attribute.

    // Define class that implements IDataEncryption interface
private class CustomXOREncryption : IDataEncryption
{
    /// <summary>
    /// Gets or sets non empty key for encryption (at least one character)
    /// </summary>
    public int Key { get; set; }
    /// <summary>
    /// Encode method to encrypt string.
    /// </summary>
    /// <param name="source">Source string to encode.</param>
    /// <returns>Returns enccrypted string</returns>
    public string Encode(string source)
    {
        return Process(source);
    }
    /// <summary>
    /// Decode method to obtain decrypted string.
    /// </summary>
    /// <param name="source">Source string to decode.</param>
    /// <returns>Returns decrypted string</returns>
    public string Decode(string source)
    {
        return Process(source);
    }
    /// <summary>
    /// Using XOR operation get encoded / decoded string
    /// </summary>
    /// <param name="source"></param>
    /// <returns></returns>
    private string Process(string source)
    {
        StringBuilder src = new StringBuilder(source);
        StringBuilder dst = new StringBuilder(src.Length);
        char chTmp;
        for (int index = 0; index < src.Length; ++index)
        {
            chTmp = src[index];
            chTmp = (char)(chTmp ^ this.Key);
            dst.Append(chTmp);
        }
        return dst.ToString();
    }
}

    Definition of class

    This example shows how to define custom class with serialization and encryption properties and setup Format attributes for properties.

    // setup CustomSerialization Attribute to setup customer serialization(see example above)
[CustomSerialization]
private class DocumentSignatureData
{
    [Format("SignID")]
    public string ID { get; set; }
    [Format("SAuth")]
    public string Author { get; set; }
    [Format("SDate", "yyyy-MM-dd")]
    public DateTime Signed { get; set; }
    [Format("SDFact", "N2")]
    public decimal DataFactor { get; set; }
    [SkipSerialization]
    public string Comments { get; set; }
}

    Search for embedded custom objects in metadata signatures

     This example shows how to decrypt previously embedded encrypted custom objects into metadata signature. MetadataSignature contains method GetData to retrieve object

    using (Signature signature = new Signature("MetadataCustomSerializationObject.docx"))
{
    // create data encryption
    IDataEncryption encryption = new CustomXOREncryption();
    MetadataSearchOptions options = new MetadataSearchOptions()
    {
        DataEncryption = encryption
    };
    // search for signatures in document
    List<WordProcessingMetadataSignature> signatures = signature.Search<WordProcessingMetadataSignature>(options);
    Console.WriteLine("\nSource document contains following signatures.");
    // get required metadata signatures
    WordProcessingMetadataSignature mdSignature = signatures.FirstOrDefault(p => p.Name == "Signature");
    if (mdSignature != null)
    {
        DocumentSignatureData documentSignatureData = mdSignature.GetData<DocumentSignatureData>();
        if (documentSignatureData != null)
        {
            Console.WriteLine("Signature has DocumentSignatureData object:\n ID = {0}, Author = {1}, Signed = {2}, DataFactor {3}",
                documentSignatureData.ID, documentSignatureData.Author, documentSignatureData.Signed.ToShortDateString(), documentSignatureData.DataFactor);
        }
    }
    // get required metadata signatures
    WordProcessingMetadataSignature mdAuthor = signatures.FirstOrDefault(p => p.Name == "Author");
    if (mdAuthor != null)
    {
        Console.WriteLine("Metadata signature found. Name : {0}. Value: {1}", mdAuthor.Name, mdAuthor.GetData<string>());
    }
    // get required metadata signatures
    WordProcessingMetadataSignature mdDocId = signatures.FirstOrDefault(p => p.Name == "DocumentId");
    if (mdDocId != null)
    {
        Console.WriteLine("Metadata signature found. Name : {0}. Value: {1}", mdDocId.Name, mdDocId.GetData<string>());
    }
}

    More resources

    GitHub Examples

    You may easily run the code above and see the feature in action in our GitHub examples:

    Free Online Apps

    Along with the full-featured .NET library, we provide simple but powerful free online apps.

    To sign PDF, Word, Excel, PowerPoint, and other documents you can use the online apps from the GroupDocs.Signature App Product Family.

    On this page

    © Groupdocs 2001-2024. All Rights Reserved.