18197892088

Committed 02 Oct 2025 03:33PM UTC coverage: 57.31% (-0.2%) from 57.474%

Build # 18197892088

Build Type

push

github

Committed by

web-flow

Commit Message

Merge pull request #2237 from HicServices/task/RDMP-334-extractability

Task/rdmp 334 extractability

Run Details

11401 of 21427 branches covered (53.21%)

Branch coverage included in aggregate %.

11 of 102 new or added lines in 11 files covered. (10.78%)

64 existing lines in 8 files now uncovered.

32365 of 54940 relevant lines covered (58.91%)

17596.01 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

63.89

/Rdmp.Core/Curation/Data/EncryptedString.cs

// Copyright (c) The University of Dundee 2018-2019
// This file is part of the Research Data Management Platform (RDMP).
// RDMP is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
// RDMP is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
// You should have received a copy of the GNU General Public License along with RDMP. If not, see <https://www.gnu.org/licenses/>.

using System;
using System.Security.Cryptography;
using Rdmp.Core.Repositories;

namespace Rdmp.Core.Curation.Data;

/// <summary>
/// Encrypts a string, providing access to both the encrypted and decrypted values.
/// </summary>
/// <exception cref="InvalidOperationException">Value is too long to be encrypted</exception>
/// <exception cref="CryptographicException" />
public class EncryptedString : IEncryptedString
{
    private readonly IEncryptStrings _encrypter;
    private string _value;

    /// <inheritdoc/>
    public override string ToString() => Value;

    /// <inheritdoc/>
    public string Value
    {
        get =>
            //if there is a password in memory it will be encrypted (probably) so return that, to decrypt call DecryptPassword
            _value;
        set
        {
            if (string.IsNullOrWhiteSpace(value)) //if it is null
                _value = null;
            else if (!_encrypter.IsStringEncrypted(value)) //it is not null, is it already encrypted?
                try
                {
                    _value = _encrypter.Encrypt(value); //not yet encrypted so encrypt it
                }
                catch (Exception e)
                {
                   if (e.Message.Contains("Bad Length") || e.Message.Contains("data too large for key size"))
                        throw new InvalidOperationException(
                            $"The free text Value supplied to this class was too long to be encrypted (Length of string was {value.Length})",
                            e);

                    //it's some other exception
                    throw;
                }
            else
                _value = value; //it is encrypted already so just store in normally
        }
    }

    /// <summary>
    /// Creates a new encrypted string using <see cref="SimpleStringValueEncryption"/>
    /// </summary>
    /// <param name="repository"></param>
    public EncryptedString(ICatalogueRepository repository)
    {
        _encrypter = repository.EncryptionManager.GetEncrypter();
    }

    /// <inheritdoc/>
    public string GetDecryptedValue()
    {
        if (string.IsNullOrWhiteSpace(Value))
            return null;

        if (_encrypter.IsStringEncrypted(Value))
            return _encrypter.Decrypt(Value);

        //it's not decrypted... how did that happen
        throw new Exception("Found Value in memory that was not encrypted");
    }

    /// <inheritdoc/>
    public bool IsStringEncrypted(string value) => _encrypter.IsStringEncrypted(value);
}

1	// Copyright (c) The University of Dundee 2018-2019
2	// This file is part of the Research Data Management Platform (RDMP).
3	// RDMP is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
4	// RDMP is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
5	// You should have received a copy of the GNU General Public License along with RDMP. If not, see <https://www.gnu.org/licenses/>.
6
7	using System;
8	using System.Security.Cryptography;
9	using Rdmp.Core.Repositories;
10
11	namespace Rdmp.Core.Curation.Data;
12
13	/// <summary>
14	/// Encrypts a string, providing access to both the encrypted and decrypted values.
15	/// </summary>
16	/// <exception cref="InvalidOperationException">Value is too long to be encrypted</exception>
17	/// <exception cref="CryptographicException" />
18	public class EncryptedString : IEncryptedString
19	{
20	private readonly IEncryptStrings _encrypter;
21	private string _value;
22
23	/// <inheritdoc/>
24	public override string ToString() => Value;	2✔
25
26	/// <inheritdoc/>
27	public string Value
28	{
29	get =>
30	//if there is a password in memory it will be encrypted (probably) so return that, to decrypt call DecryptPassword
31	_value;	10,482✔
32	set
33	{
34	if (string.IsNullOrWhiteSpace(value)) //if it is null	11,533✔
35	_value = null;	10,913✔
36	else if (!_encrypter.IsStringEncrypted(value)) //it is not null, is it already encrypted?	620✔
37	try
38	{
39	_value = _encrypter.Encrypt(value); //not yet encrypted so encrypt it	162✔
40	}	162✔
UNCOV 41	catch (Exception e)	×
42	{
UNCOV 43	if (e.Message.Contains("Bad Length") \|\| e.Message.Contains("data too large for key size"))	×
UNCOV 44	throw new InvalidOperationException(	×
UNCOV 45	$"The free text Value supplied to this class was too long to be encrypted (Length of string was {value.Length})",	×
UNCOV 46	e);	×
47
48	//it's some other exception
49	throw;	×
50	}
51	else
52	_value = value; //it is encrypted already so just store in normally	458✔
53	}	620✔
54	}
55
56	/// <summary>
57	/// Creates a new encrypted string using <see cref="SimpleStringValueEncryption"/>
58	/// </summary>
59	/// <param name="repository"></param>
60	public EncryptedString(ICatalogueRepository repository)	10,073✔
61	{
62	_encrypter = repository.EncryptionManager.GetEncrypter();	10,073✔
63	}	10,073✔
64
65	/// <inheritdoc/>
66	public string GetDecryptedValue()
67	{
68	if (string.IsNullOrWhiteSpace(Value))	1,400✔
69	return null;	16✔
70
71	if (_encrypter.IsStringEncrypted(Value))	1,384!
72	return _encrypter.Decrypt(Value);	1,384✔
73
74	//it's not decrypted... how did that happen
75	throw new Exception("Found Value in memory that was not encrypted");	×
76	}
77
78	/// <inheritdoc/>
UNCOV 79	public bool IsStringEncrypted(string value) => _encrypter.IsStringEncrypted(value);	×
80	}

HicServices / RDMP / 18197892088

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous